milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[skip ci]Format markdown doc for segcore/basic_types.md (#10002) 

Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com>
pull/10042/head
ryjiang 2021-10-16 22:28:46 +08:00 committed by GitHub
parent 91b3b2667e
commit 7dfd46cc02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/design_docs/segcore/basic_types.md
View File

@ -3,14 +3,14 @@
- `Collection`: Data table containing multiple Segments
- `Segment`: The memory structure of storing a piece of data which supports concurrent insertion, deletion, query, index loading, monitoring and statistics
- `Schema`: Definition of collection data format, including
- `vector<FieldMeta>`: Order list of FieldMeta
- `isAutoId`: if set to True , default primary field is `RowId` and it is auto generated
- `primaryKey`: (when `isAutoId = False`) specify primary key field
- `vector<FieldMeta>`: Order list of FieldMeta
- `isAutoId`: if set to True , default primary field is `RowId` and it is auto generated
- `primaryKey`: (when `isAutoId = False`) specify primary key field
- `FieldMeta`: field properties, including
- `DataType`: data type, including Int8...Int64, Float, Double, FloatVector, BinaryVector and String later
- `Dim`: (when dataType is vector) type vector dimension
- `metric_type`: (when dataType is vector type, optional) the metric type corresponding to this vector is related to the small batch index and can be empty
- `FieldName`: column name
- `FieldId`: unique number of the column
- (hidden) `FieldOffset`: which is the subscript of `vector<Field>` in the schema. The internal calculation of segcore is basically based on fieldoffset
- `DataType`: data type, including Int8...Int64, Float, Double, FloatVector, BinaryVector and String later
- `Dim`: (when dataType is vector) type vector dimension
- `metric_type`: (when dataType is vector type, optional) the metric type corresponding to this vector is related to the small batch index and can be empty
- `FieldName`: column name
- `FieldId`: unique number of the column
- (hidden) `FieldOffset`: which is the subscript of `vector<Field>` in the schema. The internal calculation of segcore is basically based on fieldoffset
- `Span`: similar to STD::span. It supports vector type of data and can be implicitly converted to `SpanBase` for interface overwrite