update READMEs

yahoojapan · Apr 16, 2024 · a672f2d · a672f2d
1 parent 74fed61
commit a672f2d
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 1 deletion.
diff --git a/README-jp.md b/README-jp.md
@@ -10,6 +10,7 @@ Neighborhood Graph and Tree for Indexing High-dimensional Data
 
 ニュース
 -------
+- 2024/04/10 内積が利用可能になりました。(v2.1.0)
 - 2022/08/10 QBG(Quantized Blob Graph)およびQG(NGTQGの改良版)が利用可能となりました。ngtqおよびngtqgは[qbg](https://github.com/yahoojapan/NGT/blob/main/bin/qbg/README.md)で置き換えられました。
 - 2022/02/04 FP16(半精度浮動小数点)が利用可能になりました。(v1.14.0)
 - 2021/03/12 READMEに量子化グラフの結果を追加しました。

diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ Neighborhood Graph and Tree for Indexing High-dimensional Data
 
 News
 ----
+- 04/10/2024 Inner product (or dot product) is now available. (v2.1.0)
 - 08/10/2022 [QBG](https://github.com/yahoojapan/NGT#qbg-quantized-blob-graph-based-method) (Quantized Blob Graph) and [QG](https://github.com/yahoojapan/NGT#qg-quantized-graph-based-method) (renewed NGTQG) are now available. The command-line interface ngtq and ngtqg are now obsolete by replacing [qbg](bin/qbg/README.md). (v2.0.0)
 - 02/04/2022 FP16 (half-precision floating point) is now available. (v1.14.0)
 - 03/12/2021 The results for the quantized graph are added to this README.

diff --git a/bin/ngt/README-jp.md b/bin/ngt/README-jp.md
@@ -104,6 +104,7 @@ ANNGやBKNNGを指定した場合には登録データ（ノード）からエ
 - __j__: ジャッカード距離。データオブジェクトの型は1バイト整数を指定してください。
 - __p__: ポアンカレ距離
 - __l__: ローレンツ距離
+- __i__: 内積。最大内積検索です。検索時に得られる距離は内積の値ではないのでご注意ください。
 
 **-n** *no\_of\_registration\_data*  
 登録するデータ数を指定します。指定しない場合には指定されたファイル中のすべてのデータを登録します。

diff --git a/bin/ngt/README.md b/bin/ngt/README.md
@@ -107,7 +107,7 @@ Specify the distance function as follows.
 - __j__: Jaccard distance. 1 byte unsigned integer should be specified for the data object type.
 - __p__: Poincare distance
 - __l__: Lorentz distance
-- __i__: Inner product (Dot product)
+- __i__: Inner product (or dot product). Maximum inner-product search. Note that the distance obtained during search is not inner product values.
 
 **-n** *no\_of\_registration\_data*  
 Specify the number of data items to be registered. If not specified, all data in the specified file will be registered.

diff --git a/python/README-ngtpy-jp.md b/python/README-ngtpy-jp.md
@@ -203,6 +203,7 @@ FUNCTIONS
 - __Normalized Cosine__: 正規化コサイン類似度。指定されたデータは自動的に正規化された上でインデックスに登録されます。
 - __Hamming__: ハミング距離
 - __Jaccard__: ジャッカード距離
+- __Inner Product__: 内積
 
 **object_type**  
 オブジェクトのデータタイプを指定します。

diff --git a/python/README-ngtpy.md b/python/README-ngtpy.md
@@ -209,6 +209,7 @@ Specify the distance function for the objects.
 - __Normalized Cosine__: Normalized cosine similarity. The specified data are automatically normalized to be appended to the index.
 - __Hamming__: Hamming distance
 - __Jaccard__: Jaccard distance
+- __Inner Product__: Inner product (or dot product)
 
 **object_type**  
 Specify the data type of the objects.