注意

此READMEはGPTによる翻訳で生成されました（このプロジェクトのプラグインによって実装されています）、翻訳結果は100%正確ではないため、注意してください。

2023年11月7日: 依存関係をインストールする際は、requirements.txtで指定されたバージョンを選択してください。 インストールコマンド: pip install -r requirements.txt。

<div align=center> GPT 学術最適化 (GPT Academic)</div>

このプロジェクトが気に入った場合は、Starを付けてください。また、便利なショートカットキーまたはプラグインを作成した場合は、プルリクエストを歓迎します！ GPTを使用してこのプロジェクトを任意の言語に翻訳するには、multi_language.pyを読み込んで実行します（実験的な機能）。

注意

1. 強調された プラグイン（ボタン）のみがファイルを読み込むことができることに注意してください。一部のプラグインは、プラグインエリアのドロップダウンメニューにあります。また、新しいプラグインのPRを歓迎し、最優先で対応します。

2. このプロジェクトの各ファイルの機能は、自己分析レポートself_analysis.mdで詳しく説明されています。バージョンが進化するにつれて、関連する関数プラグインをクリックして、プロジェクトの自己分析レポートをGPTで再生成することもできます。よくある質問については、wikiをご覧ください。標準的なインストール方法 | ワンクリックインストールスクリプト | 構成の説明。

3. このプロジェクトは、ChatGLMなどの中国製の大規模言語モデルも互換性があり、試してみることを推奨しています。複数のAPIキーを共存させることができ、設定ファイルにAPI_KEY="openai-key1,openai-key2,azure-key3,api2d-key4"のように記入できます。API_KEYを一時的に変更する必要がある場合は、入力エリアに一時的なAPI_KEYを入力し、Enterキーを押して提出すると有効になります。

• もし出力に数式が含まれている場合、TeX形式とレンダリング形式の両方で表示されます。これにより、コピーと読み取りが容易になります。

• プロジェクトのコードを見るのがめんどくさい？プロジェクト全体をchatgptに広報口頭発表してもらえるよ

• 異なる言語モデルの組み合わせ呼び出し（ChatGLM + OpenAI-GPT3.5 + API2D-GPT4）

インストール

方法I：直接実行（Windows、Linux、またはMacOS）

1. プロジェクトをダウンロード

git clone --depth=1 https://github.com/binary-husky/gpt_academic.git
cd gpt_academic

2. APIキーを設定する

config.pyでAPIキーやその他の設定を設定します。特殊なネットワーク環境の設定方法については、こちらをクリックして確認してください。Wikiページも参照してください。

「プログラムは、config.pyと同じ場所にあるconfig_private.pyという名前のプライベート設定ファイルが存在するかどうかを優先的にチェックし、同じ名前の設定をコピーします。この読み込みロジックを理解できる場合、config.pyの横にconfig_private.pyという名前の新しい設定ファイルを作成し、config.pyの設定を転送（コピー）することを強くお勧めします（変更した設定項目だけをコピーします）。」

「プロジェクトを環境変数で設定することもサポートしています。環境変数の書式は、docker-compose.ymlファイルやWikiページを参考にしてください。設定の優先度は、環境変数 > config_private.py > config.pyの順です。」

3. 依存関係をインストールする

# （オプションI：Pythonに詳しい場合、Python 3.9以上）注：公式のpipソースまたは阿里pipソースを使用し、一時的なソースの変更方法は、python -m pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/です。
python -m pip install -r requirements.txt

# （オプションII：Anacondaを使用する場合）手順は同様です (https://www.bilibili.com/video/BV1rc411W7Dr)：
conda create -n gptac_venv python=3.11    # Anaconda環境を作成
conda activate gptac_venv                 # Anaconda環境をアクティベート
python -m pip install -r requirements.txt # この手順はpipのインストール手順と同じです

【オプションステップ】 清華ChatGLM2/復旦MOSSをバックエンドとしてサポートする場合は、さらに追加の依存関係をインストールする必要があります（前提条件：Pythonに精通していて、PytorchとNVIDIA GPUを使用したことがあり、十分なコンピュータの構成を持っていること）：

# 【オプションステップI】 清華ChatGLM2のサポートを追加する。 清華ChatGLM2に関する注意点： "Call ChatGLM fail 不能正常加载ChatGLM的参数" のエラーが発生した場合、次の手順を参照してください。 1: デフォルトでインストールされているのはtorch+cpu版です。CUDAを使用するにはtorchをアンインストールしてtorch+cuda版を再インストールする必要があります。 2: モデルをロードできない場合は、request_llm/bridge_chatglm.pyのモデル精度を変更できます。AutoTokenizer.from_pretrained("THUDM/chatglm-6b", trust_remote_code=True)をAutoTokenizer.from_pretrained("THUDM/chatglm-6b-int4", trust_remote_code=True)に変更します。
python -m pip install -r request_llms/requirements_chatglm.txt

