Skip to content

README_JA.md

Latest commit

 

History

History
473 lines (323 loc) · 18.7 KB

README_JA.md

File metadata and controls

473 lines (323 loc) · 18.7 KB
Raw

| ⚡ 大規模ドキュメント知識Q&A | 📈 インタラクティブ学習可視化 |
| 🧠 知識強化 | 🔬 深い研究とアイデア生成 |

DeepTutor の主要機能

📚 大規模ドキュメント知識Q&A

• スマート知識ベース：教科書、研究論文、技術マニュアル、ドメイン固有のドキュメントをアップロード。包括的な AI 駆動の知識リポジトリを構築し、即座にアクセス可能にします。
• マルチエージェント問題解決：RAG、ウェブ検索、論文検索、コード実行を統合したデュアルループ推論アーキテクチャ—正確な引用付きの段階的なソリューションを提供します。

🎨 インタラクティブ学習可視化

• 知識の簡素化と説明：複雑な概念、知識、アルゴリズムを理解しやすい視覚補助、詳細な段階的分解、魅力的なインタラクティブデモンストレーションに変換します。
• パーソナライズされたQ&A：学習の進捗に適応するコンテキスト対応の会話、インタラクティブページとセッションベースの知識追跡を提供します。

🎯 練習問題生成器による知識強化

• インテリジェントな演習作成：現在の知識レベルと特定の学習目標に合わせて、ターゲットを絞ったクイズ、練習問題、カスタマイズされた評価を生成します。
• 本格的な試験シミュレーション：参考試験をアップロードして、元のスタイル、形式、難易度に完全に一致する練習問題を生成—実際のテストのための現実的な準備を提供します。

🔍 深い研究とアイデア生成

• 包括的な研究と文献レビュー：系統的な分析による深いトピック探索を実施。パターンを識別し、分野を超えた関連概念を接続し、既存の研究結果を統合します。
• 新しい洞察の発見：構造化された学習資料を生成し、知識のギャップを発見します。インテリジェントなクロスドメイン知識統合を通じて、有望な新しい研究方向を特定します。

All-in-One Tutoring System

📚 大規模ドキュメント知識Q&A


ドキュメントQ&Aとステップバイステップの問題解決

🎨 インタラクティブ学習可視化


知識の視覚的説明を備えたインタラクティブなAI学習

🎯 知識強化

カスタム質問
即座のフィードバックを備えた自動検証の練習問題

模擬質問
本格的な練習のための試験スタイルのクローン

🔍 深い研究とアイデア生成

深い研究
文献レビューを備えたウェブおよび論文検索

自動化されたアイデア生成
系統的なブレインストーミングと概念統合

インタラクティブなアイデア生成
マルチソースの洞察を備えたRAG駆動のアイデア生成

🏗️ オールインワン知識システム

個人知識ベース
独自の知識リポジトリを構築・整理

個人ノートブック
学習セッションのコンテキストメモリ

🌙 ダークモード で DeepTutor を使用！

🏛️ DeepTutor のフレームワーク

DeepTutor Full-Stack Workflow

💬 ユーザーインターフェース層

• 直感的なインタラクション：直感的なインタラクションのためのシンプルな双方向クエリ-レスポンスフロー。
• 構造化された出力：複雑な情報を実行可能な出力に整理する構造化レスポンス生成。

🤖 インテリジェントエージェントモジュール

• 問題解決と評価：段階的な問題解決とカスタム評価生成。
• 研究と学習：トピック探索のための深い研究と可視化を備えたガイド付き学習。
• アイデア生成：マルチソースの洞察を備えた自動化およびインタラクティブな概念開発。

🔧 ツール統合層

• 情報検索：RAG ハイブリッド検索、リアルタイムウェブ検索、学術論文データベース。
• 処理と分析：Python コード実行、クエリ項目検索、ドキュメント分析のための PDF 解析。

🧠 知識とメモリ基盤

