ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-02-07 05:18:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README getting started instructions (#466)

Browse Source
This commit is contained in:
pollfly 2021-10-07 09:29:47 +03:00 committed by GitHub
parent 1f82b0c401
commit 6b30d06971
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -67,10 +67,22 @@ Instrumenting these components is the **ClearML-server**, see [Self-Hosting](htt
#### [Start using ClearML](https://clear.ml/docs/latest/docs/getting_started/ds/ds_first_steps)
First, sign up for free to the [ClearML Hosted Service](https://app.community.clear.ml) (alternatively, you can set up your own server, see [here](https://clear.ml/docs/latest/docs/deploying_clearml/clearml_server)).
Install the `clearml` python package:
```bash
pip install clearml
```
Connect the ClearML SDK to the server by [creating credentials](https://app.community.clear.ml/profile), then execute the command
below and follow the instructions:
```bash
clearml-init
```
Add two lines to your code:
```python
from clearml import Task
@ -78,7 +90,8 @@ task = Task.init(project_name='examples', task_name='hello world')
```
You are done, everything your process outputs is now automagically logged into ClearML.
<br>Next step automation! **Learn more on ClearML two clicks automation [here](https://clear.ml/docs/latest/docs/getting_started/mlops/mlops_first_steps)**
Next step, automation! **Learn more about ClearML's two-click automation [here](https://clear.ml/docs/latest/docs/getting_started/mlops/mlops_first_steps)**.
## ClearML Architecture