Release 2.3.0 (#36)

criteo · Dec 7, 2021 · 0b54b6a · 0b54b6a
1 parent f8597ee
commit 0b54b6a
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [2.3.0] - 2021-12-07
+
+### Added
+Add make_direct_map option in build index
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
 
 ## [2.2.1] - 2021-11-30
 

diff --git a/README.md b/README.md
@@ -138,7 +138,7 @@ The `autofaiss build_index` command takes the following parameters:
 | --index_param              |   None       | (Optional) If present, the Faiss index will be set using this description string of hyperparameters, more detail in the [Faiss documentation](https://github.com/facebookresearch/faiss/wiki/Index-IO,-cloning-and-hyper-parameter-tuning) |
 | --use_gpu                  |   False      | (Optional) Experimental, gpu training can be faster, but this feature is not tested so far.                                                                                                                                         |
 | --nb_cores                 |   None       | (Optional) The number of cores to use, by default will use all cores                                                                                                                                         |
-| --make_direct_map          |   False      | (Optional) Create a direct map allowing reconstruction of embeddings. This is only needed for IVF indices.
+| --make_direct_map          |   False      | (Optional) Create a direct map allowing reconstruction of embeddings. This is only needed for IVF indices. Note that might increase the RAM usage (approximately 8GB for 1 billion embeddings).
 
 ## Install from source
 

diff --git a/autofaiss/external/quantize.py b/autofaiss/external/quantize.py
@@ -102,6 +102,7 @@ def build_index(
         Number of cores to use. Will try to guess the right number if not provided
     make_direct_map: bool
         Create a direct map allowing reconstruction of embeddings. This is only needed for IVF indices.
+        Note that might increase the RAM usage (approximately 8GB for 1 billion embeddings)
     """
 
     current_bytes = cast_memory_to_bytes(current_memory_available)

diff --git a/autofaiss/version.py b/autofaiss/version.py
@@ -1,6 +1,6 @@
 # pylint: disable=all
 
-__version__ = "2.2.1"
+__version__ = "2.3.0"
 __author__ = "Criteo"