# 【オプションステップII】 復旦MOSSのサポートを追加する
python -m pip install -r request_llms/requirements_moss.txt
git clone --depth=1 https://github.com/OpenLMLab/MOSS.git request_llms/moss  # このコマンドを実行するときは、プロジェクトのルートパスである必要があります。

# 【オプションステップIII】 RWKV Runnerのサポートを追加する
Wikiを参照してください: https://github.com/binary-husky/gpt_academic/wiki/%E9%80%82%E9%85%8DRWKV-Runner

# 【オプションステップIV】 config.py設定ファイルに、以下のすべてのモデルが含まれていることを確認します。以下のモデルがすべてサポートされています（jittorllmsはDockerのみサポートされています）：
AVAIL_LLM_MODELS = ["gpt-3.5-turbo", "api2d-gpt-3.5-turbo", "gpt-4", "api2d-gpt-4", "chatglm", "moss"] # + ["jittorllms_rwkv", "jittorllms_pangualpha", "jittorllms_llama"]

4. 実行する

python main.py

方法II：Dockerを使用する

0. プロジェクトのフルスケールデプロイ（これは、CUDAとLaTeXを含む大規模なイメージですが、ネットワーク速度が遅いまたはディスク容量が小さい場合はおすすめしません）

# docker-compose.ymlを編集し、スキーム0を残し、その他を削除してから実行する：
docker-compose up

1. ChatGPT + 文心一言 + sparkなどのオンラインモデルのみを含む（ほとんどの人におすすめ）

# docker-compose.ymlを編集し、スキーム1を残し、その他を削除してから実行する：
docker-compose up

P.S. LaTeXプラグインの機能を使用する場合は、Wikiを参照してください。また、LaTeX機能を使用するためには、スキーム4またはスキーム0を直接使用することもできます。

2. ChatGPT + ChatGLM2 + MOSS + LLAMA2 + 通慧千問（Nvidia Dockerに精通している場合）

# docker-compose.ymlを編集し、スキーム2を残し、その他を削除してから実行する：
docker-compose up

方法III：その他のデプロイメントオプション

1. Windowsのワンクリック実行スクリプト。 Python環境に詳しくないWindowsユーザーは、リリースからワンクリック実行スクリプトをダウンロードして、ローカルモデルのないバージョンをインストールできます。 スクリプトの貢献者はoobaboogaです。

2. 第三者のAPI、Azureなど、文心一言、星火などを使用するには、Wikiページを参照してください。

3. クラウドサーバーでのリモートデプロイの回避策ガイドを参照してください。 クラウドサーバーでのリモートデプロイの回避策ガイドwiki

4. その他の新しいデプロイプラットフォームや方法

   • Sealosを使用したワンクリックデプロイ
   • WSL2（Windows Subsystem for Linux）の使用方法については、デプロイwiki-2を参照してください。
   • サブパス（例：http://localhost/subpath）でFastAPIを実行する方法については、FastAPIの実行方法を参照してください。

高度な使用法

I：カスタムショートカットボタンの作成（学術的なショートカットキー）

テキストエディタでcore_functional.pyを開き、次の項目を追加し、プログラムを再起動します。（ボタンが存在する場合、プレフィックスとサフィックスはホット変更に対応しており、プログラムを再起動せずに有効にすることができます。） 例：

"超级英译中"： {
    # プレフィックス、入力の前に追加されます。例えば、要求を記述するために使用されます。翻訳、コードの解説、校正など
    "プレフィックス"： "下記の内容を中国語に翻訳し、専門用語を一つずつマークダウンテーブルで解説してください：\n\n"、

    # サフィックス、入力の後に追加されます。プレフィックスと一緒に使用して、入力内容を引用符で囲むことができます。
    "サフィックス"： ""、
}、

II：関数プラグインのカスタマイズ

自分の望む任意のタスクを実行するために、強力な関数プラグインを作成できます。 このプロジェクトのプラグインの作成とデバッグの難易度は非常に低く、一定のPythonの基礎知識があれば、提供されたテンプレートを参考に自分自身のプラグイン機能を実装することができます。 詳細については、関数プラグインガイドを参照してください。

更新

I：ダイナミック

1. 会話の保存機能。プラグインエリアで Save Current Conversation を呼び出すだけで、現在の会話を読み取り可能で復旧可能なhtmlファイルとして保存できます。 また、プラグインエリア（ドロップダウンメニュー）で Load Conversation History Archive を呼び出すことで、以前の会話を復元できます。 ヒント：ファイルを指定せずに Load Conversation History Archive をクリックすると、履歴のhtmlアーカイブのキャッシュを表示することができます。

2. ⭐Latex/Arxiv論文の翻訳機能⭐

