From 41104d084107941f27ecdcb8206df8f307d6711f Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 28 Aug 2024 17:02:57 +0300 Subject: [PATCH] Update setup section (#911) --- docs/clearml_agent/clearml_agent_setup.md | 6 ++++ docs/getting_started/ds/ds_first_steps.md | 35 ++++++----------------- 2 files changed, 14 insertions(+), 27 deletions(-) diff --git a/docs/clearml_agent/clearml_agent_setup.md b/docs/clearml_agent/clearml_agent_setup.md index 96f6937e..e01a0d5b 100644 --- a/docs/clearml_agent/clearml_agent_setup.md +++ b/docs/clearml_agent/clearml_agent_setup.md @@ -72,6 +72,12 @@ it can't do that when running from a virtual environment. Credentials verified! ``` +1. Input the default output URI. Model checkpoints (snapshots) and task artifacts will be stored in this output location. + + ``` + Default Output URI (used to automatically store models and artifacts): (N)one/ClearML (S)erver/(C)ustom [None] + ``` + 1. Enter your Git username and password. Leave blank for SSH key authentication or when only using public repositories. This is needed for cloning repositories by the agent. diff --git a/docs/getting_started/ds/ds_first_steps.md b/docs/getting_started/ds/ds_first_steps.md index fb998a71..62d2ae52 100644 --- a/docs/getting_started/ds/ds_first_steps.md +++ b/docs/getting_started/ds/ds_first_steps.md @@ -52,11 +52,12 @@ pip install clearml 1. The setup wizard prompts for ClearML credentials. ```console - Please create new clearml credentials through the settings page in your `clearml-server` web app, - or create a free account at https://app.clear.ml/settings/webapp-configuration - - In the settings > workspace page, press "Create new credentials", then press "Copy to clipboard". - Paste copied configuration here: + Please create new clearml credentials through the settings page in your `clearml-server` web app (e.g. http://localhost:8080//settings/workspace-configuration), + or create a free account at https://app.clear.ml/settings/workspace-configuration + + In the settings page, press "Create new credentials", then press "Copy to clipboard". + + Paste copied configuration here: ``` 1. Get ClearML credentials. Open the ClearML Web UI in a browser. On the [**SETTINGS > WORKSPACE**](https://app.clear.ml/settings/workspace-configuration) @@ -66,30 +67,10 @@ pip install clearml hover). 1. At the command prompt `Paste copied configuration here:`, copy and paste the ClearML credentials. - The setup wizard confirms the credentials. + The setup wizard verifies the credentials. ```console Detected credentials key="********************" secret="*******" - ``` - -1. Enter the ClearML Server web server URL, or press **Enter** to accept the default which is detected from the - credentials. - - ```console - WEB Host configured to: [https://app.] - ``` - -1. Enter the ClearML Server API server URL, or press **Enter** to accept the default value which is based on the previous response: - ```console - API Host configured to: [https://api.] - ``` - -1. Enter the ClearML Server file server URL, or press **Enter** to accept the default value which is based on the previous response: - ```console - File Store Host configured to: [files.] - ``` - - The wizard responds with a configuration and directs to the ClearML Server. - ```console + CLEARML Hosts configuration: Web App: https://app. API: https://api.