Add clearml-init wizard description (#196)

This commit is contained in:
pollfly 2022-03-07 11:43:59 +02:00 committed by GitHub
parent cfd24ba62b
commit ae81fff61a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 68 additions and 11 deletions

View File

@ -47,11 +47,11 @@ by setting [configuration options](../configs/clearml_conf.md).
ClearML SDK setup process
Please create new clearml credentials through the profile page in your clearml web app (e.g. http://localhost:8080/profile)
Or with the free hosted service at https://app.community.clear.ml/profile
In the profile page, press "Create new credentials", then press "Copy to clipboard".
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
Paste copied configuration here:
In the settings > workspace 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** page, click
**Create new credentials** **>** **Copy to clipboard**.

View File

@ -8,16 +8,73 @@ title: First Steps
First, [sign up for free](https://app.clear.ml)
Install the clearml python package:
Install the `clearml` python package:
```bash
pip install clearml
```
Connect your computer to the server by [creating credentials](https://app.clear.ml/settings/workspace-configuration), then run the below and follow the setup instructions:
```bash
clearml-init
```
## Connect ClearML SDK to the Server
1. Execute the following command to run the ClearML setup wizard:
```bash
clearml-init
```
If the setup wizard's response indicates that a configuration file already exists, follow the instructions in
[here](../../deploying_clearml/clearml_config_for_clearml_server.md#add-clearml-to-a-configuration-file). The wizard
does not edit or overwrite existing configuration files.
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:
```
1. Get ClearML credentials. Open the ClearML Web UI in a browser. On the [**SETTINGS > WORKSPACE**](https://app.clear.ml/settings/workspace-configuration)
page, click **Create new credentials** **>** **Copy to clipboard**.
1. At the command prompt `Paste copied configuration here:`, copy and paste the ClearML credentials.
The setup wizard confirms 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>
File Store: https://files.<your-domain>
Verifying credentials ...
Credentials verified!
New configuration stored in /home/<username>/clearml.conf
CLEARML setup completed successfully.
```
Now you can integrate ClearML into your code!
## Auto-log Experiment
@ -33,7 +90,7 @@ from clearml import Task
```
:::note Full Automatic Logging
To ensure full automatic logging, it is recommended to import the ClearML package at the top of your entry script.
To ensure full automatic logging, it is recommended to import the `clearml` package at the top of your entry script.
:::
Then initialize the Task object in your `main()` function, or the beginning of the script.
@ -50,7 +107,7 @@ The console should return the following output:
```
ClearML Task: created new task id=1ca59ef1f86d44bd81cb517d529d9e5a
2021-07-25 13:59:09
ClearML results page: https://app.community.clear.ml/projects/4043a1657f374e9298649c6ba72ad233/experiments/1ca59ef1f86d44bd81cb517d529d9e5a/output/log
ClearML results page: https://app.clear.ml/projects/4043a1657f374e9298649c6ba72ad233/experiments/1ca59ef1f86d44bd81cb517d529d9e5a/output/log
2021-07-25 13:59:16
```