Rename HnswIvf to Spann (#177)

hicder · Dec 4, 2024 · 34bbb5d · 34bbb5d
1 parent f9db81d
commit 34bbb5d
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 17 deletions.
diff --git a/rs/index_server/src/index_provider.rs b/rs/index_server/src/index_provider.rs
@@ -33,7 +33,7 @@ impl IndexProvider {
                 }
             }
             index_writer::config::IndexType::Ivf => todo!(),
-            index_writer::config::IndexType::HnswIvf => {
+            index_writer::config::IndexType::Spann => {
                 let reader = SpannReader::new(index_path);
                 match reader.read() {
                     Ok(index) => Some(Box::new(index)),

diff --git a/rs/index_writer/src/config.rs b/rs/index_writer/src/config.rs
@@ -14,7 +14,7 @@ pub enum IndexType {
     Ivf,
 
     #[default]
-    HnswIvf,
+    Spann,
 }
 
 #[derive(Debug, Clone, Default, Serialize, Deserialize)]
@@ -75,7 +75,7 @@ pub struct HnswConfigWithBase {
 }
 
 #[derive(Debug, Clone, Default, Serialize, Deserialize)]
-pub struct HnswIvfConfig {
+pub struct SpannConfigWithBase {
     pub base_config: BaseConfig,
     pub hnsw_config: HnswConfig,
     pub ivf_config: IvfConfig,
@@ -85,7 +85,7 @@ pub struct HnswIvfConfig {
 pub enum IndexWriterConfig {
     Hnsw(HnswConfigWithBase),
     Ivf(IvfConfigWithBase),
-    HnswIvf(HnswIvfConfig),
+    Spann(SpannConfigWithBase),
 }
 
 impl Default for IndexWriterConfig {

diff --git a/rs/index_writer/src/index_writer.rs b/rs/index_writer/src/index_writer.rs
@@ -10,7 +10,7 @@ use quantization::pq_builder::{ProductQuantizerBuilder, ProductQuantizerBuilderC
 use rand::seq::SliceRandom;
 
 use crate::config::{
-    HnswConfigWithBase, HnswIvfConfig, IndexWriterConfig, IvfConfigWithBase, QuantizerType,
+    HnswConfigWithBase, SpannConfigWithBase, IndexWriterConfig, IvfConfigWithBase, QuantizerType,
 };
 use crate::input::Input;
 
@@ -167,7 +167,7 @@ impl IndexWriter {
     fn do_build_ivf_hnsw_index(
         &mut self,
         input: &mut impl Input,
-        index_writer_config: &HnswIvfConfig,
+        index_writer_config: &SpannConfigWithBase,
     ) -> Result<()> {
         // Directory structure:
         // hnsw_ivf_config.base_config.output_path
@@ -281,7 +281,7 @@ impl IndexWriter {
                 Ok(self.do_build_hnsw_index(input, &hnsw_config)?)
             }
             IndexWriterConfig::Ivf(ivf_config) => Ok(self.do_build_ivf_index(input, &ivf_config)?),
-            IndexWriterConfig::HnswIvf(hnsw_ivf_config) => {
+            IndexWriterConfig::Spann(hnsw_ivf_config) => {
                 Ok(self.do_build_ivf_hnsw_index(input, &hnsw_ivf_config)?)
             }
         }
@@ -508,7 +508,7 @@ mod tests {
             dimension,
             max_memory_size: 1024 * 1024 * 1024, // 1 GB
             file_size: 1024 * 1024 * 1024,       // 1 GB
-            index_type: IndexType::HnswIvf,
+            index_type: IndexType::Spann,
         };
         let hnsw_config = HnswConfig {
             num_layers: 2,
@@ -533,7 +533,7 @@ mod tests {
             tolerance: 0.0,
             max_posting_list_size: usize::MAX,
         };
-        let config = IndexWriterConfig::HnswIvf(HnswIvfConfig {
+        let config = IndexWriterConfig::Spann(SpannConfigWithBase {
             base_config,
             hnsw_config,
             ivf_config,

diff --git a/rs/index_writer/src/main.rs b/rs/index_writer/src/main.rs
@@ -3,7 +3,7 @@ use std::path::Path;
 
 use clap::Parser;
 use index_writer::config::{
-    HnswConfigWithBase, HnswIvfConfig, IndexWriterConfig, IvfConfigWithBase,
+    HnswConfigWithBase, IndexWriterConfig, IvfConfigWithBase, SpannConfigWithBase,
 };
 use index_writer::index_writer::IndexWriter;
 use index_writer::input::hdf5::Hdf5Reader;
@@ -12,7 +12,7 @@ use index_writer::input::hdf5::Hdf5Reader;
 enum IndexTypeArgs {
     Hnsw,
     Ivf,
-    HnswIvf,
+    Spann,
 }
 
 #[derive(Parser, Debug)]
@@ -59,11 +59,11 @@ fn main() {
             config.base_config.output_path = arg.output_path;
             IndexWriterConfig::Ivf(config)
         }
-        IndexTypeArgs::HnswIvf => {
-            let mut config: HnswIvfConfig =
+        IndexTypeArgs::Spann => {
+            let mut config: SpannConfigWithBase =
                 serde_yaml::from_str(&buf).expect("Failed to parse config");
             config.base_config.output_path = arg.output_path;
-            IndexWriterConfig::HnswIvf(config)
+            IndexWriterConfig::Spann(config)
         }
     };
 

diff --git a/rs/index_writer/src/scripts/write_index_writer_config.rs b/rs/index_writer/src/scripts/write_index_writer_config.rs
@@ -3,15 +3,15 @@
 use std::fs::File;
 use std::io::Write;
 
-use index_writer::config::{BaseConfig, HnswConfig, HnswIvfConfig, IvfConfig, QuantizerType};
+use index_writer::config::{BaseConfig, HnswConfig, SpannConfigWithBase, IvfConfig, QuantizerType};
 
 fn main() -> std::io::Result<()> {
     let mut base_config = BaseConfig::default();
     base_config.dimension = 128;
     base_config.output_path = "NONE".to_string();
     base_config.max_memory_size = 1024 * 1024 * 1024; // 1 GB
     base_config.file_size = 1024 * 1024 * 1024; // 1 GB
-    base_config.index_type = index_writer::config::IndexType::HnswIvf;
+    base_config.index_type = index_writer::config::IndexType::Spann;
 
     let mut ivf_config = IvfConfig::default();
     ivf_config.num_clusters = 5;
@@ -28,7 +28,7 @@ fn main() -> std::io::Result<()> {
     hnsw_config.ef_construction = 200;
     hnsw_config.reindex = false;
 
-    let mut config = HnswIvfConfig::default();
+    let mut config = SpannConfigWithBase::default();
     config.base_config = base_config;
     config.ivf_config = ivf_config;
     config.hnsw_config = hnsw_config;