• 知識グラフ：セマンティック接続と知識発見のためのエンティティ-関係マッピング。
• ベクトルストア：インテリジェントなコンテンツ検索のための埋め込みベースのセマンティック検索。
• メモリシステム：コンテキストの継続性のためのセッション状態管理と引用追跡。

📋 タスク

🌟 今後の更新をフォローするために Star してください！

  • プロジェクトベースの学習
  • アイデア生成からの深いコーディング
  • パーソナライズされたメモリ

🚀 クイックスタート

ステップ 1: リポジトリのクローンと仮想環境の作成

# リポジトリをクローン
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor

# 仮想環境を作成（方法を選択）

# オプション A: conda を使用（推奨）
conda create -n aitutor python=3.10
conda activate aitutor

# オプション B: venv を使用
python -m venv venv
# Windows:
venv\Scripts\activate
# macOS/Linux:
source venv/bin/activate

ステップ 2: 依存関係をインストール

一鍵インストールスクリプトを実行して、すべての依存関係を自動インストール：

# 推奨：bash スクリプトを使用
bash scripts/install_all.sh

# または Python スクリプトを使用
python scripts/install_all.py

# 注：インストーラーは conda/venv の隔離環境を検出します。隔離環境が検出できない場合は警告を表示しますが、インストールは継続します。

# または手動でインストール
pip install -r requirements.txt
npm install

ステップ 3: 環境変数を設定

プロジェクトのルートディレクトリに .env.example に基づいて .env ファイルを作成：

# .env.example テンプレートからコピー（存在する場合）
cp .env.example .env

# その後、.env ファイルを API キーで編集：

ステップ 4: ポートを設定 (オプション)

デフォルトでは、アプリケーションは以下を使用：

  • バックエンド (FastAPI): 8001
  • フロントエンド (Next.js): 3782

config/main.yaml の server.backend_port および server.frontend_port 値を編集して、これらのポートを変更できます。

LLM パラメータ：すべてのエージェントの temperature と max_tokens 設定は config/agents.yaml に集中しています。各モジュール（guide、solve、research、question、ideagen、co_writer）には独自のパラメータセットがあります。詳細については設定ドキュメントを参照してください。

ステップ 5: デモを使用 (オプション)

システムを素早く体験するために、2 つの前処理されたナレッジベースと、一連のチャレンジングな質問とユース例を提供しています。

研究論文集合 — 5 論文（各 20-50 ページ）

私たちのラボからの RAG と Agent フィールドの厳選された 5 つの研究論文。このデモは幅広い知識カバレッジを持つ研究シナリオを表しています。

使用論文: AI-Researcher | AutoAgent | RAG-Anything | LightRAG | VideoRAG

データサイエンス教科書 — 8 章、296 ページ

包括的でチャレンジングなデータサイエンス教科書。このデモは深い知識の深さを持つ学習シナリオを表しています。

書籍リンク: Deep Representation Learning Book


ダウンロードとセットアップ：

  1. デモパッケージをダウンロード: Google Drive
  2. 圧縮ファイルを data/ ディレクトリに直接抽出
  3. プロジェクト開始後、ナレッジベースは自動的にシステムで利用可能

注意： ナレッジベースを初期化する際、text-embedding-3-large を埋め込みモデルとして使用し、dimensions = 3072 としています。埋め込みモデルの次元も 3072 であることを確認してください。

ステップ 6: アプリケーションを開始

# 仮想環境が有効化されていることを確認
conda activate aitutor  # または: source venv/bin/activate

# Web インターフェース（フロントエンド + バックエンド）を開始
python scripts/start_web.py

# または CLI インターフェースのみを開始
python scripts/start.py

# サービスを停止するには、Ctrl+C を押す

ステップ 7: 独自のナレッジベースを作成

