Metadata-Version: 2.1
Name: trailml
Version: 1.0.2
Summary: Trail ML library
Author-email: Trail ML <python@trail-ml.com>
Project-URL: Homepage, https://trail-ml.com
Project-URL: Bug Tracker, https://github.com/trail-ml/bugtracker/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: gql
Requires-Dist: aiohttp
Requires-Dist: mlflow
Requires-Dist: pyrebase4
Requires-Dist: PyYAML
Requires-Dist: requests-toolbelt (==0.10.1)

# Trail

Trail brings more transparency to your ML experiments.
Start by using MLflow to track experiments and follow the steps below.

# Installation

Install Trail from PyPI via ```pip install trailml```

# Get started

```python
import mlflow
from trail import Trail

with mlflow.start_run() as run:
    with Trail('myProjectAlias'):
      ...your training code...
```

# User configuration

Primary path: ```trailconfig.yml```  
Secondary path: ```~/.config/trail.yml```

```yaml
username: <YOUR_USERNAME>
password: <YOUR_PASSWORD>
projects:
  myProjectAlias:
    id: 1234ABC
    parentExperimentId: ABCD123
```

The project alias is used to reference project configurations at runtime and is only applied locally.

## Required options:
- username
- password

Project-specific options are required if not overwritten at runtime.
