Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correct some relative path error in docs #31

Merged
merged 1 commit into from
May 26, 2024
+2 −2
Merged

correct some relative path error in docs #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ sh script/puck_train_control.sh -t
sh script/puck_train_control.sh -b
````
## 检索 ##
    创建索引的实例后，通过init()方法加载索引，search检索最近的topk个样本，获得相似度（distance）和样本的local idx（建库顺序）。response内的distance、local_idx生命周期自行维护。可参考[demo](./demo/search_client.cpp)文件。
    创建索引的实例后，通过init()方法加载索引，search检索最近的topk个样本，获得相似度（distance）和样本的local idx（建库顺序）。response内的distance、local_idx生命周期自行维护。可参考[demo](../demo/search_client.cpp)文件。

    检索API如下。

Expand All @@ -215,7 +215,7 @@ int search(const Request* request, Response* response);
## 实时入库 ##
    部分场景会需要实时插入数据功能，请创建RealtimeInsertPuckIndex，并调用insert方法。insert的数据先落盘再写入内存，当insert成功时保证数据磁盘和内存都写入成功。

    可参考[demo](./demo/insert_demo.cpp)文件。
    可参考[demo](../demo/insert_demo.cpp)文件。

核心api如下：
````c++
Expand Down