Skip to main content

A simple way of integrating aim into MLOps frameworks.

Project description

aimrun

A simple interface for integrating aim into MLOps frameworks.

Installation

pip install aimrun

Features

  1. Multiple runs. Simply initialize multiple aimruns using aimrun.init(), and track to multiple repositories at once.
  2. No need for a main-process wrapper. You do not need to make sure that only the main-process calls aimrun functions - we take care of that for you.
  3. Sync project-specific (local) repositories to larger (remote) repositories. See python -m aimrun sync --help for guidance.

Usage (Recommended)

  1. Initialize one or more aimruns using aimrun.init()
  2. Use aimrun.track() to track values. Parse a dictionary.
  3. Use aimrun.close() to finalize the experiments.

Example usage

import aimrun

# initalize 
aimrun.init(repo='aim://172.3.66.145:53800', experiment='my_experiment', description='description of run' args={"arg": 1}) # args=vars(args) if you use argsparse

# track 
aimrun.track({"value_0": A, "value_1": B})
# or 
aimrun.track(A, name="value_0")

# close 
aimrun.close() 

Synchronizing on-going runs

aimrun.init(repo=".", sync_repo='aim://172.3.66.145:53800', sync_args={"repeat": 60}, experiment='my_experiment', description='description of run' args={"arg": 1})

This starts a thread that incrementally synchronizes the current on-going run to a remote repo while using the current directory as the local repository.

To profit from mass updates (faster synchronization), consider installing an improved aim version:

pip install git+https://github.com/schneiderkamplab/aim

Drop-in replacement Wandb (Experimental)

We experimentally offer aimrun as a drop-in replacement for wandb, making a seamless integration in your framework even easier.

  1. Replaceimport wandb with from aimrun import wandb
  2. Set default repository before init (e.g. right after import) wandb.set_default_repo('aim://172.3.66.145:53800')
  3. Supported functions .init(), .log(), .finish()

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

aimrun-0.9.6.tar.gz (9.9 kB view details)

Uploaded Source

File details

Details for the file aimrun-0.9.6.tar.gz.

File metadata

  • Download URL: aimrun-0.9.6.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for aimrun-0.9.6.tar.gz
Algorithm Hash digest
SHA256 e428cbf86e295dc44a604f510ceec1ed9041866a22e602cf6ab43ddc0552db58
MD5 2a45c4d13c1709da19d612ad50d8ade9
BLAKE2b-256 012662799e1d7507c21743edd5e1466ab7d1503783ae80f8e9d7496cf6d8d7ed

See more details on using hashes here.

Supported by

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