Spaces:
Build error
Build error
File size: 10,671 Bytes
84d2a97 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
#![allow(deprecated)]
use std::collections::HashMap;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use crate::types::{
Distance, HnswConfig, Indexes, PayloadStorageType, QuantizationConfig, SegmentConfig,
SegmentState, SeqNumberType, VectorDataConfig, VectorStorageType,
};
#[derive(Default, Debug, Deserialize, Serialize, JsonSchema, Clone)]
#[serde(rename_all = "snake_case")]
#[deprecated = "use SegmentConfig instead"]
pub struct SegmentConfigV5 {
pub vector_data: HashMap<String, VectorDataConfigV5>,
/// Type of index used for search
pub index: Indexes,
/// Type of vector storage
pub storage_type: StorageTypeV5,
/// Defines payload storage type
#[serde(default)]
pub payload_storage_type: PayloadStorageType,
/// Quantization parameters. If none - quantization is disabled.
#[serde(default)]
pub quantization_config: Option<QuantizationConfig>,
}
impl From<SegmentConfigV5> for SegmentConfig {
fn from(old_segment: SegmentConfigV5) -> Self {
let vector_data = old_segment
.vector_data
.into_iter()
.map(|(vector_name, old_data)| {
let new_data = VectorDataConfig {
size: old_data.size,
distance: old_data.distance,
// Use HNSW index if vector specific one is set, or fall back to segment index
index: match old_data.hnsw_config {
Some(hnsw_config) => Indexes::Hnsw(hnsw_config),
None => old_segment.index.clone(),
},
// Remove vector specific quantization config if no segment one is set
// This is required because in some cases this was incorrectly set on the vector
// level
quantization_config: old_segment
.quantization_config
.as_ref()
.and(old_data.quantization_config),
// Mmap if explicitly on disk, otherwise convert old storage type
storage_type: (old_data.on_disk == Some(true))
.then_some(VectorStorageType::Mmap)
.unwrap_or_else(|| old_segment.storage_type.into()),
multivector_config: None,
datatype: None,
};
(vector_name, new_data)
})
.collect();
SegmentConfig {
vector_data,
sparse_vector_data: Default::default(),
payload_storage_type: old_segment.payload_storage_type,
}
}
}
/// Type of vector storage
#[derive(Default, Debug, Deserialize, Serialize, JsonSchema, Copy, Clone, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "type", content = "options")]
#[deprecated]
pub enum StorageTypeV5 {
// Store vectors in memory and use persistence storage only if vectors are changed
#[default]
InMemory,
// Use memmap to store vectors, a little slower than `InMemory`, but requires little RAM
Mmap,
}
impl From<StorageTypeV5> for VectorStorageType {
fn from(old: StorageTypeV5) -> Self {
match old {
StorageTypeV5::InMemory => Self::Memory,
StorageTypeV5::Mmap => Self::Mmap,
}
}
}
/// Config of single vector data storage
#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone)]
#[serde(rename_all = "snake_case")]
#[deprecated = "use VectorDataConfig instead"]
pub struct VectorDataConfigV5 {
/// Size of a vectors used
pub size: usize,
/// Type of distance function used for measuring distance between vectors
pub distance: Distance,
/// Vector specific HNSW config that overrides collection config
#[serde(default)]
pub hnsw_config: Option<HnswConfig>,
/// Vector specific quantization config that overrides collection config
#[serde(default)]
pub quantization_config: Option<QuantizationConfig>,
/// If true - vectors will not be stored in memory.
/// Instead, it will store vectors on mmap-files.
/// If enabled, search performance will defined by disk speed
/// and fraction of vectors that fit in RAM.
#[serde(default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub on_disk: Option<bool>,
}
#[derive(Debug, Deserialize, Clone)]
#[serde(rename_all = "snake_case")]
#[deprecated = "use SegmentState instead"]
pub struct SegmentStateV5 {
pub version: Option<SeqNumberType>,
pub config: SegmentConfigV5,
}
impl From<SegmentStateV5> for SegmentState {
fn from(old: SegmentStateV5) -> Self {
Self {
version: old.version,
config: old.config.into(),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::types::{ScalarQuantization, ScalarQuantizationConfig};
#[test]
fn convert_from_v5_to_newest() {
let old_segment = SegmentConfigV5 {
vector_data: vec![
(
"vec1".to_string(),
VectorDataConfigV5 {
size: 10,
distance: Distance::Dot,
hnsw_config: Some(HnswConfig {
m: 20,
ef_construct: 100,
full_scan_threshold: 10000,
max_indexing_threads: 0,
on_disk: None,
payload_m: Some(10),
}),
quantization_config: None,
on_disk: None,
},
),
(
"vec2".to_string(),
VectorDataConfigV5 {
size: 10,
distance: Distance::Dot,
hnsw_config: None,
quantization_config: Some(QuantizationConfig::Scalar(ScalarQuantization {
scalar: ScalarQuantizationConfig {
r#type: Default::default(),
quantile: Some(0.99),
always_ram: Some(true),
},
})),
on_disk: None,
},
),
]
.into_iter()
.collect(),
index: Indexes::Hnsw(HnswConfig {
m: 25,
ef_construct: 120,
full_scan_threshold: 10000,
max_indexing_threads: 0,
on_disk: None,
payload_m: None,
}),
storage_type: StorageTypeV5::InMemory,
payload_storage_type: PayloadStorageType::default(),
quantization_config: None,
};
let new_segment: SegmentConfig = old_segment.into();
eprintln!("new = {new_segment:#?}");
match &new_segment.vector_data.get("vec1").unwrap().index {
Indexes::Plain { .. } => panic!("expected HNSW index"),
Indexes::Hnsw(hnsw) => {
assert_eq!(hnsw.m, 20);
}
}
match &new_segment.vector_data.get("vec2").unwrap().index {
Indexes::Plain { .. } => panic!("expected HNSW index"),
Indexes::Hnsw(hnsw) => {
assert_eq!(hnsw.m, 25);
}
}
if new_segment
.vector_data
.get("vec1")
.unwrap()
.quantization_config
.is_some()
{
panic!("expected no quantization");
}
}
#[test]
fn convert_from_v5_to_newest_2() {
let old_segment = SegmentConfigV5 {
vector_data: vec![
(
"vec1".to_string(),
VectorDataConfigV5 {
size: 10,
distance: Distance::Dot,
hnsw_config: None,
quantization_config: None,
on_disk: None,
},
),
(
"vec2".to_string(),
VectorDataConfigV5 {
size: 10,
distance: Distance::Dot,
hnsw_config: None,
quantization_config: Some(QuantizationConfig::Scalar(ScalarQuantization {
scalar: ScalarQuantizationConfig {
r#type: Default::default(),
quantile: Some(0.99),
always_ram: Some(true),
},
})),
on_disk: None,
},
),
]
.into_iter()
.collect(),
index: Indexes::Hnsw(HnswConfig {
m: 25,
ef_construct: 120,
full_scan_threshold: 10000,
max_indexing_threads: 0,
on_disk: None,
payload_m: None,
}),
storage_type: StorageTypeV5::InMemory,
payload_storage_type: PayloadStorageType::default(),
quantization_config: Some(QuantizationConfig::Scalar(ScalarQuantization {
scalar: ScalarQuantizationConfig {
r#type: Default::default(),
quantile: Some(0.95),
always_ram: Some(true),
},
})),
};
let new_segment: SegmentConfig = old_segment.into();
eprintln!("new = {new_segment:#?}");
if new_segment
.vector_data
.get("vec1")
.unwrap()
.quantization_config
.is_some()
{
panic!("expected no quantization");
}
match &new_segment
.vector_data
.get("vec2")
.unwrap()
.quantization_config
{
Some(q) => match q {
QuantizationConfig::Scalar(scalar) => {
assert_eq!(scalar.scalar.quantile, Some(0.99));
}
QuantizationConfig::Product(_) => {
panic!("expected scalar quantization")
}
QuantizationConfig::Binary(_) => {
panic!("expected scalar quantization")
}
},
_ => {
panic!("expected quantization")
}
}
}
}
|