login()

GitHub 소스

​

function login

login(
    key: 'str | None' = None,
    relogin: 'bool | None' = None,
    host: 'str | None' = None,
    force: 'bool | None' = None,
    timeout: 'int | None' = None,
    verify: 'bool' = False,
    referrer: 'str | None' = None,
    anonymous: 'DoNotSet' = <object object at 0x109045240>
) → bool

W&B에 로그인합니다.

일반적으로 이 함수를 직접 사용할 필요는 없습니다. 인증이 필요한 대부분의 W&B 메서드는 암시적으로 로그인을 수행할 수 있습니다. 이 함수는 wandb login CLI의 프로그래밍 인터페이스에 해당합니다.

이 함수는 세션의 전역 자격 증명을 업데이트하며(이 호출 이후 현재 Python 프로세스에서의 모든 wandb 사용에 영향을 줌), 필요에 따라 .netrc 파일도 업데이트합니다.

WANDB_IDENTITY_TOKEN_FILE 환경 변수 등으로 identity_token_file 설정이 지정된 경우, 이 함수는 아무 작업도 수행하지 않습니다(no-op).

위 경우가 아니고 명시적인 API 키가 제공되면 해당 키를 사용하고 시스템 .netrc 파일에 기록합니다. 키가 제공되지 않았지만 세션이 이미 인증된 상태라면, 세션 키를 검증(verify가 True인 경우)하는 데 사용하고 .netrc 파일은 업데이트하지 않습니다.

위의 어느 경우에도 해당하지 않으면, 다음 순서에서 처음으로 발견되는 위치에서 API 키를 가져옵니다.

• WANDB_API_KEY 환경 변수
• 시스템 또는 워크스페이스 설정 파일의 api_key 설정
• .netrc 파일(~/.netrc, ~/_netrc 또는 NETRC 환경 변수로 지정된 경로)
• 대화형 프롬프트(가능한 경우)

Args:

• key: 사용할 API 키.
• relogin: true인 경우, .netrc, 환경 변수 등을 읽지 않고 대화형 프롬프트에서 API 키를 가져옵니다.
• host: 연결할 W&B 서버 URL.
• force: true인 경우, 대화형 프롬프트에서 오프라인 모드를 선택할 수 없게 합니다.
• timeout: 대화형 프롬프트에서 사용자 입력을 대기할 시간(초)입니다. 이는 비대화형 환경에서 대화형 프롬프트가 잘못 표시되는 경우를 대비한 안전장치로 사용할 수 있습니다.
• verify: W&B 서버에 자격 증명을 검증하고, 실패 시 AuthenticationError를 발생시킵니다.
• referrer: 분석용으로, URL 로그인 요청에 사용할 referrer.

Returns:

• bool: key가 설정되었는지 여부.

Raises:

• AuthenticationError: api_key가 서버 검증에 실패한 경우.
• UsageError: api_key를 설정할 수 없고 tty도 없는 경우.