Skip to content

Commit

Permalink
chore: update docs and use standard as the default storageclass
Browse files Browse the repository at this point in the history
Signed-off-by: bjwswang <bjwswang@gmail.com>
  • Loading branch information
bjwswang committed Feb 21, 2024
1 parent 9d3ee31 commit fb4e00c
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 31 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
<a href="https://goreportcard.com/report/github.com/kubeagi/arcadia">
<img alt="Go Report Card" src="https://goreportcard.com/badge/kubeagi/arcadia?style=flat-square" />
</a>
<a href="https://github.com/pylint-dev/pylint">
<img alt="Pylint Card" src="https://github.com/kubeagi/arcadia/actions/workflows/pypi_lint/badge.svg" />
</a>
<a href="https://github.com/psf/black">
<img alt="CodeStyle" src="https://img.shields.io/badge/code%20style-black-000000.svg" />
</a>
Expand Down Expand Up @@ -78,22 +75,20 @@ List of supported(tested) LLMs

## Pure Go Toolchains

To enhance the AI capability in Golang, we developed some packages.Here are the examples of how to use them.
Thanks to [langchaingo](https://github.com/tmc/langchaingo),we can have comprehensive AI capability in Golang!But in order to meet our own unique needs, we have further developed a number of other toolchains:

- [Optimized DocumentLoaders](https://github.com/kubeagi/arcadia/tree/main/pkg/documentloaders): optimized csv,etc...
- [Extended LLMs](https://github.com/kubeagi/arcadia/tree/main/pkg/llms): zhipuai,dashscope,etc...
- [Tools](https://github.com/kubeagi/arcadia/tree/main/pkg/tools): bingsearch,weather,etc...
- [AppRuntime](https://github.com/kubeagi/arcadia/tree/main/pkg/appruntime): powerful node(LLM,Chain,KonwledgeBase,vectorstore,Agent,etc...) orchestration runtime for arcadia

- [chat_with_document](https://github.com/kubeagi/arcadia/tree/main/examples/chat_with_document): a chat server which allows you to chat with your document
- [embedding](https://github.com/kubeagi/arcadia/tree/main/examples/embedding) shows how to embedes your document to vector store with embedding service
- [rbac](https://github.com/kubeagi/arcadia/blob/main/examples/rbac/main.go) shows how to inquiry the security risks in your RBAC with AI.
- [zhipuai](https://github.com/kubeagi/arcadia/blob/main/examples/zhipuai/main.go) shows how to use this [zhipuai client](https://github.com/kubeagi/arcadia/tree/main/pkg/llms/zhipuai)
- [dashscope](https://github.com/kubeagi/arcadia/blob/main/examples/dashscope/main.go) shows how to use this [dashscope client](https://github.com/kubeagi/arcadia/tree/main/pkg/llms/dashscope) to chat with qwen-7b-chat / qwen-14b-chat / llama2-7b-chat-v2 / llama2-13b-chat-v2 and use embedding with dashscope text-embedding-v1 / text-embedding-async-v1
We have provided some examples on how to use them. See more details at [here](https://github.com/kubeagi/arcadia/tree/main/examples)

## CLI

We provide a Command Line Tool `arctl` to interact with `arcadia`. See [here](http://kubeagi.k8s.com.cn/docs/Tools/arctl-tool) for more details.

- ✅ datasource management
- ✅ local dataset management
- ✅ chat & completion
- ✅ download files from datasource
- ✅ RAG evaluation

## Contribute to Arcadia
Expand Down
4 changes: 2 additions & 2 deletions deploy/charts/arcadia/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apiVersion: v2
name: arcadia
description: A Helm chart(KubeBB Component) for KubeAGI Arcadia
description: A Helm chart(Also a KubeBB Component) for KubeAGI Arcadia
type: application
version: 0.2.33
version: 0.2.34
appVersion: "0.1.0"

keywords:
Expand Down
34 changes: 17 additions & 17 deletions deploy/charts/arcadia/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ fastchat:
enabled: true
host: fastchat-api.<replaced-ingress-nginx-ip>.nip.io

# @section oss is used as default Object-Storage-Service for arcadia
# @section minio is used as default Object-Storage-Service for arcadia
minio:
image:
repository: kubeagi/minio
Expand All @@ -71,7 +71,7 @@ minio:
rootPassword: "Passw0rd!"
persistence:
enabled: true
storageClass: "openebs-hostpath"
storageClass: "standard"
size: 30Gi
ingress:
enabled: true
Expand Down Expand Up @@ -104,19 +104,6 @@ minio:
# bucket [true|false] NOTE: versioning is enabled by default if you use locking
objectlocking: false

# @section chromadb is used to deploy a chromadb instance
chromadb:
enabled: false
image:
repository: kubeagi/chromadb
chromadb:
apiVersion: "0.4.18"
auth:
enabled: false
serverHttpPort: 8000
dataVolumeStorageClass: "openebs-hostpath"
dataVolumeSize: "1Gi"

# @section dataprocess is used to configure data processing service
# Related project: https://github.com/kubeagi/arcadia/tree/main/data-processing
dataprocess:
Expand All @@ -131,11 +118,11 @@ dataprocess:
# Posgresql service will be used in two parts:
# - dataprocessing
# - llm application
# - used as vector store with pgvector enabled
# - used as vector store with pgvector enabled(Recommended)
postgresql:
enabled: true
global:
storageClass: "openebs-hostpath"
storageClass: "standard"
postgresql:
auth:
# default username and password
Expand All @@ -153,6 +140,19 @@ postgresql:
initdb:
scriptsConfigMap: pg-init-data

# @section chromadb is used to deploy a chromadb instance
chromadb:
enabled: false
image:
repository: kubeagi/chromadb
chromadb:
apiVersion: "0.4.18"
auth:
enabled: false
serverHttpPort: 8000
dataVolumeStorageClass: "standard"
dataVolumeSize: "1Gi"

# @section ray is a unified framework for scaling AI and Python applications.In kubeagi,we use ray for distributed inference
ray:
# clusters provided by ray
Expand Down
9 changes: 9 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Examples in arcadia

- [chat_with_worker](https://github.com/kubeagi/arcadia/tree/main/examples/chat_with_document): a chat server which allows you to chat with the help of the model services deployed in kubeagi
- [chat_with_document](https://github.com/kubeagi/arcadia/tree/main/examples/chat_with_document): a chat server which allows you to chat with your document
- [zhipuai](https://github.com/kubeagi/arcadia/blob/main/examples/zhipuai/main.go) shows how to use this [zhipuai client](https://github.com/kubeagi/arcadia/tree/main/pkg/llms/zhipuai)
- [dashscope](https://github.com/kubeagi/arcadia/blob/main/examples/dashscope/main.go) shows how to use this [dashscope client](https://github.com/kubeagi/arcadia/tree/main/pkg/llms/dashscope) to chat with qwen-7b-chat / qwen-14b-chat / llama2-7b-chat-v2 / llama2-13b-chat-v2 and use embedding with dashscope text-embedding-v1 / text-embedding-async-v1
- [embedding](https://github.com/kubeagi/arcadia/tree/main/examples/embedding) shows how to embedes your document to vector store with embedding service
- [rbac](https://github.com/kubeagi/arcadia/blob/main/examples/rbac/main.go) shows how to inquiry the security risks in your RBAC with AI.
- [beijing_gjj_bot](https://github.com/kubeagi/arcadia/tree/main/examples/beijing_gjj_bot) show how to build a chatgpt specialized for Beijing Provident Fund regulations

0 comments on commit fb4e00c

Please sign in to comment.