Skip to content

Latest commit

 

History

History
537 lines (375 loc) · 19.6 KB

File metadata and controls

537 lines (375 loc) · 19.6 KB

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


[2026.1.1] 新年あけましておめでとうございます!Discord コミュニティWeChat コミュニティ、または Discussions に参加して、DeepTutor の未来を一緒に創りましょう!💬

[2025.12.30] 詳細は 公式ウェブサイト をご覧ください!

[2025.12.29] DeepTutor が公開されました!✨


DeepTutor の主要機能

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

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

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

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

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

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

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

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


All-in-One Tutoring System

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


正確な引用を伴うマルチエージェント問題解決

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


パーソナライズされたQ&Aを備えたステップバイステップの視覚的説明

🎯 知識強化

カスタム質問
自動検証された練習問題の生成

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

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

深い研究
RAG、ウェブ、論文検索による教科書からの知識拡張

自動化されたアイデア生成
デュアルフィルターワークフローによる系統的なブレインストーミングと概念統合

インタラクティブなアイデア生成
ポッドキャスト生成を備えたRAGとウェブ検索駆動のCo-Writer

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

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

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

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


🏛️ DeepTutor のフレームワーク

DeepTutor Full-Stack Workflow

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

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

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

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

🔧 ツール統合層

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

🧠 知識とメモリ基盤

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

📋 タスク

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

  • ローカル LLM サービスのサポート(例:ollama)
  • RAG モジュールのリファクタリング(Discussions を参照)
  • アイデア生成からの深いコーディング
  • ノートブックとのパーソナライズされたインタラクション

🚀 クイックスタート

ステップ 1: 事前設定

① リポジトリをクローン

git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor

② 環境変数を設定

cp .env.example .env
# API キーで .env ファイルを編集
📋 環境変数リファレンス
変数 必須 説明
LLM_MODEL はい モデル名(例:gpt-4o
LLM_API_VERSION いいえ Azure OpenAI の API バージョン(例:2024-02-15-preview
LLM_API_KEY はい LLM API キー
LLM_HOST はい API エンドポイント URL
EMBEDDING_MODEL はい 埋め込みモデル名
EMBEDDING_API_VERSION いいえ Azure OpenAI Embeddings の API バージョン
EMBEDDING_API_KEY はい 埋め込み API キー
EMBEDDING_HOST はい 埋め込み API エンドポイント
BACKEND_PORT いいえ バックエンドポート(デフォルト:8001
FRONTEND_PORT いいえ フロントエンドポート(デフォルト:3782
NEXT_PUBLIC_API_BASE いいえ フロントエンド用 API URL(リモート/LAN アクセス時に設定。例:http://192.168.1.100:8001
TTS_* いいえ テキスト読み上げ設定
SEARCH_PROVIDER いいえ 検索プロバイダー(オプション:perplexity, tavily, serper, jina, exa, baidu、デフォルト:perplexity
SEARCH_API_KEY いいえ 統一検索APIキー

💡 リモートアクセス:別デバイス(例:192.168.31.66:3782)からアクセスする場合は .env に追加します:

NEXT_PUBLIC_API_BASE=http://192.168.31.66:8001

③ ポートと LLM を設定 (オプション)

  • ポート.envBACKEND_PORT / FRONTEND_PORT を設定(デフォルト:8001/3782)
  • LLMconfig/agents.yaml を編集 → 各モジュールの temperature / max_tokens
  • 詳細は設定ドキュメントを参照

④ デモナレッジベースを試す (オプション)

📚 利用可能なデモ
  1. Google Drive からダウンロード
  2. data/ ディレクトリに解凍

デモ KB は text-embedding-3-large を使用し、dimensions = 3072

⑤ 独自のナレッジベースを作成 (起動後)

  1. http://localhost:3782/knowledge にアクセス
  2. 「New Knowledge Base」をクリック → 名前を入力 → PDF/TXT/MD ファイルをアップロード
  3. ターミナルで進捗を監視

ステップ 2: インストール方法を選択

🐳 Docker デプロイ

推奨 — Python/Node.js 設定不要


前提条件DockerDocker Compose

🚀 オプション A: 事前構築済みイメージ(最速)
# すべてのプラットフォームで動作(Docker がアーキテクチャを自動判別)
docker run -d --name deeptutor \
  -p 8001:8001 -p 3782:3782 \
  --env-file .env \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/config:/app/config:ro \
  ghcr.io/hkuds/deeptutor:latest

# Windows PowerShell: $(pwd) の代わりに ${PWD} を使用
🔨 オプション B: ソースコードからビルド
# ビルドして起動(初回実行は約 5-10 分)
docker compose up --build -d

# ログを表示
docker compose logs -f

コマンド

docker compose up -d      # 起動
docker compose logs -f    # ログ
docker compose down       # 停止
docker compose up --build # 再ビルド
docker pull ghcr.io/hkuds/deeptutor:latest  # イメージを更新

開発モード-f docker-compose.dev.yml を追加

💻 手動インストール

開発または非 Docker 環境用


前提条件:Python 3.10+、Node.js 18+

環境を設定

# conda を使用(推奨)
conda create -n deeptutor python=3.10
conda activate deeptutor

# または venv を使用
python -m venv venv
source venv/bin/activate

依存関係をインストール

# ワンクリックインストール(推奨)
python scripts/install_all.py
# または: bash scripts/install_all.sh

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

起動

# Web インターフェースを起動
python scripts/start_web.py

# または CLI のみ
python scripts/start.py

# 停止:Ctrl+C

アクセス URL

サービス URL 説明
フロントエンド http://localhost:3782 メイン Web インターフェース
API ドキュメント http://localhost:8001/docs インタラクティブ API ドキュメント

📄 ライセンス

このプロジェクトは 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