3. ゼロのターミナル（自然言語入力からユーザの意図を理解+他のプラグインを自動的に呼び出す）

• ステップ1：「プラグインのPDF論文の翻訳を呼び出してください、アドレスはhttps://openreview.net/pdf?id=rJl0r3R9KX」と入力します。
• ステップ2：「Zero Terminal」をクリックします。

4. モジュール化された機能設計、シンプルなインターフェイスで強力な機能をサポートする

5. 他のオープンソースプロジェクトの翻訳

6. live2dのデコレーション機能（デフォルトでは無効で、config.pyを変更する必要があります）

7. OpenAI画像生成

8. OpenAIオーディオ解析と要約

9. Latex全体の校正と修正

10. 言語、テーマの切り替え

II：バージョン:

• version 3.70（todo）: AutoGenプラグインのテーマを最適化し、一連の派生プラグインを設計する
• version 3.60: AutoGenを次世代プラグインの基盤として導入
• version 3.57: GLM3、星火v3、文心一言v4をサポート、ローカルモデルの並行バグを修正
• version 3.56: 基本機能ボタンを動的に追加、新しい報告書PDF集約ページ
• version 3.55: フロントエンドのデザインを再構築し、浮動ウィンドウとメニューバーを導入
• version 3.54: 新しい動的コードインタプリタ（Code Interpreter）の追加（未完成）
• version 3.53: 異なるテーマを動的に選択できるように、安定性の向上と複数ユーザの競合問題の解決
• version 3.50: 自然言語でこのプロジェクトのすべての関数プラグインを呼び出すことができるようになりました（ゼロのターミナル）プラグインの分類をサポートし、UIを改善し、新しいテーマを設計
• version 3.49: Baidu Qianfanプラットフォームと文心一言をサポート
• version 3.48: Alibaba DAMO Academy Tongyi Qianwen、Shanghai AI-Lab Shusheng、Xunfei Xinghuoをサポート
• version 3.46: 完全なオートモードのリアルタイム音声対話をサポート
• version 3.45: カスタムChatGLM2ファインチューニングモデルをサポート
• version 3.44: 公式にAzureをサポート、UIの使いやすさを最適化
• version 3.4: +arxiv論文の翻訳、latex論文の校閲機能
• version 3.3: +インターネット情報の総合機能
• version 3.2: 関数プラグインがさらに多くのパラメータインターフェースをサポート（会話の保存機能、任意の言語のコードの解釈、同時に任意のLLMの組み合わせを尋ねる）
• version 3.1: 複数のgptモデルに同時に質問できるようにサポートされました！ api2dをサポートし、複数のapikeyの負荷分散をサポートしました
• version 3.0: chatglmと他の小さなllmのサポート
• version 2.6: プラグインの構造を再構築し、対話性を高め、より多くのプラグインを追加しました
• version 2.5: 自己更新、ソースコード全体の要約時のテキストの長さ、トークンのオーバーフローの問題を解決しました
• version 2.4: (1)新しいPDF全文翻訳機能を追加しました。(2)入力エリアの位置を切り替えるための新しい機能を追加しました。(3)垂直レイアウトオプションを追加しました。(4)マルチスレッド関数プラグインを最適化しました。
• version 2.3: マルチスレッドの対話を強化しました
• version 2.2: 関数プラグインのホットリロードをサポート
• version 2.1: 折りたたみ式のレイアウト
• version 2.0: モジュール化された関数プラグインの導入
• version 1.0: 基本機能

GPT Academic開発者QQグループ：610599535

-既知の問題 - 一部のブラウザ翻訳プラグインがこのソフトウェアのフロントエンドの実行を妨げる - 公式Gradioには互換性の問題があり、必ずrequirement.txtを使用してGradioをインストールしてください

III：テーマ

THEMEオプション（config.py）を変更することで、テーマを変更できます

1. Chuanhu-Small-and-Beautiful リンク

IV：本プロジェクトの開発ブランチ

1. masterブランチ：メインブランチ、安定版
2. frontierブランチ：開発ブランチ、テスト版

V：参考と学習

コードの中には、他の優れたプロジェクトのデザインを参考にしたものが多く含まれています。順序は問いません：

# 清華ChatGLM2-6B:
https://github.com/THUDM/ChatGLM2-6B

# 清華JittorLLMs:
https://github.com/Jittor/JittorLLMs

# ChatPaper:
https://github.com/kaixindelele/ChatPaper

# Edge-GPT:
https://github.com/acheong08/EdgeGPT

# ChuanhuChatGPT:
https://github.com/GaiZhenbiao/ChuanhuChatGPT



# Oobaboogaワンクリックインストーラー：
https://github.com/oobabooga/one-click-installers

# その他：
https://github.com/gradio-app/gradio
https://github.com/fghrsh/live2d_demo