アプリケーション開始後、Web インターフェースを通じて独自のナレッジベースを作成できます。

  1. ナレッジベースページへアクセス: http://localhost:{frontend_port}/knowledge にアクセス
  2. 新規ナレッジベースを作成: 「New Knowledge Base」ボタンをクリック
  3. ナレッジベースに名前を付ける: ナレッジベースに一意の名前を入力
  4. ファイルをアップロード: 1 つ以上のファイルをアップロード
  5. 処理を待つ: システムがファイルをバックグラウンドで自動処理
    • start_web.py を実行しているターミナルで作成進度を監視
    • 処理完了後、ナレッジベースが利用可能になる

ヒント： 大きなファイルは処理に数分かかる場合があります。複数のファイルを一度にアップロードしてバッチ処理できます。

アクセス URL

サービス URL 説明
フロントエンド http://localhost:{frontend_port} メイン Web インターフェース
API ドキュメント http://localhost:{backend_port}/docs インタラクティブ API ドキュメント
ヘルスチェック http://localhost:{backend_port}/api/v1/knowledge/health システムヘルスチェック

📄 ライセンス

このプロジェクトは AGPL-3.0 ライセンス でライセンスされています。

⭐ Star History

🤝 貢献

コミュニティからの貢献を歓迎します！コード品質と一貫性を確保するため、以下のガイドラインに従ってください。

開発セットアップ

Pre-commit Hooks セットアップ

このプロジェクトは pre-commit hooks を使用して、コミット前に自動的にコードをフォーマットし、問題をチェックします。

ステップ 1: pre-commit をインストール

# pip を使用
pip install pre-commit

# または conda を使用
conda install -c conda-forge pre-commit

ステップ 2: Git hooks をインストール

cd DeepTutor
pre-commit install

ステップ 3: （オプション）すべてのファイルでチェックを実行

pre-commit run --all-files

git commit を実行するたびに、pre-commit hooks は自動的に以下を行います：

  • Ruff で Python コードをフォーマット
  • Prettier でフロントエンドコードをフォーマット
  • 構文エラーをチェック
  • YAML/JSON ファイルを検証
  • 潜在的なセキュリティ問題を検出

コード品質ツール

ツール 目的 構成
Ruff Python コード確認とフォーマット pyproject.toml
Prettier フロントエンドコード形式 web/.prettierrc.json
detect-secrets セキュリティチェック .secrets.baseline

注意: プロジェクトはフォーマット競合を回避するため、Black の代わりに Ruff format を使用します。

よく使うコマンド

# 通常のコミット（hooks が自動実行）
git commit -m "コミットメッセージ"

# すべてのファイルを手動でチェック
pre-commit run --all-files

# hooks を最新バージョンに更新
pre-commit autoupdate

# hooks をスキップ（推奨されません。緊急時のみ）
git commit --no-verify -m "緊急修正"

貢献ガイドライン

  1. Fork とクローン: リポジトリを Fork してクローン
  2. ブランチを作成: main からフィーチャーブランチを作成
  3. Pre-commit をインストール: 上記セットアップステップに従う
  4. 変更を実施: プロジェクトのスタイルに従ってコードを記述
  5. テスト: 変更が正しく機能することを確認
  6. コミット: Pre-commit hooks が自動的にコードをフォーマット
  7. プッシュと PR: Fork にプッシュして Pull Request を作成

問題を報告

  • GitHub Issues を使用してバグを報告またはフィーチャーを提案
  • 問題に関する詳細情報を提供
  • バグの場合は、再現手順を含める

❤️ すべての貢献者の貴重な貢献に感謝します。

🔗 関連プロジェクト

⚡ LightRAG 🎨 RAG-Anything 💻 DeepCode 🔬 AI-Researcher
シンプルで高速の RAG マルチモーダル RAG AI コードアシスタント 研究自動化

香港大学データインテリジェンスラボ

⭐ Star us · 🐛 Report a bug · 💬 Discussions

✨ DeepTutor のご利用ありがとうございます！

Views