gpt code commenter

gpt-code-commenter

บันทึกรหัสโดยอัตโนมัติโดยส่งต่อไปยัง 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): เอกสาร cornsnake

ป้อนข้อมูล:

 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

หน้าต่าง:

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

ตั้งค่าตัวแปรสภาพแวดล้อมด้วยคีย์ OpenAI ของคุณ:

 export OPENAI_API_KEY= " xxx "

เพิ่มสิ่งนั้นลงในสคริปต์เริ่มต้นเชลล์ของคุณ ( ~/.zprofile หรือคล้ายกัน)

โหลดในเทอร์มินัลปัจจุบัน:

 source ~ /.zprofile

ทดสอบ OpenAI

(ซีดีผ่านแชท-gpt)

test-openai.sh

หรือ

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

สำหรับ phi2 (LLM ท้องถิ่นผ่าน llama-cpp-python) [UNIX หรือ Windows] [ติดตั้งง่ายกว่า]

• ผลลัพธ์ก็โอเคเท่านั้น (Chat-GPT ให้ผลลัพธ์ที่ดีกว่ามาก)

• ดูผ่าน phi2-the-bloke README

สำหรับ phi2 (LLM ท้องถิ่นผ่านหม้อแปลง) [UNIX ไม่ใช่ Windows] [ติดตั้งยากกว่า]

• สิ่งที่ต้องทำแก้ไขการจัดการการตอบกลับสำหรับเวอร์ชันนี้

• ดู via-phi2 README