Skip to content

Commit 77c879c

Browse files
authored
docs(readme): add installation section and update documentation (#135)
1 parent db09fc2 commit 77c879c

13 files changed

Lines changed: 544 additions & 312 deletions

File tree

README.ja.md

Lines changed: 58 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### OpenDeRisk
22

3-
OpenDeRisk AI-Native Risk Intelligence Systems —— AIネイティブなリスクインテリジェンスシステム。アプリケーションシステムのリスクインテリジェントマネージャーとして、24時間365日の包括的で徹底的な保護を提供します
3+
OpenDeRisk は AI ネイティブリスクインテリジェンスシステムです。アプリケーションシステムのリスクインテリジェントマネージャーとして、24 時間 365 日の包括的で徹底的な保護を提供します
44

55
<div align="center">
66
<p>
@@ -24,18 +24,18 @@ OpenDeRisk AI-Native Risk Intelligence Systems —— AIネイティブなリス
2424
</a>
2525
</p>
2626

27-
[**English**](README.md) | [**简体中文**](README.zh.md) | [**日本語**](README.ja.md) | [**視頻チュートリアル**](https://www.youtube.com/watch?v=1qDIu-Jwdf0)
27+
[**English**](README.md) | [**简体中文**](README.zh.md) | [**日本語**](README.ja.md) | [**動画チュートリアル**](https://www.youtube.com/watch?v=1qDIu-Jwdf0)
2828
</div>
2929

3030
### ニュース
31-
- [2025/10] 🔥 OpenDerisk V0.2をリリースしました. [OpenDerisk V0.2 ReleaseNote](./docs/docs/OpenDerisk_v0.2.md)
31+
- [2025/10] 🔥 OpenDerisk V0.2 をリリースしました。[OpenDerisk V0.2 ReleaseNote](./docs/docs/OpenDerisk_v0.2.md)
3232

3333

3434
### 機能特徴
3535
1. **DeepResearch RCA:** ログ、トレース、コードの詳細な分析により、問題の根本原因を迅速に特定します。
3636
2. **可視化された証拠チェーン:** 診断プロセスと証拠チェーンを完全に可視化し、診断を明確にして精度を迅速に判断できます。
37-
3. **マルチエージェント協調:** SRE-Agent、Code-Agent、ReportAgent、Vis-Agent、Data-Agentの協調作業
38-
4. **オープンソースアーキテクチャ:** OpenDeRiskは完全にオープンソースのアーキテクチャで構築されており、関連フレームワークとコードをオープンソースプロジェクトですぐに使用できます。
37+
3. **マルチエージェント協調:** SRE-Agent、Code-Agent、ReportAgent、Vis-Agent、Data-Agent の協調作業
38+
4. **オープンソースアーキテクチャ:** OpenDeRisk は完全にオープンソースのアーキテクチャで構築されており、関連フレームワークとコードをオープンソースプロジェクトですぐに使用できます。
3939

4040
<p align="left">
4141
<img src="./assets/features.jpg" width="100%" />
@@ -47,118 +47,97 @@ OpenDeRisk AI-Native Risk Intelligence Systems —— AIネイティブなリス
4747
</p>
4848

4949
#### 紹介文書
50-
- [OpenDerisk DeepWikiドキュメント](https://deepwiki.com/derisk-ai/OpenDerisk)
51-
52-
このシステムはマルチエージェントアーキテクチャを採用しています。現在、コードは主に緑色でハイライトされた部分を実装しています。アラート認識はMicrosoftのオープンソース[OpenRCAデータセット](https://github.com/microsoft/OpenRCA)に基づいています。データセットのサイズは解凍後約26GBです。このデータセット上で、マルチエージェントの協調により根本原因分析と診断を実現し、Code-Agentが最終分析のために動的にコードを作成します。
50+
このシステムはマルチエージェントアーキテクチャを採用しています。現在、コードは主にハイライトされた部分を実装しています。アラート認識は Microsoft のオープンソース [OpenRCA データセット](https://github.com/microsoft/OpenRCA) に基づいています。データセットのサイズは解压後約 26GB です。このデータセット上で、マルチエージェントの協調により根本原因分析と診断を実現し、Code-Agent が最終分析のために動的にコードを作成します。
5351

5452
#### 技術実装
55-
**データ層:** GitHubから大規模なOpenRCAデータセット(20GBを取得し、ローカルで解凍して分析用に処理します
53+
**データ層:** GitHub から大規模な OpenRCA データセット (20GB) を取得し、ローカルで解压して分析用に処理します
5654

57-
**ロジック層:** マルチエージェントアーキテクチャで、SRE-Agent、Code-Agent、ReportAgent、Vis-Agent、Data-Agentが協調して詳細なDeepResearch RCA(根本原因分析)を実行します。
55+
**ロジック層:** マルチエージェントアーキテクチャで、SRE-Agent、Code-Agent、ReportAgent、Vis-Agent、Data-Agent が協調して詳細な DeepResearch RCA(根本原因分析)を実行します。
5856

59-
**可視化層:** Visプロトコルを使用して、全体の処理フローと証拠チェーン、およびマルチロールの協調とスイッチングプロセスを動的にレンダリングします。
57+
**可視化層:** Vis プロトコルを使用して、全体の処理フローと証拠チェーン、およびマルチロールの協調とスイッチングプロセスを動的にレンダリングします。
6058

61-
OpenDeRiskのデジタル従業員(エージェント)
59+
OpenDeRisk のデジタル従業員(エージェント)
6260
<p align="left">
6361
<img src="./assets/ai-agent.png" width="100%" />
6462
</p>
6563

66-
### クイックスタート
64+
### インストール(推奨)
6765

68-
uvのインストール
66+
#### curl でのインストール
6967

7068
```shell
71-
curl -LsSf https://astral.sh/uv/install.sh | sh
69+
# 最新バージョンのダウンロードとインストール
70+
curl -fsSL https://raw.githubusercontent.com/derisk-ai/OpenDerisk/main/install.sh | bash
7271
```
7372

74-
#### パッケージのインストール
73+
#### 設定ファイル
74+
インストール後、システムを設定する必要があります。設定ファイルを作成してください:
75+
`~/.openderisk/derisk-proxy-aliyun.toml` を編集し、API キーを設定してください。
7576

77+
#### 起動
7678
```
77-
uv sync --all-packages --frozen \
78-
--extra "base" \
79-
--extra "proxy_openai" \
80-
--extra "rag" \
81-
--extra "storage_chromadb" \
82-
--extra "derisks" \
83-
--extra "storage_oss2" \
84-
--extra "client" \
85-
--extra "ext_base"
79+
openderisk-server
8680
```
8781

88-
#### 起動
82+
### ソースからのインストール(開発用)
83+
84+
uv のインストール(必須):
85+
```shell
86+
87+
git clone https://github.com/derisk-ai/OpenDerisk.git
88+
89+
cd OpenDerisk
90+
91+
# 依存関係のインストール
92+
sh scripts/prepare_release.sh
93+
```
8994

90-
`derisk-proxy-aliyun.toml`ファイルでAPI_KEYを設定し、次のコマンドを実行して起動します。
95+
#### サーバーの起動
9196

92-
> 注意:デフォルトでは、OpenRCAデータセットのTelecomデータセットを使用します。リンクまたは以下のコマンドでダウンロードできます
97+
`derisk-proxy-aliyun.toml` で API_KEY を設定し、実行
9398

94-
> gdown https://drive.google.com/uc?id=1cyOKpqyAP4fy-QiJ6a_cKuwR7D46zyVe
99+
> 注意:デフォルトでは、OpenRCA データセットの Telecom データセットを使用します。リンクまたは以下のコマンドでダウンロードできます:
100+
> `gdown https://drive.google.com/uc?id=1cyOKpqyAP4fy-QiJ6a_cKuwR7D46zyVe`
95101
96-
ダウンロード後、データセットを`pilot/datasets/`パスに移動します。
102+
ダウンロード後、データセットを `pilot/datasets/` パスに移動します。
97103

98104
起動コマンドを実行:
99-
```
105+
```bash
100106
uv run python packages/derisk-app/src/derisk_app/derisk_server.py --config configs/derisk-proxy-aliyun.toml
101107
```
102108

103109
#### ウェブサイトへのアクセス
104110

105-
ブラウザを開いて[`http://localhost:7777`](http://localhost:7777)にアクセス
106-
<p align="left">
107-
<img src="./assets/index.jpg" width="100%" />
108-
</p>
111+
ブラウザを開いて [`http://localhost:7777`](http://localhost:7777) にアクセス
112+
109113

110114
### 使用方法
111-
* AI-SRE(OpenRCA)
112-
- 注意:OpenRCAデータセット[Bankデータセット](https://drive.usercontent.google.com/download?id=1enBrdPT3wLG94ITGbSOwUFg9fkLR-16R&export=download&confirm=t&uuid=42621058-41af-45bf-88a6-64c00bfd2f2e)を使用しています
113-
- 次のリンクでデータセットをダウンロードできます:
114-
```
115-
gdown https://drive.google.com/uc?id=1enBrdPT3wLG94ITGbSOwUFg9fkLR-16R
116-
```
117-
- データセットを`${derisk}/pilot/datasets`パスに配置します。
118-
* フレームグラフアシスタント
119-
- ローカルアプリケーションサービスプロセスのフレームグラフ(Java/Python)をアシスタントにアップロードして分析と問い合わせを行います。
120-
* DataExpert
121-
- メトリクス、ログ、トレース、または様々なExcelデータシートをアップロードして対話型分析を行います。
115+
* **AI-SRE (OpenRCA)**
116+
- 注意: OpenRCA データセットの [Bank データセット](https://drive.usercontent.google.com/download?id=1enBrdPT3wLG94ITGbSOwUFg9fkLR-16R&export=download&confirm=t&uuid=42621058-41af-45bf-88a6-64c00bfd2f2e) を使用しています
117+
- ダウンロード: `gdown https://drive.google.com/uc?id=1enBrdPT3wLG94ITGbSOwUFg9fkLR-16R`
118+
- データセットを `${derisk}/pilot/datasets` パスに配置します
119+
* **フレームグラフアシスタント**
120+
- ローカルアプリケーションサービスプロセスのフレームグラフ (Java/Python) をアシスタントにアップロードして分析を行います
121+
* **DataExpert**
122+
- メトリクス、ログ、トレース、または様々な Excel データシートをアップロードして対話型分析を行います
122123

123124
### 高速開発
124-
* エージェント開発
125-
`derisk-ext.agent.agents`配下の実装ロジックを参照してください。
126-
* ツール開発
127-
* ローカルツール
128-
* MCP
129-
* その他の開発
130-
ドキュメント準備中...
131-
132-
* DeRisk-Skills 発達
125+
* **エージェント開発**
126+
- `derisk-ext.agent.agents` 配下の実装ロジックを参照してください
127+
* **ツール開発**
128+
* ローカルツール
129+
* MCP (Model Context Protocol)
130+
* **DeRisk-Skills 開発**
133131
- [derisk-skills](https://github.com/derisk-ai/derisk_skills)
134132

135133
#### 実行結果
136-
下図に示すように、複数のエージェントが協調して複雑な運用診断タスクを処理するシナリオを示しています。
134+
下图に示すように、複数のエージェントが協調して複雑な運用診断タスクを処理するシナリオを示しています。
137135

138136
<p align="left">
139137
<img src="./assets/scene_demo.png" width="100%" />
140138
</p>
141139

142-
### ロードマップ
143-
- [x] 0530 V0.1バージョン:ドメイン知識とMCPサービスに基づき、異常認識→自律的意思決定→適応的実行と問題解決を実現。
144-
- [x] 技術リスクのためのドメイン知識エンジン
145-
- [x] 異常認識→意思決定→実行のための大規模モデル駆動推論エンジン
146-
- [x] 自動トラブルシューティングと修正
147-
148-
- [x] 0830 V0.2バージョン
149-
- [x] 技術リスクのためのMCPサービスと管理
150-
- [x] 知識とMCPツールのカスタムバインディングサポート
151-
- [x] 3つ以上のDevOpsドメインMCPサービスのサポート
152-
153-
- [ ] 0930 V0.3バージョン
154-
- [ ] 本番環境との統合サポート
155-
- [ ] 本番環境デプロイメントの完全なソリューションを提供し、本番の問題診断をサポート。
156-
157-
- [ ] 1230 V0.4バージョン
158-
- [ ] エンドツーエンドAIOpsオンラインAgentic RL
159-
- [ ] エンドツーエンド評価機能
160-
161-
### いんよう
140+
### 引用
162141
このリポジトリのコードについては、以下の論文で詳細な紹介をしています。もし、あなたの研究に役立ったと思われる場合は、ぜひ引用してください。
163142
```
164143
@misc{di2025openderiskindustrialframeworkaidriven,
@@ -178,14 +157,15 @@ uv run python packages/derisk-app/src/derisk_app/derisk_server.py --config confi
178157
- [MetaGPT](https://github.com/FoundationAgents/MetaGPT)
179158
- [OpenRCA](https://github.com/microsoft/OpenRCA)
180159

181-
OpenDeRisk-AIコミュニティは、AIネイティブなリスクインテリジェンスシステムの構築に専念しています。🛡️ 私たちのコミュニティがより良いサービスを提供できることを願い、また皆様が私たちに参加してより良い未来を共に創造することを願っています。🤝
160+
OpenDeRisk-AI コミュニティは、AI ネイティブなリスクインテリジェンスシステムの構築に専念しています。🛡️ 私たちのコミュニティがより良いサービスを提供できることを願い、また皆様が私たちに参加してより良い未来を共に創造することを願っています。🤝
161+
182162

183163
[![Star History Chart](https://api.star-history.com/svg?repos=derisk-ai/OpenDerisk&type=Date)](https://star-history.com/#derisk-ai/OpenDerisk)
184164

185165

186166
### コミュニティグループ
187167

188-
DingDingのネットワーキンググループに参加して、他の開発者と経験を共有しましょう!
168+
DingTalk グループに参加して、他の開発者と経験を共有しましょう!
189169

190170
<div align="center" style="display: flex; gap: 20px;">
191171
<img src="assets/derisk-ai.jpg" alt="OpenDeRisk-AI 交流群" width="200" />

0 commit comments

Comments
 (0)