mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Update Docusaurus (#855)
This commit is contained in:
pollfly
GitHub
parent
f52a139c34
commit
d166467a32
@ -253,7 +253,7 @@ clearml-session --continue-session <session_id> --store-workspace ~/workspace
|
||||
| `--version`| Display the clearml-session utility version| N/A|
|
||||
| `--vscode-extensions` |Install additional VSCode extensions and VSCode python extensions (example: `ms-python.python,ms-python.black-formatter,ms-python.pylint,ms-python.flake8`)|`none`|
|
||||
| `--vscode-server` | Install VSCode on interactive session | `true` |
|
||||
| `--vscode-version` | Set VSCode server (code-server) version, as well as VSCode python extension version <vscode:python-ext> (example: "3.7.4:2020.10.332292344")| `4.14.1:2023.12.0`|
|
||||
| `--vscode-version` | Set VSCode server (code-server) version, as well as VSCode python extension version `<vscode:python-ext>` (example: "3.7.4:2020.10.332292344")| `4.14.1:2023.12.0`|
|
||||
| `--yes`, `-y`| Automatic yes to prompts; assume "yes" as answer to all prompts and run non-interactively |N/A|
|
||||
|
||||
</div>
|
||||
|
||||
@ -712,7 +712,7 @@ To limit the number of simultaneous tasks run in services mode, pass the maximum
|
||||
|
||||
Launch a service task like any other task, by enqueuing it to the appropriate queue.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Do not enqueue training or inference tasks into the services queue. They will put an unnecessary load on the server.
|
||||
:::
|
||||
|
||||
@ -799,7 +799,7 @@ Override worker schedules by:
|
||||
|
||||
Set a schedule for a worker from the command line when running `clearml-agent`. Two properties enable setting working hours:
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Use only one of these properties
|
||||
:::
|
||||
|
||||
@ -828,7 +828,7 @@ For example:
|
||||
|
||||
Set a schedule for a worker using configuration file options. The options are:
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Use only one of these properties
|
||||
:::
|
||||
|
||||
@ -845,7 +845,7 @@ For example, set a worker's schedule from 5 PM to 8 PM on Sunday through Tuesday
|
||||
|
||||
Runtime properties override the command line uptime / downtime properties. The runtime properties are:
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Use only one of these properties
|
||||
:::
|
||||
|
||||
@ -861,13 +861,15 @@ endpoint, as follows:
|
||||
|
||||
For example, to force a worker on for 24 hours:
|
||||
|
||||
curl --user <key>:<secret> --header "Content-Type: application/json" --data '{"worker":"<worker_id>","runtime_properties":[{"key": "force", "value": "on", "expiry": 86400}]}' http://<api-server-hostname-or-ip>:8008/workers.set_runtime_properties
|
||||
```
|
||||
curl --user <key>:<secret> --header "Content-Type: application/json" --data '{"worker":"<worker_id>","runtime_properties":[{"key": "force", "value": "on", "expiry": 86400}]}' http://<api-server-hostname-or-ip>:8008/workers.set_runtime_properties
|
||||
```
|
||||
|
||||
### Overriding Worker Schedules Using Queue Tags
|
||||
|
||||
Queue tags override command line and runtime properties. The queue tags are the following:
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Use only one of these properties
|
||||
:::
|
||||
|
||||
|
||||
@ -255,7 +255,7 @@ will be deleted.
|
||||
|
||||
If a dataset is a parent to a dataset(s), you must pass `--force` to delete it.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Deleting a parent dataset may cause child datasets to lose data!
|
||||
:::
|
||||
|
||||
|
||||
@ -302,7 +302,7 @@ case, all matching datasets will be deleted.
|
||||
|
||||
If a dataset is a parent to a dataset(s), you must pass `force=True` in order to delete it.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Deleting a parent dataset may cause child datasets to lose data!
|
||||
:::
|
||||
|
||||
|
||||
@ -573,7 +573,7 @@ the `offline_mode` argument to `True`:
|
||||
|
||||
* Before running a task, set `CLEARML_OFFLINE_MODE=1`
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Offline mode only works with tasks created using [`Task.init()`](../references/sdk/task.md#taskinit) and not with those created
|
||||
using [`Task.create()`](../references/sdk/task.md#taskcreate).
|
||||
:::
|
||||
@ -820,7 +820,7 @@ task.set_parameters({'Args/epochs':7, 'lr': 0.5})
|
||||
task.set_parameter(name='decay',value=0.001)
|
||||
```
|
||||
|
||||
:::caution Overwriting Parameters
|
||||
:::warning Overwriting Parameters
|
||||
`Task.set_parameters()` replaces any existing hyperparameters in the task.
|
||||
:::
|
||||
|
||||
|
||||
@ -116,7 +116,7 @@ in either case).
|
||||
|
||||
* Set to `true` to allow passing host environments into docker container with Task's docker container arguments. For example: `"-e HOST_NAME=$HOST_NAME"`.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Use with care! This might introduce security risks by allowing access to keys/secret on the host machine.
|
||||
:::
|
||||
|
||||
@ -736,7 +736,7 @@ Dictionary of configuration options for the ClearML Server API, web, and file se
|
||||
|
||||
* The URL of your ClearML file server. For example, `https://files.MyDomain.com`.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
You must use a secure protocol with ``api.web_server``, ``api.files_server``, and ``api.api_server``. Use `https`, not `http`.
|
||||
:::
|
||||
|
||||
@ -747,7 +747,7 @@ You must use a secure protocol with ``api.web_server``, ``api.files_server``, an
|
||||
* Set the request method for all API requests and auth login. This can be useful when `GET` requests with payloads are
|
||||
blocked by a server, and `POST` requests can be used instead. The request options are: "GET", "POST", "PUT".
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
This configuration option is experimental, and has not been vigorously tested, so it may have unintended consequences.
|
||||
:::
|
||||
|
||||
@ -784,7 +784,7 @@ This configuration option is experimental, and has not been vigorously tested, s
|
||||
* `true` - Verify
|
||||
* `false` - Do not verify.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Set to False only if required.
|
||||
:::
|
||||
|
||||
@ -1344,7 +1344,7 @@ This option is deprecated. This plot behavior is now controlled via the UI
|
||||
**`sdk.network.iteration.retry_backoff_factor_sec`** (*integer*)
|
||||
|
||||
* For retries when getting frames from the server, this is backoff factor for consecutive retry attempts. This is used to
|
||||
determine the number of seconds between retries. The retry backoff factor is calculated as {backoff factor} * (2 ^ ({number of total retries} - 1)).
|
||||
determine the number of seconds between retries. The retry backoff factor is calculated as `{backoff factor} * (2 ^ ({number of total retries} - 1))`.
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ and delete all cookies under the ClearML Server URL.
|
||||
|
||||
## Launching
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
By default, ClearML Server deploys as an open network. To restrict ClearML Server access, follow the instructions
|
||||
in the [Security](clearml_server_security.md) page.
|
||||
:::
|
||||
@ -70,7 +70,7 @@ The pre-built ClearML Server storage configuration is the following:
|
||||
|
||||
## Backing Up and Restoring Data and Configuration
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Stop your server before backing up or restoring data and configuration
|
||||
:::
|
||||
|
||||
|
||||
@ -166,15 +166,17 @@ The following example, which is based on AWS load balancing, demonstrates the co
|
||||
|
||||
1. In the ClearML Server `/opt/clearml/config/apiserver.conf` file, add the following `auth.cookies` section:
|
||||
|
||||
auth {
|
||||
cookies {
|
||||
httponly: true
|
||||
secure: true
|
||||
domain: ".clearml.mydomain.com"
|
||||
max_age: 99999999999
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
auth {
|
||||
cookies {
|
||||
httponly: true
|
||||
secure: true
|
||||
domain: ".clearml.mydomain.com"
|
||||
max_age: 99999999999
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
:::tip
|
||||
If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or
|
||||
an alternate folder you configured), and input the modified configuration
|
||||
@ -212,7 +214,7 @@ For improved security, the ports for ClearML Server Elasticsearch, MongoDB, and
|
||||
they are only open internally in the docker network. If external access is needed, open these ports (but make sure to
|
||||
understand the security risks involved with doing so).
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Opening the ports for Elasticsearch, MongoDB, and Redis for external access may pose a security concern and is not recommended
|
||||
unless you know what you're doing. Network security measures, such as firewall configuration, should be considered when
|
||||
opening ports for external access.
|
||||
@ -261,27 +263,29 @@ Without web login authentication, ClearML Server does not restrict access (by de
|
||||
|
||||
For example:
|
||||
|
||||
auth {
|
||||
# Fixed users login credentials
|
||||
# No other user will be able to login
|
||||
fixed_users {
|
||||
enabled: true
|
||||
pass_hashed: false
|
||||
users: [
|
||||
{
|
||||
username: "jane"
|
||||
password: "12345678"
|
||||
name: "Jane Doe"
|
||||
},
|
||||
{
|
||||
username: "john"
|
||||
password: "12345678"
|
||||
name: "John Doe"
|
||||
},
|
||||
]
|
||||
}
|
||||
```
|
||||
auth {
|
||||
# Fixed users login credentials
|
||||
# No other user will be able to login
|
||||
fixed_users {
|
||||
enabled: true
|
||||
pass_hashed: false
|
||||
users: [
|
||||
{
|
||||
username: "jane"
|
||||
password: "12345678"
|
||||
name: "Jane Doe"
|
||||
},
|
||||
{
|
||||
username: "john"
|
||||
password: "12345678"
|
||||
name: "John Doe"
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
:::tip
|
||||
If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or
|
||||
an alternate folder you configured), and input the modified configuration
|
||||
@ -338,18 +342,19 @@ Modify the following settings for the watchdog:
|
||||
section and specify the watchdog settings.
|
||||
|
||||
For example:
|
||||
```
|
||||
tasks {
|
||||
non_responsive_tasks_watchdog {
|
||||
enabled: true
|
||||
|
||||
tasks {
|
||||
non_responsive_tasks_watchdog {
|
||||
enabled: true
|
||||
|
||||
# In-progress tasks that haven't been updated for at least 'value' seconds will be stopped by the watchdog
|
||||
threshold_sec: 7200
|
||||
# In-progress tasks that haven't been updated for at least 'value' seconds will be stopped by the watchdog
|
||||
threshold_sec: 7200
|
||||
|
||||
# Watchdog will sleep for this number of seconds after each cycle
|
||||
watch_interval_sec: 900
|
||||
}
|
||||
# Watchdog will sleep for this number of seconds after each cycle
|
||||
watch_interval_sec: 900
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
:::tip
|
||||
If the `apiserver.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or
|
||||
|
||||
@ -22,7 +22,7 @@ The migration process makes use of a script that automatically performs the foll
|
||||
* Renames the original data directory to avoid accidental reuse.
|
||||
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Once the migration process completes successfully, the data is no longer accessible to the older version of Trains Server,
|
||||
and ClearML Server needs to be installed.
|
||||
:::
|
||||
@ -140,14 +140,14 @@ and ClearML Server needs to be installed.
|
||||
|
||||
Upon successful completion, the migration script renames the original **Trains Server** directory, which contains the now
|
||||
migrated data, and prints a completion message:
|
||||
|
||||
Renaming the source directory /opt/trains/data/elastic to /opt/trains/data/elastic_migrated_<date_time>.
|
||||
Upgrade completed.
|
||||
|
||||
```
|
||||
Renaming the source directory /opt/trains/data/elastic to /opt/trains/data/elastic_migrated_<date_time>.
|
||||
Upgrade completed.
|
||||
```
|
||||
All console output during the execution of the migration script is saved to a log file in the directory where the migration script executes:
|
||||
|
||||
<path_to_script>/upgrade_to_7_<date_time>.log
|
||||
|
||||
```
|
||||
<path_to_script>/upgrade_to_7_<date_time>.log
|
||||
```
|
||||
If the migration script does not complete successfully, the migration script prints the error.
|
||||
|
||||
:::important
|
||||
|
||||
@ -65,7 +65,7 @@ For more information see the [Compute Engine Documentation](https://cloud.google
|
||||
## Launching
|
||||
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
|
||||
instructions in the [Security](clearml_server_security.md) page.
|
||||
:::
|
||||
@ -89,7 +89,7 @@ The minimum requirements for ClearML Server are:
|
||||
|
||||
## Backing Up and Restoring Data and Configuration
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Stop your server before backing up or restoring data and configuration
|
||||
:::
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ Ensure that the `helm` binary is in the PATH of your shell.
|
||||
You will create a multi-node Kubernetes cluster using Helm, and then install ClearML in your cluster. For deployment
|
||||
instructions with up-to-date Helms charts, see the [clearml-helm-charts repository](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml#local-environment).
|
||||
|
||||
:::caution Server Access
|
||||
:::warning Server Access
|
||||
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
|
||||
instructions in the [Security](clearml_server_security.md) page.
|
||||
:::
|
||||
|
||||
@ -30,7 +30,7 @@ For Linux users only:
|
||||
## Deploying
|
||||
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
|
||||
instructions in the [Security](clearml_server_security.md) page.
|
||||
:::
|
||||
@ -157,7 +157,7 @@ After deploying ClearML Server, the services expose the following ports:
|
||||
|
||||
## Backing Up and Restoring Data and Configuration
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Stop your server before backing up or restoring data and configuration
|
||||
:::
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ and delete all cookies under the ClearML Server URL.
|
||||
|
||||
## Deploying
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page.
|
||||
:::
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ to upgrade and migrate to a [new AWS instance](#upgrading-and-migrating-to-a-new
|
||||
|
||||
This section contains the steps to upgrade ClearML Server on the same AWS instance.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Some legacy **Trains Server** AMIs provided an auto-upgrade on restart capability. This functionality is now deprecated.
|
||||
:::
|
||||
|
||||
|
||||
34
docs/faq.md
34
docs/faq.md
@ -355,17 +355,18 @@ Your firewall may be preventing the connection. Try one of the following solutio
|
||||
* Direct python "requests" to use the enterprise certificate file by setting the OS environment variables CURL_CA_BUNDLE or REQUESTS_CA_BUNDLE. For a detailed discussion of this topic, see [https://stackoverflow.com/questions/48391750/disable-python-requests-ssl-validation-for-an-imported-module](https://stackoverflow.com/questions/48391750/disable-python-requests-ssl-validation-for-an-imported-module).
|
||||
* Disable certificate verification
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
For security reasons, it is not recommended to disable certificate verification
|
||||
:::
|
||||
1. Upgrade ClearML to the current version:
|
||||
|
||||
pip install -U clearml
|
||||
|
||||
```
|
||||
pip install -U clearml
|
||||
```
|
||||
1. Create a new `clearml.conf` configuration file (see a [sample configuration file](https://github.com/allegroai/clearml/blob/master/docs/clearml.conf)), containing:
|
||||
|
||||
api { verify_certificate = False }
|
||||
|
||||
|
||||
```
|
||||
api { verify_certificate = False }
|
||||
```
|
||||
1. Copy the new `clearml.conf` file to:
|
||||
* Linux - `~/clearml.conf`
|
||||
* Mac - `$HOME/clearml.conf`
|
||||
@ -436,7 +437,7 @@ To delete an object programmatically, use the relevant method:
|
||||
* Datasets - [`Dataset.delete()`](references/sdk/dataset.md#datasetdelete)
|
||||
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
You cannot undo the deletion of a ClearML object.
|
||||
:::
|
||||
|
||||
@ -554,7 +555,7 @@ You can enable offline mode in one of the following ways:
|
||||
the `offline_mode` argument to `True`
|
||||
* Before running a task, set `CLEARML_OFFLINE_MODE=1`
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Offline mode only works with tasks created using [`Task.init()`](references/sdk/task.md#taskinit) and not with those created
|
||||
using [`Task.create()`](references/sdk/task.md#taskcreate).
|
||||
:::
|
||||
@ -1062,13 +1063,14 @@ Do the following:
|
||||
```
|
||||
|
||||
1. Run the ClearML wizard `clearml-init` to configure ClearML for ClearML Server, which will prompt you to open the ClearML Web UI at, [http://127.0.0.1:8080/](http://127.0.0.1:8080/), and create new ClearML credentials.
|
||||
|
||||
The wizard completes with:
|
||||
|
||||
Verifying credentials ...
|
||||
Credentials verified!
|
||||
New configuration stored in /home/<username>/clearml.conf
|
||||
ClearML setup completed successfully.
|
||||
|
||||
The wizard completes with:
|
||||
```
|
||||
Verifying credentials ...
|
||||
Credentials verified!
|
||||
New configuration stored in /home/<username>/clearml.conf
|
||||
ClearML setup completed successfully.
|
||||
```
|
||||
|
||||
<a className="tr_top_negative" id="elastic_watermark"></a>
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@ This mode is intended for running maintenance tasks. Some suitable tasks include
|
||||
- [Control Service](../guides/services/aws_autoscaler.md) - AWS Autoscaler for example
|
||||
- [External services](../guides/services/slack_alerts.md) - Such as Slack integration alert service
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Do not enqueue training or inference tasks into the services queue. They will put an unnecessary load on the server.
|
||||
:::
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ private credentials (assuming the entire code base, including `.git` already exi
|
||||
|
||||
## Optional: ClearML Configuration Parameters
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
If you set ClearML configuration parameters (ClearML Server and ClearML credentials) in the plugin, they will override
|
||||
the settings in the ClearML configuration file.
|
||||
:::
|
||||
|
||||
@ -62,21 +62,23 @@ task = Task.init(
|
||||
|
||||
When the script runs, ClearML creates the following directory structure:
|
||||
|
||||
+ - <output destination name>
|
||||
| +-- <project name>
|
||||
| +-- <task name>.<Task Id>
|
||||
| +-- models
|
||||
| +-- artifacts
|
||||
|
||||
```
|
||||
+ - <output destination name>
|
||||
| +-- <project name>
|
||||
| +-- <task name>.<Task Id>
|
||||
| +-- models
|
||||
| +-- artifacts
|
||||
```
|
||||
and puts the model checkpoints (snapshots) and artifacts in that folder.
|
||||
|
||||
For example, if the Task ID is `9ed78536b91a44fbb3cc7a006128c1b0`, then the directory structure will be:
|
||||
|
||||
+ - model_snapshots
|
||||
| +-- examples
|
||||
| +-- extending automagical ClearML example.9ed78536b91a44fbb3cc7a006128c1b0
|
||||
| +-- models
|
||||
| +-- artifacts
|
||||
```
|
||||
+ - model_snapshots
|
||||
| +-- examples
|
||||
| +-- extending automagical ClearML example.9ed78536b91a44fbb3cc7a006128c1b0
|
||||
| +-- models
|
||||
| +-- artifacts
|
||||
```
|
||||
|
||||
## Step 2: Logger Class Reporting Methods
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ python slack_alerts.py --channel <Slack-channel-name> --slack-api <Slack-API-tok
|
||||
The script supports the following additional command line options:
|
||||
* `service_queue` - The queue to use when running remotely as a service. The default value is `services` (make sure
|
||||
your workspace has such a queue and to assign a ClearML Agent to this queue).
|
||||
* `message_prefix` - A message prefix for Slack alerts. For example, to alert all channel members use: "Hey <!here>".
|
||||
* `message_prefix` - A message prefix for Slack alerts. For example, to alert all channel members use: `"Hey <!here>"`.
|
||||
* `min_num_iterations` - Minimal iteration threshold below which experiments are ignored. Use this option to eliminate
|
||||
debug sessions that fail quickly. The default value is 0.
|
||||
* `project` - The name of the project to monitor. By default, all projects are monitored.
|
||||
|
||||
@ -23,7 +23,7 @@ the `offline_mode` argument to `True`
|
||||
|
||||
* Before running a task, set `CLEARML_OFFLINE_MODE=1`
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
Offline mode only works with tasks created using [`Task.init()`](../references/sdk/task.md#taskinit) and not with those created
|
||||
using [`Task.create()`](../references/sdk/task.md#taskcreate).
|
||||
:::
|
||||
|
||||
@ -51,33 +51,34 @@ For more information about workers, worker daemons, and queues, see [Agents and
|
||||
Run the worker daemon on the local development machine.
|
||||
1. Open a terminal session.
|
||||
1. Run the following `clearml-agent` command which runs a worker daemon listening to the `default` queue:
|
||||
|
||||
clearml-agent daemon --queue default
|
||||
|
||||
```
|
||||
clearml-agent daemon --queue default
|
||||
```
|
||||
The response to this command is information about the configuration, the worker, and the queue. For example:
|
||||
|
||||
Current configuration (clearml_agent v0.16.0, location: /home/<username>/clearml.conf):
|
||||
----------------------
|
||||
agent.worker_id =
|
||||
agent.worker_name = LAPTOP-PPTKKPGK
|
||||
agent.python_binary =
|
||||
agent.package_manager.type = pip
|
||||
.
|
||||
.
|
||||
.
|
||||
sdk.development.worker.report_period_sec = 2
|
||||
sdk.development.worker.ping_period_sec = 30
|
||||
sdk.development.worker.log_stdout = true
|
||||
```
|
||||
Current configuration (clearml_agent v0.16.0, location: /home/<username>/clearml.conf):
|
||||
----------------------
|
||||
agent.worker_id =
|
||||
agent.worker_name = LAPTOP-PPTKKPGK
|
||||
agent.python_binary =
|
||||
agent.package_manager.type = pip
|
||||
.
|
||||
.
|
||||
.
|
||||
sdk.development.worker.report_period_sec = 2
|
||||
sdk.development.worker.ping_period_sec = 30
|
||||
sdk.development.worker.log_stdout = true
|
||||
|
||||
Worker "LAPTOP-PPTKKPGK:0" - Listening to queues:
|
||||
+ ---------------------------------+---------+-------+
|
||||
| id | name | tags |
|
||||
+ ---------------------------------+---------+-------+
|
||||
| 2a03daf5ff9a4255b9915fbd5306f924 | default | |
|
||||
+ ---------------------------------+---------+-------+
|
||||
Worker "LAPTOP-PPTKKPGK:0" - Listening to queues:
|
||||
+ ---------------------------------+---------+-------+
|
||||
| id | name | tags |
|
||||
+ ---------------------------------+---------+-------+
|
||||
| 2a03daf5ff9a4255b9915fbd5306f924 | default | |
|
||||
+ ---------------------------------+---------+-------+
|
||||
|
||||
Running CLEARML-AGENT daemon in background mode, writing stdout/stderr to /home/<username>/.clearml_agent_daemon_outym6lqxrz.txt
|
||||
|
||||
Running CLEARML-AGENT daemon in background mode, writing stdout/stderr to /home/<username>/.clearml_agent_daemon_outym6lqxrz.txt
|
||||
```
|
||||
|
||||
## Step 5: Enqueue the Tuned Experiment
|
||||
|
||||
Enqueue the tuned experiment.
|
||||
|
||||
@ -154,44 +154,45 @@ This image shows a SingleFrame in the ClearML Enterprise WebApp (UI) [frame view
|
||||
|
||||
<Collapsible type="configuration" title="SingleFrame details represented in the WebApp">
|
||||
|
||||
|
||||
id : "287024"
|
||||
timestamp : 0
|
||||
rois : Array[2] [
|
||||
{
|
||||
"label":["tennis racket"],
|
||||
"poly":[174,189,149,152,117,107,91,72,68,45,57,33,53,30,49,32,48,34,46,35,46,37,84,92,112,128,143,166,166,191,170,203,178,196,179,194,-999999999,194,238,204,250,212,250,221,250,223,249,206,230,205,230],
|
||||
"confidence":1,
|
||||
"sources":["default"],
|
||||
"id":"f9fc8629d99b4e65aecacedd32ac356e"
|
||||
},
|
||||
{
|
||||
"label":["person"],
|
||||
"poly":[158,365,161,358,165,335,170,329,171,321,171,307,173,299,172,292,171,277,171,269,170,260,170,254,171,237,177,225,172,218,167,215,164,207,167,205,171,199,174,196,183,193,188,192,192,192,202,199,207,200,232,187,238,182,240,178,244,172,245,169,245,166,241,163,235,164,233,159,239,150,240,146,240,134,237,137,231,141,222,142,217,136,216,130,215,123,215,116,224,102,229,99,233,96,245,108,256,92,272,84,292,87,309,92,319,101,328,121,329,134,327,137,325,140,331,152,327,155,323,159,324,167,320,174,319,183,327,196,329,232,328,243,323,248,315,254,316,262,314,269,314,280,317,302,313,326,311,330,301,351,299,361,288,386,274,410,269,417,260,427,256,431,249,439,244,448,247,468,249,486,247,491,245,493,243,509,242,524,241,532,237,557,232,584,233,608,233,618,228,640,172,640,169,640,176,621,174,604,147,603,146,609,151,622,144,634,138,638,128,640,49,640,0,640,0,636,0,631,0,630,0,629,37,608,55,599,66,594,74,594,84,593,91,593,99,571,110,534,114,523,117,498,116,474,113,467,113,459,113,433,113,427,118,412,137,391,143,390,147,386,157,378,157,370],
|
||||
"confidence":1,
|
||||
"sources":["default"],
|
||||
"id":"eda8c727fea24c49b6438e5e17c0a846"
|
||||
}
|
||||
]
|
||||
sources : Array[1] [
|
||||
{
|
||||
"id":"default",
|
||||
"uri":"https://s3.amazonaws.com/allegro-datasets/coco/train2017/000000287024.jpg",
|
||||
"content_type":"image/jpeg",
|
||||
"width":427,
|
||||
"height":640,
|
||||
"timestamp":0
|
||||
}
|
||||
]
|
||||
dataset : Object
|
||||
{
|
||||
"id":"f7edb3399164460d82316fa5ab549d5b",
|
||||
"version":"6ad8b10c668e419f9dd40422f667592c"
|
||||
}
|
||||
context_id : https://s3.amazonaws.com/allegro-datasets/coco/train2017/000000287024.jpg
|
||||
saved : 1598982880693
|
||||
saved_in_version : "6ad8b10c668e419f9dd40422f667592c"
|
||||
num_frames : 1
|
||||
```
|
||||
id : "287024"
|
||||
timestamp : 0
|
||||
rois : Array[2] [
|
||||
{
|
||||
"label":["tennis racket"],
|
||||
"poly":[174,189,149,152,117,107,91,72,68,45,57,33,53,30,49,32,48,34,46,35,46,37,84,92,112,128,143,166,166,191,170,203,178,196,179,194,-999999999,194,238,204,250,212,250,221,250,223,249,206,230,205,230],
|
||||
"confidence":1,
|
||||
"sources":["default"],
|
||||
"id":"f9fc8629d99b4e65aecacedd32ac356e"
|
||||
},
|
||||
{
|
||||
"label":["person"],
|
||||
"poly":[158,365,161,358,165,335,170,329,171,321,171,307,173,299,172,292,171,277,171,269,170,260,170,254,171,237,177,225,172,218,167,215,164,207,167,205,171,199,174,196,183,193,188,192,192,192,202,199,207,200,232,187,238,182,240,178,244,172,245,169,245,166,241,163,235,164,233,159,239,150,240,146,240,134,237,137,231,141,222,142,217,136,216,130,215,123,215,116,224,102,229,99,233,96,245,108,256,92,272,84,292,87,309,92,319,101,328,121,329,134,327,137,325,140,331,152,327,155,323,159,324,167,320,174,319,183,327,196,329,232,328,243,323,248,315,254,316,262,314,269,314,280,317,302,313,326,311,330,301,351,299,361,288,386,274,410,269,417,260,427,256,431,249,439,244,448,247,468,249,486,247,491,245,493,243,509,242,524,241,532,237,557,232,584,233,608,233,618,228,640,172,640,169,640,176,621,174,604,147,603,146,609,151,622,144,634,138,638,128,640,49,640,0,640,0,636,0,631,0,630,0,629,37,608,55,599,66,594,74,594,84,593,91,593,99,571,110,534,114,523,117,498,116,474,113,467,113,459,113,433,113,427,118,412,137,391,143,390,147,386,157,378,157,370],
|
||||
"confidence":1,
|
||||
"sources":["default"],
|
||||
"id":"eda8c727fea24c49b6438e5e17c0a846"
|
||||
}
|
||||
]
|
||||
sources : Array[1] [
|
||||
{
|
||||
"id":"default",
|
||||
"uri":"https://s3.amazonaws.com/allegro-datasets/coco/train2017/000000287024.jpg",
|
||||
"content_type":"image/jpeg",
|
||||
"width":427,
|
||||
"height":640,
|
||||
"timestamp":0
|
||||
}
|
||||
]
|
||||
dataset : Object
|
||||
{
|
||||
"id":"f7edb3399164460d82316fa5ab549d5b",
|
||||
"version":"6ad8b10c668e419f9dd40422f667592c"
|
||||
}
|
||||
context_id : https://s3.amazonaws.com/allegro-datasets/coco/train2017/000000287024.jpg
|
||||
saved : 1598982880693
|
||||
saved_in_version : "6ad8b10c668e419f9dd40422f667592c"
|
||||
num_frames : 1
|
||||
```
|
||||
|
||||
</Collapsible>
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: MMCV v1.x
|
||||
---
|
||||
|
||||
:::info
|
||||
`ClearMLLoggerHook` is supported by `mmcv` =>1.5.1 and <=1.7.0.
|
||||
`ClearMLLoggerHook` is supported by mmcv `=>1.5.1` and `<=1.7.0`.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
|
||||
@ -191,7 +191,7 @@ title: Version 0.16
|
||||
|
||||
**Bug Fixes**
|
||||
|
||||
* Fix typing dependency for Python<3.5 ([GitHub trains Issue 184](https://github.com/allegroai/trains/issues/184)).
|
||||
* Fix typing dependency for `Python<3.5` ([GitHub trains Issue 184](https://github.com/allegroai/trains/issues/184)).
|
||||
* Fix git+https requirements handling, resolve top_level.txt package name (kerastuner from git was not detected).
|
||||
* Fix `Task.get_reported_console_output()` for new Trains Server API v2.9.
|
||||
* Fix cache handling for different partitions / drives / devices.
|
||||
|
||||
@ -4,7 +4,7 @@ title: Version 1.0
|
||||
|
||||
### ClearML Serving 1.0.0
|
||||
|
||||
:::caution Backwards Compatibility
|
||||
:::warning Backwards Compatibility
|
||||
This release is not backwards compatible
|
||||
:::
|
||||
|
||||
@ -260,7 +260,7 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()`
|
||||
* Add filters time columns
|
||||
* Add filters for custom columns (metrics and hyperparameters)
|
||||
* Add secondary nested sorting
|
||||
* Add worker<->queue clickable reference in workers and queues tables
|
||||
* Add `worker<->queue` clickable reference in workers and queues tables
|
||||
* Add presenting all metric debug samples concurrently
|
||||
* Add Full project name display in project cards ([ClearML GitHub issue 81](https://github.com/allegroai/clearml/issues/81#issuecomment-823303842))
|
||||
* Add option for continuing aborted tasks
|
||||
|
||||
@ -4,7 +4,7 @@ title: Version 1.1
|
||||
|
||||
### ClearML Serving 1.1.0
|
||||
|
||||
:::caution Backwards Compatibility
|
||||
:::warning Backwards Compatibility
|
||||
This release is not backwards compatible - see notes below on upgrading
|
||||
:::
|
||||
|
||||
|
||||
@ -98,7 +98,7 @@ an empty string
|
||||
* Fix `Dataset.get_local_copy()` is allowed for a non-finalized dataset
|
||||
* Fix `Task.upload_artifact()` does not upload empty lists/tuples
|
||||
* Fix pipeline retry mechanism interface
|
||||
* Fix Python <3.5 compatibility
|
||||
* Fix `Python <3.5` compatibility
|
||||
* Fix local cache warning (should be a debug message)
|
||||
|
||||
### ClearML SDK 1.7.0
|
||||
|
||||
@ -18,7 +18,7 @@ on completed/failed Tasks via Slack integration.
|
||||
* Project - Monitor a specific project. You can select an option to also monitor the specified project's subprojects
|
||||
* Entire workspace - Monitor all projects in your workspace
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
If your workspace or specified project contains a large number of experiments, the dashboard can take a while to update.
|
||||
:::
|
||||
|
||||
|
||||
@ -378,14 +378,21 @@ link to see the link's title.
|
||||
|
||||
The MarkDown code for a collapsible panel looks like this:
|
||||
|
||||
| MarkDown | Rendered Output |
|
||||
|---|---|
|
||||
| <code><details\><br/> <summary\>Section title</summary\><br/> Collapsible Section Contents<br/></details\></code>|<details><summary>Section title</summary>Collapsible Section Contents</details>|
|
||||
```
|
||||
<details><summary>Section title</summary>Collapsible Section Contents</details>
|
||||
```
|
||||
|
||||
The collapsible panel is surrounded by `<details>` tags. Within the `<details>` tag, add the section's title between
|
||||
the `<summary>` tags. This title can be seen when the panel is collapsed. After the `</summary>` tag, add the panel
|
||||
contents.
|
||||
|
||||
It is rendered like this:
|
||||
|
||||
<details><summary>Section title</summary>Collapsible Section Contents</details>
|
||||
|
||||
|
||||
|
||||
|
||||
### Horizontal Rules
|
||||
|
||||
Create horizontal lines using three hyphens (`---`), underscores (`___`), or asterisks (`***`):
|
||||
|
||||
@ -7,6 +7,7 @@
|
||||
* @format
|
||||
*/
|
||||
|
||||
import {themes as prismThemes} from 'prism-react-renderer';
|
||||
|
||||
const path = require('path');
|
||||
|
||||
@ -23,8 +24,8 @@ module.exports = {
|
||||
projectName: 'ClearML', // Usually your repo name.
|
||||
themeConfig: {
|
||||
prism: {
|
||||
theme: require('prism-react-renderer/themes/dracula'),
|
||||
darkTheme: require('prism-react-renderer/themes/dracula'),
|
||||
theme: prismThemes.dracula,
|
||||
darkTheme: prismThemes.dracula,
|
||||
},
|
||||
//algolia algolia: {
|
||||
//algolia appId: 'ALGOLIA_APP_ID', // The application ID provided by Algolia
|
||||
|
||||
12938
package-lock.json
generated
12938
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
27
package.json
27
package.json
@ -16,21 +16,26 @@
|
||||
"prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,md}\""
|
||||
},
|
||||
"dependencies": {
|
||||
"@cmfcmf/docusaurus-search-local": "^0.6.2",
|
||||
"@docusaurus/core": "^2.3.1",
|
||||
"@docusaurus/plugin-content-blog": "^2.3.1",
|
||||
"@docusaurus/plugin-google-analytics": "^2.3.1",
|
||||
"@docusaurus/plugin-google-gtag": "^2.3.1",
|
||||
"@docusaurus/preset-classic": "2.3.1",
|
||||
"@easyops-cn/docusaurus-search-local": "^0.17.0",
|
||||
"@mdx-js/react": "^1.6.22",
|
||||
"@cmfcmf/docusaurus-search-local": "^1.1.0",
|
||||
"@docusaurus/core": "^3.1.1",
|
||||
"@docusaurus/plugin-content-blog": "^3.1.1",
|
||||
"@docusaurus/plugin-google-analytics": "^3.1.1",
|
||||
"@docusaurus/plugin-google-gtag": "^3.1.1",
|
||||
"@docusaurus/preset-classic": "3.1.1",
|
||||
"@easyops-cn/docusaurus-search-local": "^0.23.3",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"clsx": "^1.1.1",
|
||||
"medium-zoom": "^1.0.6",
|
||||
"prism-react-renderer": "^1.2.0",
|
||||
"react": "^16.8.4",
|
||||
"react-dom": "^16.8.4",
|
||||
"prism-react-renderer": "^2.1.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0",
|
||||
"joi": "^17.4.0"
|
||||
},
|
||||
"overrides": {
|
||||
"@cmfcmf/docusaurus-search-local": {
|
||||
"@docusaurus/core": "^3.1.1"
|
||||
}
|
||||
},
|
||||
"devDependencies": {
|
||||
"babel-eslint": "^10.0.3",
|
||||
"eslint": "^7.7.0",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user