This project has been archived by its maintainers, and is no longer receiving any updates.
Arcee
The OptScale ML profiling tool by Hystax
Arcee is a tool that hepls you to integrate ML tasks with OptScale. This tool can automatically collect executor metadata from cloud and process stats.
Installation
Arcee requires python 3.7+ to run.
pip install optscale-arcee
Usage
First of all you need to import and init arcee in your code:
import optscale_arcee as arcee
# init arcee using context manager syntax
with arcee.init('token', 'model_key'):
# some code
To use custom endpoint and enable\disable ssl checks (supports using self-signed ssl certificates):
with arcee.init('token', 'model_key', endpoint_url='https://my.custom.endpoint:443/arcee/v2', ssl=False):
# some code
Alternatively arcee can be initialized via function call. However manual finish is required:
arcee.init('token', 'model_key')
# some code
arcee.finish()
Or in error case:
arcee.init('token', 'model_key')
# some code
arcee.error()
To send stats:
arcee.send({"loss": 2.0012, "iter": 2, "epoch": 1})
(key should be string, value - int or float, multiple values can be sent)
To add tags to model run (key, value):
arcee.tag("project", "torchvision demo")
To add milestones:
arcee.milestone("Download test data")
To add stages:
arcee.stage("calculation")
To add hyperparameters:
arcee.hyperparam("epochs", 5)
Logging datasets
To log a dataset, use the dataset method with the following parameter:
- path (str): the path of the dataset.
arcee.dataset("dataset_path")
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file optscale_arcee-0.1.37.tar.gz.
File metadata
- Download URL: optscale_arcee-0.1.37.tar.gz
- Upload date:
- Size: 19.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4991a8dad042bf206c32c7389649a04ad1e735b7f07d9c7a2185ac281c6706d
|
|
| MD5 |
0cb8d832fdf7066ac3d060d84105fbab
|
|
| BLAKE2b-256 |
7be57810fbab09c5e8070d72723530c8fec0263bd6956eaa7bf58455f3053b6c
|