add faiss in valdrelease.yaml

vdaas · Jun 20, 2024 · 8701d96 · 8701d96
1 parent 3edc428
commit 8701d96
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 2 deletions.
diff --git a/charts/vald-helm-operator/crds/valdrelease.yaml b/charts/vald-helm-operator/crds/valdrelease.yaml
@@ -314,6 +314,59 @@ spec:
                               type: integer
                             insert_buffer_pool_size:
                               type: integer
+                    faiss:
+                      type: object
+                      properties:
+                        auto_index_check_duration:
+                          type: string
+                        auto_index_duration_limit:
+                          type: string
+                        auto_index_length:
+                          type: integer
+                        auto_save_index_duration:
+                          type: string
+                        dimension:
+                          type: integer
+                          minimum: 1
+                        enable_copy_on_write:
+                          type: boolean
+                        enable_in_memory_mode:
+                          type: boolean
+                        enable_proactive_gc:
+                          type: boolean
+                        index_path:
+                          type: string
+                        initial_delay_max_duration:
+                          type: string
+                        kvsdb:
+                          type: object
+                          properties:
+                            concurrency:
+                              type: integer
+                        load_index_timeout_factor:
+                          type: string
+                        m:
+                          type: integer
+                        max_load_index_timeout:
+                          type: string
+                        metric_type:
+                          type: string
+                          enum:
+                            - innerproduct
+                            - l2
+                        min_load_index_timeout:
+                          type: string
+                        nbits_per_idx:
+                          type: integer
+                        nlist:
+                          type: integer
+                        vqueue:
+                          type: object
+                          properties:
+                            delete_buffer_pool_size:
+                              type: integer
+                            insert_buffer_pool_size:
+                              type: integer
                     nodeName:
                       type: string
                     nodeSelector:

diff --git a/cmd/agent/core/faiss/sample.yaml b/cmd/agent/core/faiss/sample.yaml
@@ -115,7 +115,7 @@ faiss:
   load_index_timeout_factor: 1ms
   m: 8 # dimension % m == 0, train size >= 2^m(or nlist) * minPointsPerCentroid
   max_load_index_timeout: 10m
-  metric_type: "inner_product"
+  metric_type: "innerproduct"
   min_load_index_timeout: 3m
   nbits_per_idx: 8
   nlist: 100
diff --git a/docs/tutorial/get-started-with-faiss-agent.md b/docs/tutorial/get-started-with-faiss-agent.md
@@ -60,7 +60,7 @@ In this tutorial, you will deploy the basic configuration of Vald that is consis
        load_index_timeout_factor: 1ms
        m: 8  # dimension % m == 0, train size >= 2^m(or nlist) * minPointsPerCentroid
        max_load_index_timeout: 10m
-       metric_type: "inner_product"
+       metric_type: "innerproduct"
        min_load_index_timeout: 3m
        nbits_per_idx: 8
        nlist: 100

diff --git a/k8s/operator/helm/crds/valdrelease.yaml b/k8s/operator/helm/crds/valdrelease.yaml
@@ -314,6 +314,59 @@ spec:
                               type: integer
                             insert_buffer_pool_size:
                               type: integer
+                    faiss:
+                      type: object
+                      properties:
+                        auto_index_check_duration:
+                          type: string
+                        auto_index_duration_limit:
+                          type: string
+                        auto_index_length:
+                          type: integer
+                        auto_save_index_duration:
+                          type: string
+                        dimension:
+                          type: integer
+                          minimum: 1
+                        enable_copy_on_write:
+                          type: boolean
+                        enable_in_memory_mode:
+                          type: boolean
+                        enable_proactive_gc:
+                          type: boolean
+                        index_path:
+                          type: string
+                        initial_delay_max_duration:
+                          type: string
+                        kvsdb:
+                          type: object
+                          properties:
+                            concurrency:
+                              type: integer
+                        load_index_timeout_factor:
+                          type: string
+                        m:
+                          type: integer
+                        max_load_index_timeout:
+                          type: string
+                        metric_type:
+                          type: string
+                          enum:
+                            - innerproduct
+                            - l2
+                        min_load_index_timeout:
+                          type: string
+                        nbits_per_idx:
+                          type: integer
+                        nlist:
+                          type: integer
+                        vqueue:
+                          type: object
+                          properties:
+                            delete_buffer_pool_size:
+                              type: integer
+                            insert_buffer_pool_size:
+                              type: integer
                     nodeName:
                       type: string
                     nodeSelector: