swanlab sync

swanlab sync [options] [logdir]

Option	Description
-k, --api-key	API key for authentication. If not specified, the default API key from the environment will be used. If specified, this API key will be used for login but won't be saved.
-h, --host	The host address for syncing logs. If not specified, the default host (https://swanlab.cn) will be used.
-w, --workspace	The workspace for syncing logs. If not specified, the default workspace will be used.
-p, --project	The project for syncing logs. If not specified, the default project will be used.

Introduction

Sync local logs to SwanLab cloud or private deployment.

Command Line Examples

Locate the log directory you want to upload to the cloud (by default, it's the run- prefixed directory under swanlog), then execute the command:

swanlab sync ./swanlog/run-xxx

INFO

By default, logs will be synced to the project recorded in the log files, which is the project set when running the experiment.
If you want to sync to a different project, you can use the -p option to specify the project.

If you see the following output, it indicates a successful sync:

Python Code Example

import swanlab

swanlab.login(api_key="Your API Key")

swanlab.sync(
    dir_path="./swanlog/run-xxx",
    workspace="swanlab",
    project_name="sync_test",
)