mirror of
https://github.com/clearml/clearml
synced 2025-01-31 17:17:00 +00:00
164 lines
9.3 KiB
Markdown
164 lines
9.3 KiB
Markdown
# Allegro Trains
|
||
## Auto-Magical Experiment Manager, Version Control and ML-Ops for AI
|
||
|
||
## :confetti_ball: Now with Full ML/DL DevOps - See [TRAINS AGENT](https://github.com/allegroai/trains-agent) and [Services](https://github.com/allegroai/trains-server#trains-agent-services--)
|
||
## :station: [Documentation is here!](https://allegro.ai/docs) `wubba lubba dub dub` and a [Slack Channel](https://join.slack.com/t/allegroai-trains/shared_invite/enQtOTQyMTI1MzQxMzE4LTY5NTUxOTY1NmQ1MzQ5MjRhMGRhZmM4ODE5NTNjMTg2NTBlZGQzZGVkMWU3ZDg1MGE1MjQxNDEzMWU2NmVjZmY) :train2:
|
||
## Features: [AWS autoscaler wizard](https://allegro.ai/docs/examples/services/aws_autoscaler/aws_autoscaler/) :robot: [Hyper-Parameter Optimization](https://allegro.ai/docs/examples/optimization/hyper-parameter-optimization/examples_hyperparam_opt/) and :electric_plug: [Pipeline Controllers](https://allegro.ai/docs/examples/pipeline/pipeline_controller/)
|
||
|
||
"Because it’s a jungle out there"
|
||
|
||
[](https://img.shields.io/github/license/allegroai/trains.svg)
|
||
[](https://img.shields.io/pypi/pyversions/trains.svg)
|
||
[](https://img.shields.io/pypi/v/trains.svg)
|
||
[](https://pypi.python.org/pypi/trains/)
|
||
[](https://optuna.org)
|
||
[](https://join.slack.com/t/allegroai-trains/shared_invite/zt-c0t13pty-aVUZZW1TSSSg2vyIGVPBhg)
|
||
|
||
### :point_right: Help improve Trains by filling our 2-min [user survey](https://allegro.ai/lp/trains-user-survey/)
|
||
|
||
Trains is our solution to a problem we share with countless other researchers and developers in the machine
|
||
learning/deep learning universe: Training production-grade deep learning models is a glorious but messy process.
|
||
Trains tracks and controls the process by associating code version control, research projects,
|
||
performance metrics, and model provenance.
|
||
|
||
We designed Trains specifically to require effortless integration so that teams can preserve their existing methods
|
||
and practices. Use it on a daily basis to boost collaboration and visibility, or use it to automatically collect
|
||
your experimentation logs, outputs, and data to one centralized server.
|
||
|
||
**We have a demo server up and running at [https://demoapp.trains.allegro.ai](https://demoapp.trains.allegro.ai).**
|
||
|
||
### :steam_locomotive: [Getting Started Tutorial](https://allegro.ai/blog/setting-up-allegro-ai-platform/) :rocket:
|
||
|
||
**You can try out Trains and [test your code](#integrate-trains), with no additional setup.**
|
||
|
||
<a href="https://demoapp.trains.allegro.ai"><img src="https://github.com/allegroai/trains/blob/master/docs/webapp_screenshots.gif?raw=true" width="100%"></a>
|
||
|
||
## Trains Automatically Logs Everything
|
||
**With only two lines of code, this is what you are getting:**
|
||
|
||
* Git repository, branch, commit id, entry point and local git diff
|
||
* Python environment (including specific packages & versions)
|
||
* stdout and stderr
|
||
* Resource Monitoring (CPU/GPU utilization, temperature, IO, network, etc.)
|
||
* Hyper-parameters
|
||
* ArgParser for command line parameters with currently used values
|
||
* Explicit parameters dictionary
|
||
* Tensorflow Defines (absl-py)
|
||
* Initial model weights file
|
||
* Model snapshots (With optional automatic upload to central storage: Shared folder, S3, GS, Azure, Http)
|
||
* Artifacts log & store (Shared folder, S3, GS, Azure, Http)
|
||
* Tensorboard/TensorboardX scalars, metrics, histograms, **images, audio and video**
|
||
* [Matplotlib & Seaborn](https://github.com/allegroai/trains/tree/master/examples/frameworks/matplotlib)
|
||
* Supported frameworks: [PyTorch](https://github.com/allegroai/trains/tree/master/examples/frameworks/pytorch), [Tensorflow](https://github.com/allegroai/trains/tree/master/examples/frameworks/tensorflow), [Keras](https://github.com/allegroai/trains/tree/master/examples/frameworks/keras), [AutoKeras](https://github.com/allegroai/trains/tree/master/examples/frameworks/autokeras), [XGBoost](https://github.com/allegroai/trains/tree/master/examples/frameworks/xgboost) and [Scikit-Learn](https://github.com/allegroai/trains/tree/master/examples/frameworks/scikit-learn) (MxNet is coming soon)
|
||
* Seamless integration (including version control) with **Jupyter Notebook**
|
||
and [*PyCharm* remote debugging](https://github.com/allegroai/trains-pycharm-plugin)
|
||
|
||
**Additionally, log data explicitly using [Trains Explicit Logging](https://allegro.ai/docs/examples/reporting/).**
|
||
|
||
## Using Trains <a name="using-trains"></a>
|
||
|
||
Trains is a two part solution:
|
||
|
||
1. Trains [python package](https://pypi.org/project/trains/) auto-magically connects with your code
|
||
|
||
**Trains requires only two lines of code for full integration.**
|
||
|
||
To connect your code with Trains:
|
||
|
||
- Install Trains <a name="integrate-trains"></a>
|
||
|
||
pip install trains
|
||
<details>
|
||
<summary>Add optional cloud storage support (S3/GoogleStorage/Azure):</summary>
|
||
|
||
```bash
|
||
pip install trains[s3]
|
||
pip install trains[gs]
|
||
pip install trains[azure]
|
||
```
|
||
|
||
</details>
|
||
|
||
- Add the following lines to your code
|
||
|
||
from trains import Task
|
||
task = Task.init(project_name="my project", task_name="my task")
|
||
|
||
* If project_name is not provided, the repository name will be used instead
|
||
* If task_name (experiment) is not provided, the current filename will be used instead
|
||
|
||
- Run your code. When Trains connects to the server, a link is printed. For example
|
||
|
||
Trains Results page:
|
||
https://demoapp.trains.allegro.ai/projects/76e5e2d45e914f52880621fe64601e85/experiments/241f06ae0f5c4b27b8ce8b64890ce152/output/log
|
||
|
||
- Open the link and view your experiment parameters, model and tensorboard metrics
|
||
|
||
**See examples [here](https://allegro.ai/docs/examples/examples_overview/)**
|
||
|
||
2. [Trains Server](https://github.com/allegroai/trains-server) for logging, querying, control and UI ([Web-App](https://github.com/allegroai/trains-web))
|
||
|
||
**We already have a demo server up and running for you at [https://demoapp.trains.allegro.ai](https://demoapp.trains.allegro.ai).**
|
||
|
||
**You can try out Trains without the need to install your own *trains-server*, just add the two lines of code, and it will automatically connect to the Trains demo-server.**
|
||
|
||
*Note that the demo server resets every 24 hours and all of the logged data is deleted.*
|
||
|
||
When you are ready to use your own Trains server, go ahead and [install *trains-server*](https://github.com/allegroai/trains-server).
|
||
|
||
<img src="https://github.com/allegroai/trains/blob/master/docs/system_diagram.png?raw=true" width="50%">
|
||
|
||
|
||
## Configuring Your Own Trains server <a name="configuration"></a>
|
||
|
||
1. Install and run *trains-server* (see [Installing the Trains Server](https://github.com/allegroai/trains-server))
|
||
|
||
2. Run the initial configuration wizard for your Trains installation and follow the instructions to setup Trains package
|
||
(http://**_trains-server-ip_**:__port__ and user credentials)
|
||
|
||
trains-init
|
||
|
||
After installing and configuring, you can access your configuration file at `~/trains.conf`
|
||
|
||
Sample configuration file available [here](https://github.com/allegroai/trains/blob/master/docs/trains.conf).
|
||
|
||
|
||
## Who We Are
|
||
|
||
Trains is supported by the same team behind *allegro.ai*,
|
||
where we build deep learning pipelines and infrastructure for enterprise companies.
|
||
|
||
We built Trains to track and control the glorious but messy process of training production-grade deep learning models.
|
||
We are committed to vigorously supporting and expanding the capabilities of Trains.
|
||
|
||
## Why Are We Releasing Trains?
|
||
|
||
We believe Trains is ground-breaking. We wish to establish new standards of experiment management in
|
||
deep-learning and ML. Only the greater community can help us do that.
|
||
|
||
We promise to always be backwardly compatible. If you start working with Trains today,
|
||
even though this project is currently in the beta stage, your logs and data will always upgrade with you.
|
||
|
||
## License
|
||
|
||
Apache License, Version 2.0 (see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0.html) for more information)
|
||
|
||
## Documentation, Community & Support
|
||
|
||
More information in the [official documentation](https://allegro.ai/docs) and [on YouTube](https://www.youtube.com/c/AllegroAI).
|
||
|
||
For examples and use cases, check the [examples folder](https://github.com/allegroai/trains/tree/master/examples) and [corresponding documentation](https://allegro.ai/docs/examples/examples_overview/).
|
||
|
||
If you have any questions: post on our [Slack Channel](https://join.slack.com/t/allegroai-trains/shared_invite/enQtOTQyMTI1MzQxMzE4LTY5NTUxOTY1NmQ1MzQ5MjRhMGRhZmM4ODE5NTNjMTg2NTBlZGQzZGVkMWU3ZDg1MGE1MjQxNDEzMWU2NmVjZmY), or tag your questions on [stackoverflow](https://stackoverflow.com/questions/tagged/trains) with '**trains**' tag.
|
||
|
||
For feature requests or bug reports, please use [GitHub issues](https://github.com/allegroai/trains/issues).
|
||
|
||
Additionally, you can always find us at *trains@allegro.ai*
|
||
|
||
## Contributing
|
||
|
||
See the Trains [Guidelines for Contributing](https://github.com/allegroai/trains/blob/master/docs/contributing.md).
|
||
|
||
|
||
_May the force (and the goddess of learning rates) be with you!_
|