commentator

Komentator

oleh Emery Berger

Komentator memanfaatkan model bahasa besar untuk menambahkan komentar penjelasan tingkat tinggi, dokumen, dan tipe ke kode Python.

Penggunaan

Agar berfungsi, Komentator harus terhubung ke layanan AI lokal, akun OpenAI, atau akun Amazon Web Services.

Layanan AI lokal (Ollama)

Komentator sekarang dapat menggunakan layanan AI yang diinstal secara lokal; saat ini mendukung Ollama. Untuk menggunakan Ollama, instal dan atur variabel lingkungan USE_OLLAMA :

  export USE_OLLAMA=1

OpenAI

Akun Anda harus memiliki saldo positif agar dapat berfungsi (periksa saldo OpenAI Anda). Dapatkan kunci OpenAI di sini.

Komentator saat ini menggunakan GPT-4 secara default, dan kembali ke GPT-3.5-turbo jika terjadi kesalahan permintaan. Agar model terbaru dan terbaik (GPT-4) dapat berfungsi, Anda harus membeli kredit minimal $1 (jika akun API Anda dibuat sebelum 13 Agustus 2023) atau $0,50 (jika Anda memiliki akun API yang lebih baru).

Setelah Anda memiliki kunci API, tetapkan kunci tersebut sebagai variabel lingkungan bernama OPENAI_API_KEY .

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

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

Batuan Dasar Amazon

Komentator kini mendukung Amazon Bedrock, menggunakan model Claude. Untuk menggunakan Bedrock, Anda perlu mengatur tiga variabel lingkungan.

 # 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

Jika Anda belum memiliki kunci akses, Anda dapat membuatnya dengan mengubah tautan ini dengan nama pengguna dan wilayah Anda sendiri:

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

Anda juga perlu meminta akses ke Claude (ubah wilayah sesuai kebutuhan):

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

Komentator akan secara otomatis memilih layanan AI mana yang akan digunakan (lokal, OpenAI, atau AWS Bedrock) ketika mendeteksi bahwa variabel lingkungan yang sesuai telah ditetapkan.

Komentator mengambil jalur ke file Python dan parameter bahasa opsional. Jika bahasa ditentukan, Komentator menerjemahkan setiap dokumen dan komentar dalam kode ke bahasa yang ditentukan. Bahasa defaultnya adalah bahasa Inggris.

Instalasi

Untuk menginstal Komentator, Anda dapat menggunakan pip:

 $ pip install python-commentator

Contoh

Misalkan Anda memiliki file bernama example.py dengan kode berikut:

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

Jalankan Komentator pada file ini untuk menambahkan komentar dan mengetik anotasi:

 $ commentator example.py

Kode yang dihasilkan mungkin:

 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

Perhatikan bahwa Komentator telah menambahkan docstring dan anotasi tipe.