From b010f775bdd72ba6729f5e1e569626692d7b18af Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 10 Oct 2021 10:32:43 +0300 Subject: [PATCH] Add demo server note to README and number instructions (#470) --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 18d5d08d..6d086fb8 100644 --- a/README.md +++ b/README.md @@ -68,26 +68,30 @@ 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)). +1. 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: + > **_ClearML Demo Server:_** ClearML no longer uses the demo server by default. To enable the demo server, set the `CLEARML_NO_DEFAULT_SERVER=0` + > environment variable. Credentials aren't needed, but experiments launched to the demo server are public, so make sure not + > to launch sensitive experiments if using the demo server. -```bash -pip install clearml -``` +1. Install the `clearml` python package: -Connect the ClearML SDK to the server by [creating credentials](https://app.community.clear.ml/profile), then execute the command + ```bash + pip install clearml + ``` + +1. 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 -``` + ```bash + clearml-init + ``` -Add two lines to your code: -```python -from clearml import Task -task = Task.init(project_name='examples', task_name='hello world') -``` +1. Add two lines to your code: + ```python + from clearml import Task + task = Task.init(project_name='examples', task_name='hello world') + ``` You are done, everything your process outputs is now automagically logged into ClearML.