コマンドクイックスタート

インストール

最新版のSource codeをダウンロードした後、以下の手順でインストールしてください。これはzipファイルをダウンロードした場合の例です。

unzip NGT-x.x.x.zip
cd NGT-x.x.x
mkdir build
cd build 
cmake ..
make 
make install

デフォルトでは/usr/local/にインストールされるので、以下のようにパスを通してください。

export PATH="$PATH:/opt/local/bin"
export LD_LIBRARY_PATH=/usr/local/lib:/usr/lib 

NGT コマンドの使い方

ngt コマンドのフォーマットです。

ngt コマンド オプション 引数

ただし、macなどの場合には、以下の順序になります。

ngt オプション コマンド 引数

インデックスの初期化と登録

インデックスの初期化と登録を同時に行う例です。

cd (NGT_TOP_DIR)
ngt create -d 128 anng ./data/sift-dataset-5k.tsv

create はNGTのコマンドです。anng はインデックスの名前であり、指定した名前のディレクトリが生成されて、インデックスとして初期化されます。sift-dataset-5k.tsvは登録するデータです。1行1データになっています。このデータは128次元なので、1行は128のカラムで構成されています。-dで登録するデータの次元数を指定します。appendコマンドを使えば次のようにインデックスの初期化と登録を個別に行うこともできます。

ngt create -d 128 anng
ngt append ./data/sift-dataset-5k.tsv

検索

次は検索の例です。

ngt search -n 5 index ./data/sift-query-3.tsv

sift-query-3.tsvは登録ファイルと同様に1行1データのクエリデータのファイルです。このファイルには3つのクエリが書かれているので、それぞれのクエリで検索して結果が出力されます。-nで検索数を指定します。

Query No.1
Rank	ID	Distance
1	3031	239.332
2	4079	240.002
3	3164	244.504
4	3718	246.763
5	157	  251.094
Query Time= 0.000472 (sec), 0.472 (msec)
    ...