📝 update document

Signed-off-by: vankichi <[email protected]>
vdaas · Mar 2, 2021 · 1a89537 · 1a89537
1 parent db5f328
commit 1a89537
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 9 deletions.
diff --git a/docs/tutorial/get-started.md b/docs/tutorial/get-started.md
@@ -298,9 +298,6 @@ This chapter shows how to perform a search action in Vald with fashion-mnist dat
 
         ```go
         for i := range ids [:insertCount] {
-            if i%10 == 0 {
-                glg.Infof("Inserted %d", i)
-            }
             _, err := client.Insert(ctx, &payload.Insert_Request{
                 Vector: &payload.Object_Vector{
                     Id: ids[i],
@@ -313,6 +310,9 @@ This chapter shows how to perform a search action in Vald with fashion-mnist dat
             if err != nil {
                 glg.Fatal(err)
             }
+            if i%10 == 0 {
+                glg.Infof("Inserted %d", i)
+            }
         }
         ```
 
@@ -359,6 +359,29 @@ This chapter shows how to perform a search action in Vald with fashion-mnist dat
 
           </details>
 
+   1. Remove
+
+      - Remove indexed 400 training datasets from the Vald agent.
+          <details><summary>example code</summary><br>
+
+        ```go
+        for i := range ids [:insertCount] {
+            _, err := client.Remove(ctx, &payload.Remove_Request{
+                Id: &payload.Object_ID{
+                    Id: ids[i],
+                },
+            })
+            if err != nil {
+                glg.Fatal(err)
+            }
+            if i%10 == 0 {
+                glg.Infof("Removed %d", i)
+            }
+        }
+        ```
+
+          </details>
+
    ```bash
    # run example
    go run main.go
@@ -634,6 +657,43 @@ This chapter uses [NGT](https://github.com/yahoojapan/ngt) as Vald Agent to perf
 
           </details>
 
+   1. Remove
+
+      - Remove indexed 400 training datasets from the Vald agent.
+          <details><summary>example code</summary><br>
+
+        ```go
+        for i := range ids [:insertCount] {
+            _, err := client.Remove(ctx, &payload.Remove_Request{
+                Id: &payload.Object_ID{
+                    Id: ids[i],
+                },
+            })
+            if err != nil {
+                glg.Fatal(err)
+            }
+            if i%10 == 0 {
+                glg.Infof("Removed %d", i)
+            }
+        }
+        ```
+
+          </details>
+
+
+      - Remove manually instead of waiting for auto indexing.
+        If you run below code, the indexes will be removed from the Vald Agent and the Backup file.
+        <detail><summary>example code</summary><br>
+
+        ```go
+        _, err = client.SaveIndex(ctx, &payload.Empty{})
+        if err != nil {
+            glg.Fatal(err)
+        }
+        ```
+
+          </detail>
+
    ```bash
    # run example
    go run main.go

diff --git a/example/client/main.go b/example/client/main.go
@@ -77,9 +77,6 @@ func main() {
 	glg.Infof("Start Inserting %d training vector to Vald", insertCount)
 	// Insert 400 example vectors into Vald cluster
 	for i := range ids[:insertCount] {
-		if i%10 == 0 {
-			glg.Infof("Inserted: %d", i+10)
-		}
 		// Calls `Insert` function of Vald client.
 		// Sends set of vector and id to server via gRPC.
 		_, err := client.Insert(ctx, &payload.Insert_Request{
@@ -94,6 +91,9 @@ func main() {
 		if err != nil {
 			glg.Fatal(err)
 		}
+		if i%10 == 0 {
+			glg.Infof("Inserted: %d", i+10)
+		}
 	}
 	glg.Info("Finish Inserting dataset. \n\n")
 
@@ -132,9 +132,6 @@ func main() {
 	glg.Info("Start removing vector")
 	// Remove indexed 400 vectors from vald cluster.
 	for i := range ids[:insertCount] {
-		if i%10 == 0 {
-			glg.Infof("Removed: %d", i+10)
-		}
 		// Call `Remove` function of Vald client.
 		// Sends id to server via gRPC.
 		_, err := client.Remove(ctx, &payload.Remove_Request{
@@ -145,6 +142,9 @@ func main() {
 		if err != nil {
 			glg.Fatal(err)
 		}
+		if i%10 == 0 {
+			glg.Infof("Removed: %d", i+10)
+		}
 	}
 	glg.Info("Finish removing vector")
 }