commentator

시사 해설자

에머리 버거

Commentator는 대규모 언어 모델을 활용하여 Python 코드에 고급 설명 주석, 독스트링 및 유형을 추가합니다.

용법

작동하려면 Commentator를 로컬 AI 서비스, OpenAI 계정 또는 Amazon Web Services 계정에 연결해야 합니다.

로컬 AI 서비스(Ollama)

해설자는 이제 로컬에 설치된 AI 서비스를 사용할 수 있습니다. 현재 Ollama를 지원합니다. Ollama를 사용하려면 Ollama를 설치하고 환경 변수 USE_OLLAMA 설정하세요.

  export USE_OLLAMA=1

오픈AI

이 기능이 작동하려면 귀하의 계정에 잔액이 있어야 합니다 (OpenAI 잔액 확인). 여기에서 OpenAI 키를 받으세요.

해설자는 현재 기본적으로 GPT-4로 설정되어 있으며, 요청 오류가 발생하면 GPT-3.5-turbo로 대체됩니다. 최신 최고의 모델(GPT-4)이 작동하려면 최소 $1의 크레딧(2023년 8월 13일 이전에 API 계정이 생성된 경우) 또는 $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는 이제 Claude 모델을 사용하여 Amazon Bedrock을 지원합니다. 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

해설자는 적절한 환경 변수가 설정되었음을 감지하면 사용할 AI 서비스(로컬, OpenAI 또는 AWS Bedrock)를 자동으로 선택합니다.

해설자는 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가 독스트링과 유형 주석을 추가했다는 점에 유의하세요.