mirror of
https://github.com/clearml/clearml-helm-charts
synced 2025-01-31 09:06:48 +00:00
9fd65b68f7
* Added: reference to Apache2 license * Changed: bump up version * Fixed: License reference
84 lines
3.7 KiB
Markdown
84 lines
3.7 KiB
Markdown
# ClearML Helm Charts Library for Kubernetes
|
|
|
|
## Auto-Magical Experiment Manager & Version Control for AI
|
|
|
|
Helm charts provided by [Allegro AI](https://clear.ml), ready to launch on Kubernetes using [Kubernetes Helm](https://github.com/helm/helm).
|
|
|
|
## Introduction
|
|
|
|
The **clearml-server** is the backend service infrastructure for [ClearML](https://github.com/allegroai/clearml).
|
|
It allows multiple users to collaborate and manage their experiments.
|
|
By default, **ClearML** is set up to work with the **ClearML** demo server, which is open to anyone and resets periodically.
|
|
In order to host your own server, you will need to install **clearml-server** and point **ClearML** to it.
|
|
|
|
**clearml-server** contains the following components:
|
|
|
|
* The **ClearML** Web-App, a single-page UI for experiment management and browsing
|
|
* RESTful API for:
|
|
* Documenting and logging experiment information, statistics and results
|
|
* Querying experiments history, logs and results
|
|
* Locally-hosted file server for storing images and models making them easily accessible using the Web-App
|
|
|
|
Use this repository to deploy **clearml-server** on Kubernetes clusters.
|
|
|
|
## Provided in this repository
|
|
|
|
### [All around Helm Chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml)
|
|
|
|
## Who We Are
|
|
|
|
ClearML is supported by the team behind *allegro.ai*,
|
|
where we build deep learning pipelines and infrastructure for enterprise companies.
|
|
|
|
We built ClearML 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 ClearML.
|
|
|
|
We promise to always be backwardly compatible, making sure all your logs, data and pipelines
|
|
will always upgrade with you.
|
|
|
|
## License
|
|
|
|
Apache License, Version 2.0, (see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) for more information)
|
|
|
|
## Requirements
|
|
|
|
### Setup a Kubernetes Cluster
|
|
|
|
For setting up Kubernetes on various platforms refer to the Kubernetes [getting started guide](http://kubernetes.io/docs/getting-started-guides/).
|
|
|
|
### Setup a single node LOCAL Kubernetes on laptop/desktop
|
|
|
|
For setting up Kubernetes on your laptop/desktop we suggest [kind](https://kind.sigs.k8s.io).
|
|
|
|
### Install Helm
|
|
|
|
Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.
|
|
|
|
To install Helm, refer to the [Helm install guide](https://github.com/helm/helm#install) and ensure that the `helm` binary is in the `PATH` of your shell.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
$ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
|
|
$ helm repo update
|
|
$ helm search repo allegroai
|
|
$ helm install <release-name> allegroai/<chart>
|
|
```
|
|
|
|
## Documentation, Community & Support
|
|
|
|
More information in the [official documentation](https://allegro.ai/clearml/docs) and [on YouTube](https://www.youtube.com/c/ClearML).
|
|
|
|
If you have any questions: post on our [Slack Channel](https://join.slack.com/t/clearml/shared_invite/zt-c0t13pty-aVUZZW1TSSSg2vyIGVPBhg), or tag your questions on [stackoverflow](https://stackoverflow.com/questions/tagged/clearml) with '**[clearml](https://stackoverflow.com/questions/tagged/clearml)**' tag (*previously [trains](https://stackoverflow.com/questions/tagged/trains) tag*).
|
|
|
|
For feature requests or bug reports, please use [GitHub issues](https://github.com/allegroai/clearml-helm-charts/issues).
|
|
|
|
Additionally, you can always find us at *clearml@allegro.ai*
|
|
|
|
## Contributing
|
|
|
|
**PRs are always welcomed** :heart: See more details in the ClearML [Guidelines for Contributing](https://github.com/allegroai/clearml-helm-charts/blob/main/CONTRIBUTING.md).
|
|
|
|
|
|
_May the force (and the goddess of learning rates) be with you!_
|