admin/milvus
1
0
Fork 0
mirror of https://gitee.com/milvus-io/milvus.git synced 2026-01-07 19:31:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] Add note for design doc (#12937)

Browse Source 
Signed-off-by: yhmo <yihua.mo@zilliz.com>
This commit is contained in:
groot 2021-12-08 10:41:14 +08:00 committed by GitHub
parent cafa184ea5
commit 090c0f2cfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/design_docs/knowhere_design.md
View File

@ -27,24 +27,24 @@ Serialize();
/*
* Load from serialization data
* @param dataset_ptr: serialization data
* @param [in] dataset_ptr: serialization data
*/
void
Load(const BinarySet&);
/*
* Create index
* @param dataset_ptr: index data (key of the Dataset is "tensor", "rows" and "dim")
* @parma config: index param
* @param [in] dataset_ptr: index data (key of the Dataset is "tensor", "rows" and "dim")
* @parma [in] config: index param
*/
void
BuildAll(const DatasetPtr& dataset_ptr, const Config& config);
/*
* KNN (K-Nearest Neighbors) Query
* @param dataset_ptr: query data (key of the Dataset is "tensor" and "rows")
* @parma config: query param
* @parma blacklist: mark for deletion
* @param [in] dataset_ptr: query data (key of the Dataset is "tensor" and "rows")
* @parma [in] config: query param
* @parma [out] blacklist: mark for deletion
* @return: query result (key of the Dataset is "ids" and "distance")
*/
DatasetPtr
@ -61,7 +61,7 @@ CopyGpuToCpu();
/*
* If the user IDs has been set, they will be returned in the Query interface;
* else the range of the returned IDs is [0, row_num-1].
* @parma uids: user ids
* @parma [in] uids: user ids
*/
void
SetUids(std::shared_ptr<std::vector<IDType>> uids);