Skip to content

Commit 8628ca7

Browse files
MasonXonmason
andauthored
chore: update readme for installtion guide (#1304)
Co-authored-by: mason <[email protected]>
1 parent fc2b20e commit 8628ca7

File tree

5 files changed

+14
-17
lines changed

5 files changed

+14
-17
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,15 @@ To help users get up to speed with CSGHub, we have created a demo video that hig
3636

3737
### Quick Start
3838

39-
- For local installation, please refer to the [CSGHub Installer](https://github.com/OpenCSGs/csghub-installer/) project. We offer several installation options including [Helm](https://github.com/OpenCSGs/csghub-installer/blob/main/helm/README.md), [Docker Compose](https://github.com/OpenCSGs/csghub-installer/blob/main/docker/compose/README.md) and [Docker All-in-One](https://github.com/OpenCSGs/csghub-installer/blob/main/docker/README.md). Please choose the option that best meets your requirements.
40-
4139
- For those looking to quickly explore, experiment with CSGHub's free SaaS version on the [OpenCSG website](https://opencsg.com). Refer to this [brief quick start guide](./docs/csghub_saas_en.md) to handle LLMs/datasets and deploy LLM applications with CSGHub SaaS interface.
42-
For more information, please refer to the [OpenCSG Documentation Center](https://opencsg.com/docs/en/intro).
4340

44-
- For those seeking a hands-on experience, you can quickly launch CSGHub on your local environment (Linux/MacOS/Windows) using the [Docker one-click deployment guide](https://github.com/OpenCSGs/csghub-installer/tree/main/docker), which allows you to start an all-in-one container with simplified commands and instantly experience the core functionalities of CSGHub.
41+
- **For users seeking further practice:** Please refer to the [CSGHub official documentation](https://opencsg.com/docs/csghub/101/introduction). The documentation currently provides installation methods using [Docker Compose](https://opencsg.com/docs/csghub/101/install/install_csghub_by_docker) and [Helm Chart](https://opencsg.com/docs/csghub/101/install/install_csghub_by_helm).
42+
43+
_For more information and advanced tutorials, please refer to the [OpenCSG Documentation Center](https://opencsg.com/docs/intro)._
4544

46-
- For those deploying on Kubernetes, refer to the [Helm Chart installation guide](https://github.com/OpenCSGs/csghub-installer/tree/main/helm) for step-by-step instructions.
4745

4846
### Quick Try
47+
4948
[![one-click deployment on Ali marketplace](https://img.alicdn.com/imgextra/i1/O1CN01YT0adL1pi2znO6BAJ_!!6000000005393-55-tps-208-40.svg)](https://market.aliyun.com/products/56014009/cmgj00068499.html?source=5176.29345612&userCode=swc743za)
5049

5150
### Roadmap

README_es.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@ Para ayudar a los usuarios a familiarizarse rápidamente con CSGHub, hemos produ
3535
### Comenzar rápidamente
3636

3737
- **Usuarios que desean explorar rápidamente:** Pueden experimentar la versión SaaS gratuita de CSGHub en el sitio web de [OpenCSG](https://opencsg.com). Consulte esta [guía de inicio rápido](./docs/csghub_saas_zh.md) para administrar grandes modelos y conjuntos de datos a través de la interfaz de CSGHub SaaS e implementar aplicaciones de grandes modelos.
38-
Para obtener más información y tutoriales avanzados, consulte el [Centro de Documentación de OpenCSG](https://opencsg.com/docs/intro).
3938

40-
- **Usuarios que desean practicar más:** Si desea iniciar rápidamente CSGHub en su entorno local (Linux/MacOS/Windows), puede usar la [implementación de Docker en un clic](https://github.com/OpenCSGs/csghub-installer/blob/main/docs/zh/README_docker_cn.md) para iniciar una instancia de CSGHub, lanzando un contenedor todo en uno con el comando más simple y experimentar inmediatamente las funciones principales de CSGHub.
39+
- **Para usuarios que buscan más práctica:** Consulten la [documentación oficial de CSGHub](https://opencsg.com/docs/csghub/101/introduction). Actualmente, la documentación proporciona métodos de instalación con [Docker Compose](https://opencsg.com/docs/csghub/101/install/install_csghub_by_docker) y [Helm Chart](https://opencsg.com/docs/csghub/101/install/install_csghub_by_helm).
4140

42-
- **Usuarios que desean implementar en Kubernetes:** Consulte la [Guía de instalación de Helm Chart](https://github.com/OpenCSGs/csghub-installer/blob/main/docs/zh/README_helm_cn.md) para la implementación.
41+
_Para más información y tutoriales avanzados, consulten el Centro de [Documentación de OpenCSG](https://opencsg.com/docs/intro)._
4342

4443
### Mapa de ruta
4544

README_jp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ CSGHub の主要な機能と使い方を素早く理解していただくため
3535
### クイックスタート
3636

3737
- **探索したい方:** [OpenCSGのウェブサイト](https://opencsg.com)で、CSGHubの無料SaaS版を試用できます。[クイックスタートガイド](./docs/csghub_saas_en.md)を参考にして、CSGHub SaaSインターフェースを使い、LLMやデータセットの管理とLLMアプリケーションのデプロイをお試しください。
38-
詳細については、[OpenCSG ドキュメントセンター](https://opencsg.com/docs/en/intro)をご参照ください。
3938

40-
- **さらに実践を希望するユーザーへ:** ローカル環境(Linux/MacOS/Windows)で CSGHub を迅速に起動したい場合は、[Docker ワンクリックデプロイ](https://github.com/OpenCSGs/csghub-installer/tree/main/docker)を使用して CSGHub インスタンスをセットアップできます。簡単なコマンドでオールインワンコンテナを起動し、CSGHub のコア機能をすぐに体験することができます。
39+
- **さらに実践したいユーザー向け:** [CSGHub公式ドキュメント](https://opencsg.com/docs/csghub/101/introduction)を参照してください。このドキュメントでは現在、[Docker Compose](https://opencsg.com/docs/csghub/101/install/install_csghub_by_docker)[Helm Chart](https://opencsg.com/docs/csghub/101/install/install_csghub_by_helm)を使用したインストール方法が紹介されています。
40+
41+
_詳細情報と高度なチュートリアルについては、[OpenCSGドキュメントセンター](https://opencsg.com/docs/intro)を参照してください。_
4142

42-
- **Kubernetesでのデプロイを希望する方:** KubernetesクラスタでのCSGHubのデプロイについては、[Helm Chartインストールガイド](https://github.com/OpenCSGs/csghub-installer/tree/main/helm)をご覧ください。
4343

4444
### ロードマップ
4545

README_kr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ CSGHub 를 빠르게 익힐 수 있도록 주요 기능과 사용 방법을 소
3535
### 빠른 시작
3636

3737
- **탐색을 원하는 사용자:** [OpenCSG 웹사이트](https://opencsg.com)에서 CSGHub의 무료 SaaS 버전을 사용해 보세요. [간단한 빠른 시작 가이드](./docs/csghub_saas_en.md)를 참조하여 CSGHub SaaS 인터페이스로 LLM과 데이터셋을 관리하고 LLM 애플리케이션을 배포해 보세요.
38-
자세한 정보는 [OpenCSG 문서 센터](https://opencsg.com/docs/en/intro)를 참조하세요.
3938

40-
- **추가 실습을 원하는 사용자:** 로컬 환경(Linux/MacOS/Windows)에서 CSGHub를 빠르게 시작하고자 한다면 [Docker 원클릭 배포](https://github.com/OpenCSGs/csghub-installer/tree/main/docker)를 사용하여 CSGHub 인스턴스를 설치할 수 있습니다. 간단한 명령어로 올인원 컨테이너를 시작하여 CSGHub의 핵심 기능을 즉시 체험할 수 있습니다.
39+
- **추가 연습을 원하는 사용자:** [CSGHub 공식 문서](https://opencsg.com/docs/csghub/101/introduction)를 참조하세요. 이 문서는 현재 [Docker Compose](https://opencsg.com/docs/csghub/101/install/install_csghub_by_docker)[Helm Chart](https://opencsg.com/docs/csghub/101/install/install_csghub_by_helm)를 사용한 설치 방법을 제공합니다.
40+
41+
_자세한 내용 및 고급 튜토리얼은 [OpenCSG 문서 센터](https://opencsg.com/docs/intro)를 참조하세요._
4142

42-
- **Kubernetes에 배포하려는 사용자:** [Helm Chart 설치 가이드](https://github.com/OpenCSGs/csghub-installer/tree/main/helm)를 참조하여 단계별 지침을 따르세요.
4343

4444
### 로드맵
4545

README_zh.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@ CSGHub 是一个开源平台,专为管理大语言模型(LLM)资产而设
3535
### 快速开始
3636

3737
- **想要快速探索的用户:** 可在 [OpenCSG 网站](https://opencsg.com)上体验 CSGHub 的免费 SaaS 版本。参考该[快速开始指南](./docs/csghub_saas_zh.md),通过 CSGHub SaaS 界面管理大模型和数据集,部署大模型应用。
38-
更多信息与高级教程请参阅 [OpenCSG 文档中心](https://opencsg.com/docs/intro)
3938

40-
- **想要进一步实践的用户:** 若希望在本机环境(Linux/MacOS/Windows)上快速启动 CSGHub,可以使用 [Docker 一键部署](https://github.com/OpenCSGs/csghub-installer/blob/main/docs/zh/README_docker_cn.md) CSGHub 实例,通过最简化的命令启动一个 all-in-one 的容器,即刻体验 CSGHub 核心功能
39+
- **想要进一步实践的用户:** 请参阅 [CSGHub 官方文档](https://opencsg.com/docs/csghub/101/introduction)。目前文档中已提供 [Docker Compose ](https://opencsg.com/docs/csghub/101/install/install_csghub_by_docker)[Helm Chart](https://opencsg.com/docs/csghub/101/install/install_csghub_by_helm) 安装方式
4140

42-
- **想要在 Kubernetes 上部署的用户:** 请参考 [Helm Chart 安装指南](https://github.com/OpenCSGs/csghub-installer/blob/main/docs/zh/README_helm_cn.md)进行部署。
41+
_更多信息与高级教程请参阅 [OpenCSG 文档中心](https://opencsg.com/docs/intro)_
4342

4443
### 路线图
4544

0 commit comments

Comments
 (0)