From 6b30d06971c41ff613b754da471508c250872b70 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 7 Oct 2021 09:29:47 +0300 Subject: [PATCH] Update README getting started instructions (#466) --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 271be695..18d5d08d 100644 --- a/README.md +++ b/README.md @@ -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. -
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