From 53f1f1c90bedb7f6edf2af46a1cdb54dba373abc Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 18 Sep 2022 10:21:41 +0300 Subject: [PATCH] Edits (#332) --- docs/faq.md | 10 +++++----- docs/webapp/applications/apps_dashboard.md | 6 +++++- docs/webapp/datasets/webapp_dataset_viewing.md | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index a5d77250..75658b0e 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -213,7 +213,7 @@ and [OutputModel](references/sdk/model_outputmodel.md) classes.
-**Models are not accessible the UI after I migrated ClearML Server to a new domain. How do I fix this?** +**Models are not accessible from the UI after I migrated ClearML Server to a new domain. How do I fix this?** This can happen if your models were uploaded to the ClearML files server, since the value registered was their full URL at the time of registration (e.g. `https://files./path/to/model`). @@ -392,7 +392,7 @@ Conda and the [typing](https://pypi.org/project/typing/) package may have some c However, [since Python 3.5](https://docs.python.org/3.5/library/typing.html), the `typing` package is part of the standard library. -To resolve the error, uninstall `typing` and rerun you script. If this does not fix the issue, create a [new ClearML issue](https://github.com/allegroai/clearml/issues/new), including the full error, and your environment details. +To resolve the error, uninstall `typing` and rerun your script. If this does not fix the issue, create a [new ClearML issue](https://github.com/allegroai/clearml/issues/new), including the full error, and your environment details. @@ -713,7 +713,7 @@ Yes! You can run ClearML in Jupyter Notebooks using either of the following: **Option 2: Install ClearML in your Jupyter Notebook** -1. In the ClearML Web UI > **Settings > Workspace** page, create credentials and copy your access key and secret key. These are required in the Step 3. +1. In the ClearML Web UI > **Settings > Workspace** page, create credentials and copy your access key and secret key. These are required for Step 3. 1. Install the ClearML Python Package. @@ -733,7 +733,7 @@ Yes! You can run ClearML in Jupyter Notebooks using either of the following: 1. You can now use ClearML. ```python # create a task and start training - task = Task.init('juptyer project', 'my notebook') + task = Task.init('jupyter project', 'my notebook') ``` @@ -884,7 +884,7 @@ on the "Configuring Your Own ClearML Server" page in the "Deploying ClearML" sec
-**Can I modify a non-responsive task settings?** +**Can I modify non-responsive task settings?** The non-responsive experiment watchdog monitors experiments that were not updated for a specified time interval, and marks them as `aborted`. The watchdog is always active. diff --git a/docs/webapp/applications/apps_dashboard.md b/docs/webapp/applications/apps_dashboard.md index 759e9e17..d6b1b970 100644 --- a/docs/webapp/applications/apps_dashboard.md +++ b/docs/webapp/applications/apps_dashboard.md @@ -11,6 +11,8 @@ chosen metric over the project's iterations, as well as project GPU and worker u on failed Tasks via Slack integration. ## Project Dashboard Instance Configuration +* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the + values from the file, which can be modified before launching the app instance * **Monitored Project** - Name of the ClearML project to monitor * **Monitored Metric** * Monitored Metric - Title - Metric title to track @@ -21,7 +23,9 @@ on failed Tasks via Slack integration. * API Token - Slack workspace access token * Channel Name - Slack channel to which task failure alerts will be posted * Fail Iteration Threshold - Minimum number of iterations to trigger Slack alerts about task failure (failed tasks that do not meet the threshold will be ignored) - +* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create + a new instance with the same configuration. + ![Dashboard app wizard](../../img/apps_dashboard_wizard.png) ## Dashboard diff --git a/docs/webapp/datasets/webapp_dataset_viewing.md b/docs/webapp/datasets/webapp_dataset_viewing.md index 20448432..f2925d48 100644 --- a/docs/webapp/datasets/webapp_dataset_viewing.md +++ b/docs/webapp/datasets/webapp_dataset_viewing.md @@ -98,7 +98,7 @@ to view:
-Click Expand to on the content panel header to view the panel in full screen. +Click Expand on the content panel header to view the panel in full screen. ## Dataset Actions The following table describes the actions that can be done from the dataset versions list.