Skip to main content

Python library for streamlined tracking and management of AI training processes.

Project description

SwanLab Library

GitHub release

English |简体中文

SwanLab is the next-generation machine learning experiment management and visualization tool released by the SwanHub, designed to facilitate effective collaboration in machine learning training.

SwanLab provides streamlined APIs that make it easy to track machine learning metrics and record configurations. Additionally, SwanLab provides a visual dashboard for the most intuitive way to monitor, analyze, and compare your training.

For specific guidance on SwanLab's features, please refer to the User Guide.

Currently, SwanLab is undergoing rapid iterations and will continue to add new features.

Installation

This repository is tested on Python 3.8+.

SwanLab can be installed using pip as follows:

pip install swanlab

Quick tour

Let's simulate a simple machine learning training process, using swanlab.init to initialize the experiment and record configuration information, and using swanlab.log to track key metrics (in this example, it's loss and acc):

import swanlab
import time
import random

lr = 0.01
epochs = 20

# Initialize the experiment and record configuration information
swanlab.init(
	  description="This is a sample experiment for machine learning training.",
    config={
        "learning_rate": lr,
        "epochs": epochs,
    },
)

# Simulate a machine learning training process
for epoch in range(2, epochs):
    acc = 1 - 2**-epoch - random.random() / epoch - offset
    loss = 2**-epoch + random.random() / epoch + offset
    # Track key metrics
    swanlab.log({"loss": loss, "accuracy": acc})
    time.sleep(0.1)

During the program running, a swanlog folder will be generated in the directory to record your training data.

If you want to visualize your experiment, open the terminal and enter the root directory (no need to enter the swanlog folder), and run the following command:

swanlab watch

If you see the following output, it means that the experimental board is running successfully:

[SwanLab-INFO]:        SwanLab Experiment Dashboard ready in 375ms

                        ➜  Local:   http://127.0.0.1:5092

Access http://127.0.0.1:5092 at this time to enter the experiment dashboard and browse your experimental results:

swanlab-dashboard-1

License

Apache 2.0 License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

test_sw_12241-0.0.1.tar.gz (887.2 kB view hashes)

Uploaded Source

Built Distribution

test_sw_12241-0.0.1-py3-none-any.whl (547.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page