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
- Multiple runs. Simply initialize multiple aimruns using
aimrun.init()
, and track to multiple repositories at once. - 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.
- Sync project-specific (local) repositories to larger (remote) repositories. See
python -m aimrun sync --help
for guidance.
Usage (Recommended)
- Initialize one or more aimruns using
aimrun.init()
- Use
aimrun.track()
to track values. Parse a dictionary. - 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.
- Replace
import wandb
withfrom aimrun import wandb
- Set default repository before init (e.g. right after import)
wandb.set_default_repo('aim://172.3.66.145:53800')
- Supported functions
.init(), .log(), .finish()
Project details
Release history Release notifications | RSS feed
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.6.2.tar.gz
(8.4 kB
view details)
File details
Details for the file aimrun-0.6.2.tar.gz
.
File metadata
- Download URL: aimrun-0.6.2.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 967477356cf18ec949106a4f39e37fca7f3d2c1de87c780bd419b0279d517502 |
|
MD5 | dfa9b9b91bc47792be2a7f0beacb84a8 |
|
BLAKE2b-256 | b4c811128cc2f31546026c39b969b3ed619cab7fdd2db1445e44ece4c7360769 |