commentator

ผู้วิจารณ์

โดยเอเมรี เบอร์เกอร์

Commentator ใช้ประโยชน์จากโมเดลภาษาขนาดใหญ่เพื่อเพิ่มความคิดเห็นเชิงอธิบาย เอกสาร และประเภท ในระดับสูงให้กับโค้ด Python

การใช้งาน

เพื่อให้ทำงานได้ Commentator จะต้องเชื่อมต่อกับบริการ AI ในพื้นที่ บัญชี OpenAI หรือบัญชี Amazon Web Services

บริการ AI ในพื้นที่ (Ollama)

ขณะนี้ Commentator สามารถใช้บริการ AI ที่ติดตั้งในเครื่องได้แล้ว ปัจจุบันรองรับ Ollama หากต้องการใช้ Ollama ให้ติดตั้งและตั้งค่าตัวแปรสภาพแวดล้อม USE_OLLAMA :

  export USE_OLLAMA=1

OpenAI

บัญชีของคุณจะต้องมียอดคงเหลือเป็นบวกจึงจะใช้งานได้ (ตรวจสอบยอดคงเหลือ OpenAI ของคุณ) รับคีย์ OpenAI ที่นี่

ขณะนี้ Commentator ตั้งค่าเริ่มต้นเป็น GPT-4 และเปลี่ยนกลับไปเป็น GPT-3.5-turbo หากคำขอเกิดข้อผิดพลาด เพื่อให้โมเดลใหม่ล่าสุดและดีที่สุด (GPT-4) ใช้งานได้ คุณจะต้องซื้อเครดิตอย่างน้อย 1 ดอลลาร์ (หากบัญชี API ของคุณสร้างขึ้นก่อนวันที่ 13 สิงหาคม 2023) หรือ 0.50 ดอลลาร์ (หากคุณมีบัญชี API ที่ใหม่กว่า)

เมื่อคุณมีคีย์ API แล้ว ให้ตั้งค่าเป็นตัวแปรสภาพแวดล้อมที่เรียกว่า OPENAI_API_KEY

 # On Linux/MacOS:
export OPENAI_API_KEY= < your-api-key >

# On Windows:
$env :OPENAI_API_KEY= < your-api-key >

อเมซอน ข้อเท็จจริง

ขณะนี้ Commentator รองรับ Amazon Bedrock โดยใช้โมเดล Claude หากต้องการใช้ Bedrock คุณต้องตั้งค่าตัวแปรสภาพแวดล้อมสามรายการ

 # On Linux/MacOS:
export AWS_ACCESS_KEY_ID= < your-access-key >
export AWS_SECRET_ACCESS_KEY= < your-secret-key >
export AWS_REGION_NAME=us-west-2

หากคุณยังไม่มีรหัสการเข้าถึง คุณควรจะสามารถสร้างได้โดยแก้ไขลิงก์นี้ด้วยชื่อผู้ใช้และภูมิภาคของคุณเอง:

 https://us-east-1.console.aws.amazon.com/iam/home?region=us-east-1#/users/details/YOUR_USER_NAME?section=security_credentials

คุณต้องขอเข้าถึง Claude ด้วย (เปลี่ยนภูมิภาคตามต้องการ):

 https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/modelaccess

Commentator จะเลือกบริการ AI ที่จะใช้โดยอัตโนมัติ (ภายใน, OpenAI หรือ AWS Bedrock) เมื่อตรวจพบว่ามีการตั้งค่าตัวแปรสภาพแวดล้อมที่เหมาะสม

Commentator ใช้เส้นทางไปยังไฟล์ Python และพารามิเตอร์ภาษาเสริม หากมีการระบุภาษา Commentator จะแปลแต่ละเอกสารและความคิดเห็นในโค้ดเป็นภาษาที่ระบุ ภาษาเริ่มต้นคือภาษาอังกฤษ

การติดตั้ง

หากต้องการติดตั้ง Commentator คุณสามารถใช้ pip:

 $ pip install python-commentator

ตัวอย่าง

สมมติว่าคุณมีไฟล์ชื่อ example.py โดยมีโค้ดต่อไปนี้:

 def absolutely(n):
    if n < 0:
        return -n
    else:
        return n

เรียกใช้ Commentator บนไฟล์นี้เพื่อเพิ่มความคิดเห็นและพิมพ์คำอธิบายประกอบ:

 $ commentator example.py

รหัสผลลัพธ์อาจเป็น:

 def absolutely(n: int) -> int:
    """
    Return the absolute value of a number.
    
    Args:
    - n (int): the number whose absolute value we want to find
    
    Returns:
    - int: the absolute value of n
    """
    if n < 0:
        # If n is negative
        # Return the negative version of n (i.e. its absolute value)
        return -n
    else:
        # Otherwise (if n is non-negative)
        # Return n as-is (it already is its absolute value)
        return n

โปรดทราบว่า Commentator ได้เพิ่ม docstring และพิมพ์คำอธิบายประกอบ