commentator

المعلق

بواسطة ايمري بيرجر

يستفيد برنامج Commentator من نماذج اللغة الكبيرة لإضافة تعليقات توضيحية وسلاسل مستندات وأنواع عالية المستوى إلى كود Python.

الاستخدام

للعمل، يحتاج Commentator إلى الاتصال بخدمة AI محلية، أو حساب OpenAI، أو حساب Amazon Web Services.

خدمة الذكاء الاصطناعي المحلية (Ollama)

يمكن للمعلق الآن استخدام خدمة الذكاء الاصطناعي المثبتة محليًا؛ وهو يدعم حاليا أولاما. لاستخدام Ollama، قم بتثبيته وضبط متغير البيئة USE_OLLAMA :

  export USE_OLLAMA=1

OpenAI

سيحتاج حسابك إلى رصيد إيجابي حتى يعمل هذا (تحقق من رصيد OpenAI الخاص بك). احصل على مفتاح OpenAI هنا.

يتم تعيين المعلق الافتراضي حاليًا على GPT-4، ويعود إلى GPT-3.5-turbo في حالة حدوث خطأ في الطلب. لكي يعمل النموذج الأحدث والأفضل (GPT-4)، يتعين عليك شراء ما لا يقل عن دولار واحد من الأرصدة (إذا تم إنشاء حساب 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

سيحدد المعلق تلقائيًا خدمة الذكاء الاصطناعي التي سيتم استخدامها (محلية، أو OpenAI، أو AWS Bedrock) عندما يكتشف أنه تم تعيين متغيرات البيئة المناسبة.

يأخذ المعلق مسارًا إلى ملف Python ومعلمة لغة اختيارية. إذا تم تحديد اللغة، فسيقوم Commentator بترجمة كل سلسلة مستندات وتعليق في الكود إلى اللغة المحددة. اللغة الافتراضية هي الإنجليزية.

تثبيت

لتثبيت Commentator، يمكنك استخدام النقطة:

 $ 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

لاحظ أن المعلق أضاف سلسلة مستندات واكتب التعليقات التوضيحية.