From 2a611f130bfeff5acf05d7120212ea079d32451b Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 20 Feb 2024 11:51:54 +0200 Subject: [PATCH] Small edits (#781) --- docs/apps/clearml_session.md | 2 +- docs/clearml_agent.md | 2 +- docs/clearml_agent/clearml_agent_ref.md | 2 +- docs/clearml_sdk/task_sdk.md | 2 +- docs/deploying_clearml/clearml_server_mongo44_migration.md | 2 +- docs/faq.md | 4 ++-- docs/fundamentals/task.md | 2 +- docs/guides/services/slack_alerts.md | 2 +- docs/hyperdatasets/webapp/webapp_dataviews.md | 2 +- docs/integrations/lightgbm.md | 2 +- docs/integrations/megengine.md | 2 +- docs/integrations/storage.md | 2 +- docs/webapp/pipelines/webapp_pipeline_table.md | 2 +- docs/webapp/webapp_projects_page.md | 4 ++-- docs/webapp/webapp_reports.md | 4 ++-- 15 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/apps/clearml_session.md b/docs/apps/clearml_session.md index 14e8097d..899fd73b 100644 --- a/docs/apps/clearml_session.md +++ b/docs/apps/clearml_session.md @@ -123,7 +123,7 @@ When `clearml-session` is launched, it initializes a task with a unique ID in th To connect to an existing session: 1. Go to the web UI, find the interactive session task (by default, it's in project "DevOps"). 1. Click on the ID button in the task page's header, and copy the unique ID. -1. Enter the following command: `clearml-session --attach `. +1. Run the following command: `clearml-session --attach `. 1. Click on the JupyterLab / VS Code link that is outputted, or connect directly to the SSH session ### Features diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md index 1dbcef13..b1532658 100644 --- a/docs/clearml_agent.md +++ b/docs/clearml_agent.md @@ -425,7 +425,7 @@ template specification attached to the queue. pip3 install -U --extra-index-url https://*****@*****.allegro.ai/repository/clearml_agent_slurm/simple clearml-agent-slurm ``` -1. Create a new batch template. Make sure to set the `SBATCH` variables to the resources you want to attach to the queue. +1. Create a batch template. Make sure to set the `SBATCH` variables to the resources you want to attach to the queue. The script below sets up an agent to run bare-metal, creating a virtual environment per job. For example: ``` diff --git a/docs/clearml_agent/clearml_agent_ref.md b/docs/clearml_agent/clearml_agent_ref.md index 7571be77..eff7245d 100644 --- a/docs/clearml_agent/clearml_agent_ref.md +++ b/docs/clearml_agent/clearml_agent_ref.md @@ -133,7 +133,7 @@ clearml-agent execute [-h] --id TASK_ID [--log-file LOG_FILE] [--disable-monitor |`--full-monitoring`| Create a full log, including the environment setup log, Task log, and monitoring, as well as stdout.|Yes| |`--git-pass`| Git password for repository access.|Yes| |`--git-user`| Git username for repository access.|Yes| -|`--gpus`| Specify active GPUs for the daemon to use (docker / virtual environment), Equivalent to setting `NVIDIA_VISIBLE_DEVICES`. For example: |Yes| +|`--gpus`| Specify active GPUs for the daemon to use (docker / virtual environment). Equivalent to setting `NVIDIA_VISIBLE_DEVICES`. For example: |Yes| |`-h`, `--help`| Get help for this command.|Yes| |`--log-file`| The log file for Task execution output (stdout / stderr) to a text file.|Yes| |`--log-level`| SDK log level. The values are:|Yes| diff --git a/docs/clearml_sdk/task_sdk.md b/docs/clearml_sdk/task_sdk.md index 124e4106..09120f6c 100644 --- a/docs/clearml_sdk/task_sdk.md +++ b/docs/clearml_sdk/task_sdk.md @@ -173,7 +173,7 @@ In order to mitigate the clutter that a multitude of debugging tasks might creat You can always create a new task by passing `reuse_last_task_id=False`. -See full `Task.init` reference [here](../references/sdk/task.md#taskinit). +For more information, see [`Task.init()`](../references/sdk/task.md#taskinit). ### Continuing Task Execution You can continue the execution of a previously run task using the `continue_last_task` parameter of `Task.init()`. diff --git a/docs/deploying_clearml/clearml_server_mongo44_migration.md b/docs/deploying_clearml/clearml_server_mongo44_migration.md index f96c0272..6126310e 100644 --- a/docs/deploying_clearml/clearml_server_mongo44_migration.md +++ b/docs/deploying_clearml/clearml_server_mongo44_migration.md @@ -16,7 +16,7 @@ mongodb version 4.4. If your ClearML server had been deployed with this chart (w You can stop reading here, as no migration is required. ::: -The migration process is comprised of the following: +The migration process includes the following: * Backing up your data * Creating a copy of the data which will be migrated for use with the new version * Sequentially running data migration for MongoDB: 3.6->4.0, 4.0->4.2, 4.0->4.4 diff --git a/docs/faq.md b/docs/faq.md index 7c7534f8..704dc2e0 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -295,7 +295,7 @@ Yes! ClearML provides multiple ways to configure your task and track your parame In addition to argparse, ClearML also automatically captures and tracks command line parameters created using [click](integrations/click.md), [Python Fire](integrations/python_fire.md), [Hydra](integrations/hydra.md), and/or [LightningCLI](https://lightning.ai/docs/pytorch/stable/cli/lightning_cli.html#lightning-cli). -ClearML also supports tracking code-level configuration dictionaries using the [`Task.connect`](references/sdk/task.md#connect) method. +ClearML also supports tracking code-level configuration dictionaries using [`Task.connect()`](references/sdk/task.md#connect). For example, the code below connects hyperparameters (`learning_rate`, `batch_size`, `display_step`, `model_path`, `n_hidden_1`, and `n_hidden_2`) to a task: @@ -309,7 +309,7 @@ parameters_dict = { 'learning_rate': 0.001, 'batch_size': 100, 'display_step': 1 parameters_dict = Task.current_task().connect(parameters_dict) ``` -See more task configuration options [here](fundamentals/hyperparameters.md). +For more task configuration options, see [Hyperparameters](fundamentals/hyperparameters.md).
diff --git a/docs/fundamentals/task.md b/docs/fundamentals/task.md index b7e2c4c7..8cea60d4 100644 --- a/docs/fundamentals/task.md +++ b/docs/fundamentals/task.md @@ -12,7 +12,7 @@ and specify a task name and its project. This creates a Task object that automat information as well as execution outputs. All the information captured by a task is by default uploaded to the [ClearML Server](../deploying_clearml/clearml_server.md), -and it can be visualized in the [ClearML WebApp](../webapp/webapp_overview.md) (UI). ClearML can also be configured to upload +and it can be visualized in the [ClearML WebApp (UI)](../webapp/webapp_overview.md). ClearML can also be configured to upload model checkpoints, artifacts, and charts to cloud storage (see [Storage](../integrations/storage.md)). Additionally, you can work with tasks in Offline Mode, in which all information is saved in a local folder (see [Storing Task Data Offline](../guides/set_offline.md)). diff --git a/docs/guides/services/slack_alerts.md b/docs/guides/services/slack_alerts.md index 01c3ec50..8e0345dd 100644 --- a/docs/guides/services/slack_alerts.md +++ b/docs/guides/services/slack_alerts.md @@ -10,7 +10,7 @@ failure of tasks, and posts alert messages on a Slack channel. ## Creating a Slack Bot -Before configuring and running the Slack alert service, create a new Slack Bot (**ClearML Bot**). +Before configuring and running the Slack alert service, create a Slack Bot (**ClearML Bot**). :::important The Slack API token and channel you create are required to configure the Slack alert service. diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index d3d9bf1a..5d819b34 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -96,7 +96,7 @@ The same information can be found in the batch action bar, in a tooltip that app ## Creating a Dataview -Create a new Dataview by clicking the **+ NEW DATAVIEW** button at the top right of the table, which opens a +Create a Dataview by clicking the **+ NEW DATAVIEW** button at the top right of the table, which opens a **NEW DATAVIEW** window. ![New Dataview window](../../img/webapp_dataview_new.png) \ No newline at end of file diff --git a/docs/integrations/lightgbm.md b/docs/integrations/lightgbm.md index db48bfc7..8f13be6b 100644 --- a/docs/integrations/lightgbm.md +++ b/docs/integrations/lightgbm.md @@ -30,7 +30,7 @@ And that's it! This creates a [ClearML Task](../fundamentals/task.md) which capt You can view all the task details in the [WebApp](../webapp/webapp_exp_track_visual.md). -See an example of LightGBM and ClearML in action [here](../guides/frameworks/lightgbm/lightgbm_example.md). +See LightGBM and ClearML in action in a [code example](../guides/frameworks/lightgbm/lightgbm_example.md). ![Experiment scalars](../img/examples_lightgbm_scalars.png) diff --git a/docs/integrations/megengine.md b/docs/integrations/megengine.md index 7134a411..b1d427d7 100644 --- a/docs/integrations/megengine.md +++ b/docs/integrations/megengine.md @@ -29,7 +29,7 @@ And that's it! This creates a [ClearML Task](../fundamentals/task.md) which capt You can view all the task details in the [WebApp](../webapp/webapp_overview.md). -See an example of MegEngine and ClearML in action [here](../guides/frameworks/megengine/megengine_mnist.md). +See MegEngine and ClearML in action in a [code example](../guides/frameworks/megengine/megengine_mnist.md). ## Automatic Logging Control By default, when ClearML is integrated into your MegEngine script, it captures all its logged models. But, you may want to diff --git a/docs/integrations/storage.md b/docs/integrations/storage.md index 58ed7d44..e2b316a2 100644 --- a/docs/integrations/storage.md +++ b/docs/integrations/storage.md @@ -34,7 +34,7 @@ The ClearML configuration file uses [HOCON](https://github.com/lightbend/config/ Modify these parts of the clearml.conf file and add the key, secret, and region of the S3 bucket. -It's possible to also give access to specific S3 buckets in the `aws.s3.credentials` section. The default configuration +You can also give access to specific S3 buckets in the `aws.s3.credentials` section. The default configuration provided in the `aws.s3` section is applied to any bucket without a bucket-specific configuration. You can also enable using a credentials chain to let Boto3 diff --git a/docs/webapp/pipelines/webapp_pipeline_table.md b/docs/webapp/pipelines/webapp_pipeline_table.md index 52c011e9..fbce73f6 100644 --- a/docs/webapp/pipelines/webapp_pipeline_table.md +++ b/docs/webapp/pipelines/webapp_pipeline_table.md @@ -112,7 +112,7 @@ Access these actions with the context menu in any of the following ways: | Action | Description | States Valid for the Action | State Transition | |---|---|---|---| | Details | View pipeline details. Can also be accessed by double-clicking a run in the pipeline runs table. | Any state | None | -| Run | Create a new pipeline run. Configure and enqueue it for execution. See [Create Run](#create-run). | Any State | *Pending* | +| Run | Create a pipeline run. Configure and enqueue it for execution. See [Create Run](#create-run). | Any State | *Pending* | | Abort | Manually stop / cancel a run. | *Running* / *Pending* | *Aborted* | | Continue | Rerun with the same parameters. | *Aborted* | *Pending* | | Add Tag | User-defined labels added to runs for grouping and organization. | Any state | None | diff --git a/docs/webapp/webapp_projects_page.md b/docs/webapp/webapp_projects_page.md index cb7b71d7..169b5a81 100644 --- a/docs/webapp/webapp_projects_page.md +++ b/docs/webapp/webapp_projects_page.md @@ -53,9 +53,9 @@ of a project folder to open its context menu and access the following project ac * **Delete** - Delete the project. To delete a project, all of its contents (i.e. any pipelines/reports/datasets) must first be archived or removed. -## Create New Projects +## Create Projects -To create a new project, click the **+ NEW PROJECT** button in the top right of the page or in a project's context menu, +To create a project, click the **+ NEW PROJECT** button in the top right of the page or in a project's context menu, which will open a **New Project** modal. ![New project modal](../img/webapp_projects_new_project.png) \ No newline at end of file diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index f555ff5e..7131b00f 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -220,9 +220,9 @@ of a report card to open its context menu and access report actions: * **Archive** - Move report from active reports page to archive * **Delete** - Delete the report. To delete a report, it must first be archived. -### Create New Reports +### Create Reports -To create a new project, click the **+ NEW REPORT** button in the top right of the page, +To create a report, click the **+ NEW REPORT** button in the top right of the page, which will open a **New Report** modal. ![New project modal](../img/webapp_report_new_report.png)