Skip to content

Commit

Permalink
replaced csghub framework and simplified key features part (#772)
Browse files Browse the repository at this point in the history
* replaced csghub framework and simplified key features part

* updated readme & detailed intro en doc, added detailed intro zh doc

* updated contributing doc link in zh readme file
  • Loading branch information
kayla050 authored Nov 13, 2024
1 parent c48aa42 commit b3242f7
Show file tree
Hide file tree
Showing 7 changed files with 183 additions and 124 deletions.
38 changes: 13 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,34 +15,22 @@ Additionally, CSGHub features microservice submodules and standardized OpenAPIs

### Key Features

- **Unified Management of LLM Assets**:
Provides a one-stop management solution for models, datasets, and code, supporting storage, version control, modifications, and queries. Supports uploading and downloading large files, along with online editing and preview on the Web, improving development and collaboration efficiency.
- Unified LLMs Management
- Extensible Development Framework
- Advanced Model Capabilities and Optimization
- Space and Asset Management Assistant (Copilot)
- Multi-Source Data Synchronization and Recommendation
- Enterprise-Level Security and Access Control
- On-Premises Deployment Solutions
- E2E Data Processing and Intelligent Annotation System
- Resilient High-Availability Architecture

- **Flexible and Compatible Development Ecosystem**:
Supports both HTTPS and SSH protocols, enabling users to operate through Git commands or a web interface. The platform integrates popular SDKs such as Gradio and Streamlit, simplifying AI application development. It also offers one-click model inference and fine-tuning services with automatic environment optimization to ensure efficient deployment and operation.

- **Extended Capabilities for LLMs**:
Offers comprehensive version management, model format conversion, and automated data processing. Supports conversion tools for common data formats like CSV and JSON, and allows Web-based preview of Parquet datasets for quick data inspection.

- **Space and Asset Management Assistant (Copilot)**:
Users can demonstrate model capabilities, build prototypes, and manage applications flexibly through the Space. The Copilot assistant simplifies asset management and offers a private version to support on-premises deployment for enterprises.

- **Multi-Source Data Synchronization and Recommendation**:
Integrated with the OpenCSG community, allowing synchronization of community models and datasets. Provides personalized recommendations based on business scenarios, assisting enterprises in developing AI solutions tailored to their needs.

- **Comprehensive Permissions and Security Control**:
Supports integration with enterprise user systems, asset visibility settings, and internal-external interface authentication mechanisms. Ensures compliance through license verification and traceability, guaranteeing models adhere to legal requirements.

- **Support for On-Premises Deployment**:
Enables one-click on-premises deployment without relying on cloud services, ensuring enterprises retain full control and security over their data.

- **End-to-End Data Processing and Intelligent Annotation System**:
Provides customizable data processing pipelines for complex data cleaning and transformation tasks, leveraging parallel processing to accelerate workflows. Includes an intelligent annotation system, supporting multi-user collaboration and review to ensure data quality.
For further information, please see the [detailed introduction](./docs/detailed_intro_en.md) of CSGHub.

- **High Availability and Disaster Recovery Design**:
Adopts a high-availability architecture with load balancing and resource scheduling to ensure stability under high concurrency. Supports disaster recovery with redundant backups and snapshot technology, ensuring business continuity.
### Demo Video

For further information, please see the [detailed introduction](./docs/detailed_intro_en.md) of CSGHub.
To help users get up to speed with CSGHub, we have created a demo video that highlights its key features and how it works. You can watch it below or on [YouTube](https://www.youtube.com/watch?v=6LwGQ07qBxU)/[Bilibili](https://www.bilibili.com/video/BV1ynmxY3EXz/).
<video width="658" height="432" src="https://github.com/user-attachments/assets/04f9fa17-9294-44c1-8c4a-4d7b9a5c66fa"></video>

### Quick Start

Expand Down
40 changes: 14 additions & 26 deletions README_jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,26 @@ CSGHubは、大規模言語モデル(LLM)の資産管理のために設計

### 主な特徴

- **大規模モデル資産の統合管理**
モデル、データセット、およびコードのワンストップ管理を提供し、保存、バージョン管理、変更、検索をサポートします。超大容量ファイルのアップロードとダウンロードをサポートし、Web上でのオンライン編集とプレビューにより、開発と協業の効率を高めます。
- LLMの統合管理
- 拡張可能な開発フレームワーク
- 高度なモデル機能と最適化
- スペースと資産管理アシスタント(Copilot)
- マルチソースデータの同期と推奨
- エンタープライズレベルのセキュリティとアクセス制御
- オンプレミス展開ソリューション
- エンドツーエンドのデータ処理とインテリジェントアノテーションシステム
- 高可用性の堅牢なアーキテクチャ

- **柔軟で互換性のある開発エコシステム**
HTTPSおよびSSHプロトコルをサポートし、ユーザーがGitコマンドやWebインターフェースを通じて簡単に操作できるようにします。プラットフォームはGradioやStreamlitなどの人気SDKを統合し、AIアプリケーション開発を簡素化します。また、ワンクリックでモデルの推論と微調整サービスを提供し、環境を自動で最適化することで、効率的なデプロイと運用を実現します。

- **大規模モデルの能力拡張**
包括的なバージョン管理、モデル形式変換、そして自動データ処理をサポートします。CSV、JSONなどの一般的なデータ形式の変換ツールを提供し、Web上でParquet形式のデータセットをプレビューすることで、ユーザーが迅速にデータを確認できるようにします。

- **アプリケーションスペースと資産管理アシスタント(Copilot)**
ユーザーはアプリケーションスペースでモデルの能力を展示し、プロトタイプを構築し、柔軟に新規作成、削除、変更、検索が可能です。Copilotアシスタントは資産管理を簡素化し、企業のオンプレミス展開をサポートするプライベートバージョンも提供します。

- **マルチソースデータの同期と推薦**
OpenCSGコミュニティと統合し、コミュニティのモデルおよびデータセットの同期をサポートします。ビジネスシナリオに基づいた個別の推薦を提供し、企業が適切なAIソリューションを開発できるよう支援します。

- **包括的な権限とセキュリティ管理**
企業ユーザーシステムとの統合をサポートし、資産の可視性設定および内部・外部インターフェースの認証を提供します。ライセンス遵守の検証と追跡を通じて、モデルが法的要件を満たしていることを保証します。

- **オンプレミス展開のサポート**
クラウドサービスに依存せず、ワンクリックでのオンプレミス展開を実現し、企業がデータを完全に管理し、安全性を確保できるようにします。

- **エンドツーエンドのデータ処理とインテリジェントラベリングシステム**
カスタマイズ可能なデータ処理パイプラインを提供し、複雑なデータのクリーニングと変換をサポートします。並列処理により作業の速度を向上させ、インテリジェントラベリングシステムは多ユーザーの協力とレビューをサポートし、データ品質を保証します。
詳細については、CSGHubの[詳細紹介](./docs/detailed_intro_en.md)をご覧ください。

- **高可用性と災害復旧設計**
高可用性システムアーキテクチャを採用し、負荷分散とリソース調整を通じて高負荷状態でも安定性を確保します。冗長バックアップとスナップショット技術を使用した災害復旧をサポートし、ビジネスの継続性を保証します。
### デモ動画

詳細については、CSGHubの[詳細紹介](./docs/detailed_intro_en.md)をご覧ください。
CSGHub の主要な機能と使い方を素早く理解していただくために、デモ動画を作成しました。下記または [YouTube](https://www.youtube.com/watch?v=6LwGQ07qBxU)/[Bilibili](https://www.bilibili.com/video/BV1ynmxY3EXz/) でご覧いただけます。
<video width="658" height="432" src="https://github.com/user-attachments/assets/04f9fa17-9294-44c1-8c4a-4d7b9a5c66fa"></video>

### クイックスタート

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

- **さらに実践を希望するユーザーへ**:ローカル環境(Linux/MacOS/Windows)で CSGHub を迅速に起動したい場合は、[Docker ワンクリックデプロイ](https://github.com/OpenCSGs/csghub-installer/tree/main/docker)を使用して CSGHub インスタンスをセットアップできます。簡単なコマンドでオールインワンコンテナを起動し、CSGHub のコア機能をすぐに体験することができます。
Expand Down
40 changes: 14 additions & 26 deletions README_kr.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,26 @@ CSGHub는 대규모 언어 모델(LLM) 자산을 관리하기 위해 설계된

### 주요 기능

- **대규모 모델 자산 통합 관리**:
모델, 데이터셋 및 코드의 원스톱 관리를 제공하며, 저장, 버전 관리, 수정 및 조회를 지원합니다. 초대형 파일의 업로드와 다운로드를 지원하며, Web 상에서의 온라인 편집 및 미리 보기를 통해 개발 협업 효율을 높입니다.
- 통합된 LLM 관리
- 확장 가능한 개발 프레임워크
- 고급 모델 기능 및 최적화
- 스페이스 및 자산 관리 어시스턴트 (Copilot)
- 다중 소스 데이터 동기화 및 추천
- 엔터프라이즈급 보안 및 액세스 컨트롤
- 온프레미스 배포 솔루션
- 엔드 투 엔드 데이터 처리 및 인텔리전트 어노테이션 시스템
- 탄력적인 고가용성 아키텍처

- **유연하고 호환 가능한 개발 생태계**:
HTTPS 및 SSH 프로토콜을 지원하여 사용자가 Git 명령이나 웹 인터페이스를 통해 편리하게 작업할 수 있습니다. Gradio와 Streamlit과 같은 인기 있는 SDK를 통합하여 AI 애플리케이션 개발을 단순화합니다. 또한, 모델 추론 및 미세 조정 서비스를 원클릭으로 제공하며, 자동으로 환경을 최적화하여 효율적인 배포와 운영을 보장합니다.

- **대규모 모델 기능 확장**:
포괄적인 버전 관리, 모델 형식 변환 및 자동 데이터 처리를 지원합니다. CSV와 JSON 같은 일반적인 데이터 형식을 위한 변환 도구를 제공하며, Parquet 형식 데이터셋을 Web에서 미리 보기하여 빠르게 데이터를 점검할 수 있습니다.

- **애플리케이션 공간 및 자산 관리 도우미(Copilot)**:
사용자는 애플리케이션 공간을 통해 모델 성능을 시연하고, 애플리케이션 프로토타입을 구축하며, 유연한 생성, 삭제, 수정 및 조회 작업을 수행할 수 있습니다. Copilot 도우미는 자산 관리를 간소화하며, 기업의 온프레미스 배포를 지원하는 프라이빗 버전도 제공합니다.

- **다중 소스 데이터 동기화 및 추천**:
OpenCSG 커뮤니티와 통합되어 커뮤니티 내 모델 및 데이터셋의 동기화를 지원합니다. 비즈니스 시나리오에 따라 개인화된 추천을 제공하여 기업이 적합한 AI 솔루션을 개발할 수 있도록 돕습니다.

- **포괄적인 권한 및 보안 관리**:
기업 사용자 시스템과의 통합을 지원하며, 자산의 가시성 설정과 내부·외부 인터페이스 인증을 제공합니다. 라이선스 준수 검사와 추적을 통해 모델이 법적 요구 사항을 충족하도록 보장합니다.

- **온프레미스 배포 지원**:
클라우드 서비스에 의존하지 않고 원클릭으로 온프레미스 배포를 가능하게 하여, 기업의 데이터 통제권과 보안을 보장합니다.

- **엔드투엔드 데이터 처리 및 지능형 라벨링 시스템**:
사용자 맞춤형 데이터 처리 파이프라인을 제공하여 복잡한 데이터 정제 및 변환을 지원하며, 병렬 처리를 통해 작업 속도를 향상시킵니다. 지능형 라벨링 시스템은 다중 사용자 협업과 검토를 지원하여 데이터 품질을 보장합니다.
CSGHub에 대한 자세한 내용은 [상세 소개](./docs/detailed_intro_en.md)를 참조하세요.

- **고가용성과 재해 복구 설계**:
고가용성 시스템 아키텍처를 채택하여 부하 분산 및 자원 스케줄링을 지원함으로써 고부하 상황에서도 안정성을 보장합니다. 중복 백업 및 스냅샷 기술을 활용한 재해 복구를 통해 비즈니스 연속성을 보장합니다.
### 데모 비디오

CSGHub에 대한 자세한 내용은 [상세 소개](./docs/detailed_intro_en.md)를 참조하세요.
CSGHub 를 빠르게 익힐 수 있도록 주요 기능과 사용 방법을 소개하는 데모 비디오를 준비했습니다. 아래에서 보거나 [YouTube](https://www.youtube.com/watch?v=6LwGQ07qBxU)/[Bilibili](https://www.bilibili.com/video/BV1ynmxY3EXz/).
<video width="658" height="432" src="https://github.com/user-attachments/assets/04f9fa17-9294-44c1-8c4a-4d7b9a5c66fa"></video>

### 빠른 시작

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

- **추가 실습을 원하는 사용자**: 로컬 환경(Linux/MacOS/Windows)에서 CSGHub를 빠르게 시작하고자 한다면 [Docker 원클릭 배포](https://github.com/OpenCSGs/csghub-installer/tree/main/docker)를 사용하여 CSGHub 인스턴스를 설치할 수 있습니다. 간단한 명령어로 올인원 컨테이너를 시작하여 CSGHub의 핵심 기능을 즉시 체험할 수 있습니다.
Expand Down
Loading

0 comments on commit b3242f7

Please sign in to comment.