From 090c0f2cfb8b80fd08a012a79e3c6bf62a97c9cd Mon Sep 17 00:00:00 2001 From: groot Date: Wed, 8 Dec 2021 10:41:14 +0800 Subject: [PATCH] [skip ci] Add note for design doc (#12937) Signed-off-by: yhmo --- docs/design_docs/knowhere_design.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/design_docs/knowhere_design.md b/docs/design_docs/knowhere_design.md index aec4971392..a7546fa404 100644 --- a/docs/design_docs/knowhere_design.md +++ b/docs/design_docs/knowhere_design.md @@ -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> uids);