login
less than a minute
Set up W&B login credentials.
login(
anonymous: Optional[Literal['must', 'allow', 'never']] = None,
key: Optional[str] = None,
relogin: Optional[bool] = None,
host: Optional[str] = None,
force: Optional[bool] = None,
timeout: Optional[int] = None,
verify: bool = (False)
) -> bool
By default, this will only store credentials locally without
verifying them with the W&B server. To verify credentials, pass
verify=True
.
Args | |
---|---|
anonymous |
(string, optional) Can be “must”, “allow”, or “never”. If set to “must”, always log a user in anonymously. If set to “allow”, only create an anonymous user if the user isn’t already logged in. If set to “never”, never log a user anonymously. Default set to “never”. |
key |
(string, optional) The API key to use. |
relogin |
(bool, optional) If true, will re-prompt for API key. |
host |
(string, optional) The host to connect to. |
force |
(bool, optional) If true, will force a relogin. |
timeout |
(int, optional) Number of seconds to wait for user input. |
verify |
(bool) Verify the credentials with the W&B server. |
Returns | |
---|---|
bool |
if key is configured |
Raises | |
---|---|
AuthenticationError - if api_key fails verification with the server UsageError - if api_key cannot be configured and no tty |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.