fix typos

kaito-project · Sep 19, 2024 · 721ff78 · 721ff78
1 parent ad8b31c
commit 721ff78
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/Makefile b/Makefile
@@ -325,8 +325,8 @@ $(LOCALBIN):
 build-ragengine: manifests generate fmt vet
 	go build -o bin/rag-engine-manager cmd/ragengine/*.go
 
-.PHONY: run
-run-regengine: manifests generate fmt vet
+.PHONY: run-ragengine
+run-ragengine: manifests generate fmt vet
 	go run ./cmd/ragengine/main.go
 
 ##@ Deployment

diff --git a/charts/kaito/ragengine/README.md b/charts/kaito/ragengine/README.md
@@ -1,4 +1,4 @@
-# KAITO Workspace Helm Chart
+# KAITO RAGEngine Helm Chart
 
 ## Install
 
@@ -8,7 +8,7 @@ export IMG_NAME=ragengine
 export IMG_TAG=0.0.1
 helm install ragengine ./charts/kaito/ragengine  \
 --set image.repository=${REGISTRY}/$(IMG_NAME) --set image.tag=$(IMG_TAG) \
---namespace kaito-ragengine --create-namespace
+--namespace ragengine --create-namespace
 ```
 
 ## Values
@@ -17,7 +17,7 @@ helm install ragengine ./charts/kaito/ragengine  \
 |------------------------------------------|--------|-----------------------------------------|---------------------------------------------------------------|
 | affinity                                 | object | `{}`                                    |                                                               |
 | image.pullPolicy                         | string | `"IfNotPresent"`                        |                                                               |
-| image.repository                         | string | `mcr.microsoft.com/aks/kaito/workspace` |                                                               |
+| image.repository                         | string | `mcr.microsoft.com/aks/kaito/ragengine` |                                                               |
 | image.tag                                | string | `"0.3.0"`                               |                                                               |
 | imagePullSecrets                         | list   | `[]`                                    |                                                               |
 | nodeSelector                             | object | `{}`                                    |                                                               |

diff --git a/charts/kaito/ragengine/crds/kaito.sh_ragengines.yaml b/charts/kaito/ragengine/crds/kaito.sh_ragengines.yaml
@@ -133,7 +133,7 @@ spec:
                         type: string
                       modelID:
                         description: |-
-                          ModelID is the ID of the embedding model hosted by huggingface.
+                          ModelID is the ID of the embedding model hosted by huggingface, e.g., BAAI/bge-small-en-v1.5.
                           When this field is specified, the RAG engine will download the embedding model
                           from huggingface repository during startup. The embedding model will not persist in local storage.
                           Note that if Image is specified, ModelID should not be specified and vice versa.
@@ -161,7 +161,7 @@ spec:
                   IndexServiceName is the name of the service which exposes the endpoint for user to input the index data
                   to generate embeddings. If not specified, a default service name will be created by the RAG engine.
                 type: string
-              inferencService:
+              inferenceService:
                 properties:
                   accessSecret:
                     description: AccessSecret is the name of the secret that contains
@@ -182,12 +182,12 @@ spec:
               storage:
                 description: |-
                   Storage specifies how to access the vector database used to save the embedding vectors.
-                  If this field is not specified, by default, an in-memoty vector DB will be used.
+                  If this field is not specified, by default, an in-memory vector DB will be used.
                   The data will not be persisted.
                 type: object
             required:
             - embedding
-            - inferencService
+            - inferenceService
             type: object
           status:
             description: RAGEngineStatus defines the observed state of RAGEngine