gpt code commenter

gpt-コード-コメンター

コードを LLM (Chat-GPT) に渡すことで、コードを自動的に文書化します。

• 単純なプロンプトを使用して、LLM に、その言語の規則に従って、指定されたコードに注釈を付けるように依頼します。

• NOTE - このツールは依然として手動による監視が必要です。同じ場所に出力し直す場合は、変更をコミットする前に結果を確認してください。デフォルトでは、ツールは stdout または新しいディレクトリに出力します。

• セットアップ手順については、以下のSetupセクションを参照してください。

使用法

注: スクリプトは最上位のvia-chat-gptフォルダー内から実行する必要があります。

単一のファイルにコメントを付けるには:

 pipenv run python via-chat-gpt  [--out-dir 
]

ディレクトリ内のファイルにコメントを付けるには (再帰的ではありません):

 pipenv run python via-chat-gpt  [--out-dir 
] [--exclude ]

注: 同じファイルに書き戻すには、同じディレクトリを指すように--out-dirを指定するだけです。ただし、変更をコミットする前に結果を確認してください。

例

生成されたドキュメントの例 (pdoc 経由で S3 に公開): コーンスネークのドキュメント。

入力：

 import json

def read_from_json_file(path_to_json, encoding='utf-8'):
    with open(path_to_json, encoding=encoding) as f:
        data = json.load(f)
        return data

def write_to_json_file(dict, file_path, encoding='utf-8', indent=2):
    json_object = json.dumps(dict, indent=indent)

    with open(file_path, "w", encoding=encoding) as outfile:
        outfile.write(json_object)

出力：

 """
This Python file contains functions for reading from and writing to a JSON file. The `read_from_json_file` function reads JSON data from a file, and the `write_to_json_file` function writes JSON data to a file.
"""

import json

def read_from_json_file(path_to_json, encoding='utf-8'):
    """
    Function to read JSON data from a file.

    Args:
    path_to_json (str): The path to the JSON file.
    encoding (str): The encoding of the file. Default is 'utf-8'.

    Returns:
    dict: The JSON data read from the file.
    """
    with open(path_to_json, encoding=encoding) as f:
        data = json.load(f)  # Load JSON data from the file
        return data

def write_to_json_file(dict, file_path, encoding='utf-8', indent=2):
    """
    Function to write JSON data to a file.

    Args:
    dict (dict): The dictionary containing JSON data to be written.
    file_path (str): The path to the output JSON file.
    encoding (str): The encoding of the file. Default is 'utf-8'.
    indent (int): The number of spaces to indent the JSON data. Default is 2.
    """
    json_object = json.dumps(dict, indent=indent)  # Convert dictionary to JSON string with specified indent

    with open(file_path, "w", encoding=encoding) as outfile:
        outfile.write(json_object)  # Write JSON data to the file

設定

[推奨] openai (リモート LLM) の場合:

 cd via-chat-gpt

ユニックス:

pip install pipenv
export PYTHONPATH= " ${PYTHONPATH} :. "
pipenv install

Windows:

pip install pipenv
set PYTHONPATH= " %PYTHONPATH% " ; .
pipenv install

OpenAI キーを使用して環境変数を設定します。

 export OPENAI_API_KEY= " xxx "

それをシェル初期化スクリプト ( ~/.zprofileなど) に追加します。

現在の端子にロード:

 source ~ /.zprofile

OpenAIをテストする

(チャット GPT 経由で CD)

test-openai.sh

または

pipenv run python via-chat-gpt ../test-resources/util_json.py

phi2 の場合 (llama-cpp-python 経由のローカル LLM) [UNIX または Windows] [インストールが簡単]

• 結果は問題ありません (Chat-GPT の方がはるかに良い結果が得られます)

• via-phi2-the-bloke README を参照してください

phi2 の場合 (トランスフォーマーを介したローカル LLM) [Windows ではなく UNIX] [インストールがさらに困難]

• このバージョンの TODO 応答処理を修正

• via-phi2 README を参照してください。