Metadata-Version: 2.4
Name: vmn-exp-sdk
Version: 0.1.0
Summary: vmn experiment SDK: record runs and metrics from jobs, git-free
Author-email: Pavel Rogovoy <p.rogovoy@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/progovoy/vmn
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: PyYAML>=5.4.1
Requires-Dist: filelock>=3.2.0
Provides-Extra: s3
Requires-Dist: boto3; extra == "s3"
Provides-Extra: sysmetrics
Requires-Dist: psutil>=5.9; extra == "sysmetrics"
Dynamic: license-file

# vmn-exp-sdk

The metrics writer of the [vmn](https://github.com/progovoy/vmn) experiment
platform, for jobs: `start_run()`, `log_metric`/`log_params`/artifacts,
autologging and framework integrations — with no git and no vmn installed.

```sh
pip install vmn-exp-sdk          # add [s3] to record to a bucket
```

```python
from vmn_exp.sdk import start_run

with start_run("my_app") as run:   # VMN_SNAPSHOT_METADATA + VMN_EXPERIMENT_DIR/BUCKET
    run.log_metric("loss", 0.12)
```

Creating runs from a git checkout, the `vmn-exp` CLI and the dashboard live in
[`vmn-exp`](https://pypi.org/project/vmn-exp/). See
[docs/sdk.md](https://github.com/progovoy/vmn/blob/master/docs/sdk.md).
