過去 2 週間にわたり、私は Open AI API を使用してドキュメントを含む新しいファイルを生成するドキュメント生成ツールの開発に取り組んできました。 Python、Click、LangChain ライブラリを使用して構築しました。機能は次のとおりです:
ここから GitHub リポジトリにアクセスできます:
https://github.com/SychAndrii/infusion
Infusion は、ソース コードのドキュメントを生成することで開発者を支援するように設計されたコマンドライン ツールです。ファイル パスを提供することで、Infusion は OpenAI の GPT などの言語モデルを活用し、適切なコメントやドキュメントを挿入してファイルを変更します。このツールは複数のプログラミング言語をサポートしています。
これは、構造化されたコメント (JavaScript/TypeScript の場合は JSDoc、Java の場合は JavaDoc など) や関数やクラスの上に単純なコメントが必要な場合に特に便利です。 Infusion は、変更されたファイルを指定された出力ディレクトリに保存します。
Infusion をローカルにインストールして実行するには、GitHub リポジトリのクローンを作成します。
git clone https://github.com/your-username/infusion.git cd infusion
その後、仮想環境をセットアップし、すべての依存関係をインストールする必要があります。
Windows を使用している場合は、PowerShell を使用して次のコマンドを使用して仮想環境をセットアップします。
./setup/setup.ps1
Mac / Linux を使用している場合は、次のコマンドを使用します:
./setup/setup.sh
仮想環境のセットアップが完了したら、次のコマンドを実行して Infusion ツールを使用できます。
pipenv run infsue [OPTIONS] [FILE_PATHS]...
Infusion を使用するには、次のコマンドを実行します。FILE_PATHS を、処理するソース コード ファイルへのパスに置き換えます。
単一のファイルを処理します:
pipenv run infsue ./path/to/source.py
異なる openAI モデルを使用して単一のファイルを処理します:
pipenv run infsue -m gpt-4o-mini ./path/to/source.py
単一のファイルを処理し、出力フォルダーを指定します:
pipenv run infsue ./path/to/source.py --output my_output_folder
複数のファイルを処理します:
pipenv run infsue ./file1.js ./file2.py
ファイルを 1 つずつ指定せずに複数のファイルを処理します:
pipenv run infsue ./folder/*
複数のファイルを処理し、標準出力に出力する代わりにファイルを保存する出力フォルダーを指定します。
pipenv run infsue ./file1.js ./file2.py --output my_output_folder
このツールのより実践的な使用例については、GitHub リポジトリをご覧ください。私のコードベースの改善点を提案するために問題を投稿していただければ幸いです!
以上がインフュージョン v.0の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。