login#

skore.login(*, mode='hub', **kwargs)[source]#

Login to the storage backend.

It configures the credentials used to communicate with the desired storage backend. It only affects the current session: credentials are stored in memory and are not persisted.

It must be called at the top of your script.

Several storage backends are available and their credentials can be configured using the mode parameter. Please note that both can be configured in the same script without side-effect.

Hub mode

It configures the credentials used to communicate with the Skore Hub, persisting projects remotely.

In this mode, you must be already registered to the Skore Hub. Also, we recommend that you set up an API key via https://skore.probabl.ai/account and use it to log in.

Local mode

Otherwise, it configures the credentials used to communicate with the local backend, persisting projects on the user machine.

MLflow mode

For MLflow projects, no explicit authentication step is required by skore and this function is a no-op.

Parameters:
mode{“local”, “hub”, “mlflow”}, default=”hub”

The mode of the storage backend to log in.

**kwargsdict

Extra keyword arguments passed to the login function, depending on its mode.

timeoutint, default=600

The maximum time in second before raising an error when communicating with the hub. Only available when mode="hub".

See also

Project

Refer to the Storing data science artifacts section of the user guide for more details.

On this page

This Page