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

Update setup section (#911)

Browse Source
This commit is contained in:
pollfly 2024-08-28 17:02:57 +03:00 committed by GitHub
parent baefe3ee3b
commit 41104d0841
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/clearml_agent/clearml_agent_setup.md
View File

@ -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.

35
docs/getting_started/ds/ds_first_steps.md
View File

@ -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.<your-domain>]
```
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.<your-domain>]
```
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.<your-domain>]
```
The wizard responds with a configuration and directs to the ClearML Server.
```console
CLEARML Hosts configuration:
Web App: https://app.<your-domain>
API: https://api.<your-domain>