mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Edit first steps (#832)
This commit is contained in:
pollfly
GitHub
parent
e63b8dd4ca
commit
8d223a6f6f
@ -1,128 +0,0 @@
|
||||
---
|
||||
title: Configuring ClearML for Your ClearML Server
|
||||
---
|
||||
|
||||
:::important
|
||||
This documentation page applies to deploying your own open source ClearML Server. It does not apply to ClearML Hosted Service users.
|
||||
:::
|
||||
|
||||
The ClearML **configuration file** that will be initialized will contain the host URLs of the ClearML Server, and
|
||||
ClearML credentials, allowing the code to integrate with the server. Later, ClearML can be tailored to fit requirements
|
||||
by setting [configuration options](../configs/clearml_conf.md).
|
||||
|
||||
**To configure ClearML for your ClearML Server:**
|
||||
1. If not installed already, install `clearml` (see [install](../getting_started/ds/ds_first_steps.md))
|
||||
1. In a terminal session, run the ClearML setup wizard.
|
||||
```
|
||||
clearml-init
|
||||
```
|
||||
|
||||
<Collapsible type="info" title="Learn about creating multiple ClearML configuration files">
|
||||
|
||||
Additional ClearML configuration files can be created, for example, to use inside Docker containers when executing
|
||||
a Task.
|
||||
|
||||
Use the `--file` option for `clearml-init`.
|
||||
|
||||
clearml-init --file MyOtherClearML.conf
|
||||
|
||||
and then specify it using the ``CLEARML_CONFIG_FILE`` environment variable inside the container:
|
||||
|
||||
CLEARML_CONFIG_FILE = MyOtherClearML.conf
|
||||
|
||||
For more information about running experiments inside Docker containers, see [ClearML Agent Deployment](../clearml_agent.md#deployment)
|
||||
and [ClearML Agent Reference](../clearml_agent/clearml_agent_ref.md).
|
||||
|
||||
</Collapsible>
|
||||
|
||||
If the setup wizard's response indicates that a configuration file already exists, follow the instructions in
|
||||
[here](#add-clearml-to-a-configuration-file). The wizard does not edit or overwrite existing configuration files.
|
||||
|
||||
1. The setup wizard prompts for ClearML credentials.
|
||||
|
||||
|
||||
ClearML SDK setup process
|
||||
|
||||
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** 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.
|
||||
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
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:
|
||||
|
||||
File Store Host configured to: [files.<your-domain>]
|
||||
|
||||
The wizard responds with a configuration and directs to the ClearML Server.
|
||||
|
||||
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.
|
||||
|
||||
<br/>
|
||||
The configuration file's location depends upon the operating system:
|
||||
|
||||
* Linux - `~/clearml.conf`
|
||||
* Mac - `$HOME/clearml.conf`
|
||||
* Windows - `\User\<username>\clearml.conf`
|
||||
|
||||
## Add ClearML to a Configuration File
|
||||
|
||||
The setup wizard may indicate that a configuration file already exists. For example, if a **ClearML Agent** was previously
|
||||
configured, then a configuration file was created. The wizard does not edit or overwrite existing configuration files.
|
||||
|
||||
The host URLs for the ClearML Server are required:
|
||||
|
||||
* ClearML Server web server
|
||||
* ClearML Server API server
|
||||
* ClearML Server file server
|
||||
|
||||
These may be localhost, the domain, or a subdomain of the domain.
|
||||
|
||||
**To add ClearML settings to an existing ClearML configuration file:**
|
||||
|
||||
1. Open the ClearML configuration file for editing. Depending upon the operating system, it is:
|
||||
|
||||
* Linux - `~/clearml.conf`
|
||||
* macOS - `$HOME/clearml.conf`
|
||||
* Windows - `\User\<username>\clearml.conf`
|
||||
|
||||
1. In the `sdk.development` section, add the logging of environment variables option (see ``log_os_environments`` in an
|
||||
[example configuration file](https://github.com/allegroai/clearml/blob/master/docs/clearml.conf#L178)).
|
||||
|
||||
```editorconfig
|
||||
# Log specific environment variables. OS environments are enlisted in the "Environment" section
|
||||
# of the Hyper-Parameters.
|
||||
# multiple selected variables are supported including the suffix '*'.
|
||||
# For example: "AWS_*" will log any OS environment variable starting with 'AWS_'.
|
||||
# This value can be overwritten with os environment variable CLEARML_LOG_ENVIRONMENT="[AWS_*, CUDA_VERSION]"
|
||||
# Example: log_os_environments: ["AWS_*", "CUDA_VERSION"]
|
||||
log_os_environments: []
|
||||
```
|
||||
|
||||
1. Save the ClearML configuration file. ClearML is now configured for the ClearML Server.
|
||||
@ -49,7 +49,7 @@ authentication, subdomains, and load balancers, and use any of its many configur
|
||||
1. Optionally, [configure ClearML Server](clearml_server_config.md) for additional features, including subdomains and load balancers,
|
||||
web login authentication, and the non-responsive task watchdog.
|
||||
|
||||
1. [Configure ClearML for ClearML Server](clearml_config_for_clearml_server.md)
|
||||
1. [Connect the ClearML SDK to the ClearML Server](../getting_started/ds/ds_first_steps.md)
|
||||
|
||||
## Updating
|
||||
|
||||
|
||||
@ -146,4 +146,5 @@ The following section contains a list of AMI Image IDs per-region for the latest
|
||||
|
||||
## Next Step
|
||||
|
||||
* [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).
|
||||
To keep track of your experiments and/or data, the `clearml` package needs to communicate with your server.
|
||||
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).
|
||||
|
||||
@ -6,7 +6,8 @@ Deploy ClearML Server on the Google Cloud Platform (GCP) using one of the pre-bu
|
||||
provides custom images for each released version of ClearML Server. For a list of the pre-built custom images, see
|
||||
[ClearML Server GCP Custom Image](#clearml-server-gcp-custom-image).
|
||||
|
||||
After deploying ClearML Server, configure the **ClearML Python Package** for it, see [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).
|
||||
To keep track of your experiments and/or data, the `clearml` package needs to communicate with the server you have deployed.
|
||||
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).
|
||||
|
||||
:::info
|
||||
In order for `clearml` to work with a ClearML Server on GCP, set `CLEARML_API_DEFAULT_REQ_METHOD=PUT` or
|
||||
@ -143,6 +144,8 @@ The following section contains a list of Custom Image URLs (exported in differen
|
||||
- v1.0.1 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-1.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-1.tar.gz)
|
||||
- v1.0.0 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-0.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-0.tar.gz)
|
||||
- v0.17.0 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-0-17-0.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-0-17-0.tar.gz)
|
||||
|
||||
## Next Step
|
||||
|
||||
* [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).
|
||||
To keep track of your experiments and/or data, the `clearml` package needs to communicate with your server.
|
||||
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).
|
||||
|
||||
@ -31,4 +31,5 @@ instructions in the [Security](clearml_server_security.md) page.
|
||||
|
||||
## Next Step
|
||||
|
||||
* [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).
|
||||
To keep track of your experiments and/or data, the `clearml` package needs to communicate with your server.
|
||||
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).
|
||||
@ -189,4 +189,5 @@ If needed, restore data and configuration by doing the following:
|
||||
sudo chown -R $(whoami):staff /opt/clearml
|
||||
## Next Step
|
||||
|
||||
* [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).
|
||||
To keep track of your experiments and/or data, the `clearml` package needs to communicate with your server.
|
||||
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).
|
||||
@ -80,4 +80,5 @@ After deploying ClearML Server, the services expose the following node ports:
|
||||
|
||||
## Next Step
|
||||
|
||||
* [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).
|
||||
To keep track of your experiments and/or data, the `clearml` package needs to communicate with your server.
|
||||
For instruction to connect the ClearML SDK to the server, see [Getting Started: First Steps](../getting_started/ds/ds_first_steps.md).
|
||||
@ -21,11 +21,30 @@ pip install clearml
|
||||
```bash
|
||||
clearml-init
|
||||
```
|
||||
|
||||
:::note
|
||||
The wizard does not edit or overwrite existing configuration files, so the above command will not work if a `clearml.conf`
|
||||
file already exists.
|
||||
:::
|
||||
|
||||
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.
|
||||
<Collapsible type="info" title="Learn about creating multiple ClearML configuration files">
|
||||
|
||||
Additional ClearML configuration files can be created, for example, to use inside Docker containers when executing
|
||||
a Task.
|
||||
|
||||
Use the `--file` option for `clearml-init`.
|
||||
|
||||
clearml-init --file MyOtherClearML.conf
|
||||
|
||||
and then specify it using the ``CLEARML_CONFIG_FILE`` environment variable inside the container:
|
||||
|
||||
CLEARML_CONFIG_FILE = MyOtherClearML.conf
|
||||
|
||||
For more information about running experiments inside Docker containers, see [ClearML Agent Deployment](../../clearml_agent.md#deployment)
|
||||
and [ClearML Agent Reference](../../clearml_agent/clearml_agent_ref.md).
|
||||
|
||||
</Collapsible>
|
||||
|
||||
1. The setup wizard prompts for ClearML credentials.
|
||||
|
||||
```console
|
||||
|
||||
@ -167,7 +167,7 @@ module.exports = {
|
||||
'deploying_clearml/upgrade_server_kubernetes_helm',
|
||||
'deploying_clearml/clearml_server_es7_migration', 'deploying_clearml/clearml_server_mongo44_migration']
|
||||
},
|
||||
'deploying_clearml/clearml_server_config', 'deploying_clearml/clearml_config_for_clearml_server', 'deploying_clearml/clearml_server_security'
|
||||
'deploying_clearml/clearml_server_config', 'deploying_clearml/clearml_server_security'
|
||||
]},
|
||||
|
||||
//'Comments': ['Notes'],
|
||||
|
||||
Loading…
Reference in New Issue
Block a user