함수 wandb.login()
W&B에 로그인합니다. 인증이 필요한 대부분의 W&B 메서드는 암시적으로 로그인할 수 있으므로 일반적으로 이 함수를 사용할 필요가 없습니다. 이는wandb login CLI에 대응하는 프로그래밍 방식의 기능입니다.
이 함수는 세션의 전역 자격 증명을 업데이트하며(이 호출 이후 현재 Python 프로세스의 모든 wandb 사용에 영향을 미침), 경우에 따라 .netrc 파일도 업데이트합니다.
WANDB_IDENTITY_TOKEN_FILE 환경 변수 등을 통해 ID 토큰 파일이 설정된 경우, 해당 파일이 세션(페더레이션된 ID)에 사용되며 API 키는 읽거나 저장되지 않습니다.
그렇지 않고 명시적인 API 키가 제공된 경우, 해당 키가 사용되고 시스템 .netrc 파일에 기록됩니다. 키가 제공되지 않았지만 세션이 이미 인증된 경우, 세션 키가 확인에 사용되며(verify가 True인 경우) .netrc 파일은 업데이트되지 않습니다.
위의 어느 것에도 해당하지 않는 경우, 다음 중 첫 번째 항목에서 API 키를 가져옵니다.
- WANDB_API_KEY 환경 변수
- 시스템 또는 Workspace 설정 파일의 api_key 설정
- .netrc 파일(~/.netrc, ~/_netrc 또는 NETRC 환경 변수에 지정된 경로)
- 대화형 프롬프트(사용 가능하고
prompt가 True인 경우)
인수
str | None
사용할 API 키입니다.
bool | None
true이면 .netrc, 환경 변수 등을 읽지 않고 대화형 프롬프트에서 API 키를 입력받습니다.
str | None
연결할 W&B 서버 URL입니다.
bool | None
true이면 대화형 프롬프트에서 오프라인 모드를 선택할 수 없습니다.
int | None
대화형 프롬프트에서 사용자 입력을 기다리는 시간(초)입니다. 비대화형 환경에서 대화형 프롬프트가 잘못 표시될 때를 대비한 안전장치로 사용할 수 있습니다.
bool
W&B 서버에서 자격 증명을 확인하고, 실패하면 AuthenticationError를 발생시킵니다. API 키와 ID 토큰 모두에 적용됩니다.
str | None
분석을 위해 URL 로그인 요청에 사용할 referrer입니다.
bool
설정된 API 키가 없을 때 대화형으로 API 키를 요청할지 여부입니다. False이면 False를 반환하며 세션과 설정은 변경되지 않습니다.
DoNotSet
설명이 제공되지 않았습니다.
반환값
이 호출 이후 세션에 자격 증명이 있으면 True를 반환합니다.예외
AuthenticationError: 자격 증명이 서버에서 확인되지 않은 경우.UsageError: 자격 증명이 설정되지 않았고,prompt가 True이며 API 키를 요청할 터미널이 없는 경우.