From 76b6393a1cd769c9ca519eaa94ea54d65695c88a Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 29 Sep 2021 12:03:09 +0300 Subject: [PATCH] Fix typos, add puctuation, fix icon alignment (#75) --- .../mlops/mlops_best_practices.md | 23 ++++++++++--------- docs/webapp/webapp_exp_track_visual.md | 6 ++--- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/getting_started/mlops/mlops_best_practices.md b/docs/getting_started/mlops/mlops_best_practices.md index 17aa98c3..d8b695dc 100644 --- a/docs/getting_started/mlops/mlops_best_practices.md +++ b/docs/getting_started/mlops/mlops_best_practices.md @@ -6,11 +6,11 @@ In short - **automate everything** :) From training models to data processing to deploying to production. ## Development - Preparing for Automation -Basically track everything, there is nothing that is not worth having visibility to. -If you are afraid of clutter, use the archive option, and set up your own cleanup service (see [here](../../guides/services/cleanup_service) how) +Basically, track everything. There is nothing that is not worth having visibility to. +If you are afraid of clutter, use the archive option, and set up your own [cleanup service](../../guides/services/cleanup_service). -- Track the code base. there is no reason not to add metrics to any process in your workflow, even if it is not directly ML. Visibility is key to iterative improvement of your code \ workflow. -- Create per-project [leader-boards](../../webapp/webapp_exp_track_visual.md) based on custom columns +- Track the code base. There is no reason not to add metrics to any process in your workflow, even if it is not directly ML. Visibility is key to iterative improvement of your code / workflow. +- Create per-project [leaderboards](../../guides/ui/building_leader_board.md) based on custom columns (hyper parameters and performance accuracy), and bookmark them (full URL will always reproduce the same view & table). - Share experiments with your colleagues and team-leaders. Invite more people to see how your project is progressing, and suggest they add metric reporting for their own. @@ -18,22 +18,23 @@ If you are afraid of clutter, use the archive option, and set up your own cleanu ## Clone Tasks In order to define a Task in ClearML we have two options -- Run the actual code with ‘task.init’ call. This will create and auto-populate the Task in CleaML (including Git Repo/Python Packages/ Command line etc.) -- Register local/remote code repository with `clearml-task`. Dee [details](../../apps/clearml_task.md) +- Run the actual code with `task.init` call. This will create and auto-populate the Task in CleaML (including Git Repo/Python Packages/ Command line etc.). +- Register local/remote code repository with `clearml-task`. See [details](../../apps/clearml_task.md). -Once we have a Task in ClearML, we can clone and edit its definition in the UI. Then launch it on one of our nodes with [ClearML Agent](../../clearml_agent.md) +Once we have a Task in ClearML, we can clone and edit its definitions in the UI, then launch it on one of our nodes with [ClearML Agent](../../clearml_agent.md). ## Advanced Automation - Create daily/weekly cron jobs for retraining best performing models on. - Create data monitoring & scheduling and launch inference jobs to test performance on any new coming dataset. -- Once there are two or more experiments that run after another, group them together into a [pipeline](../../fundamentals/pipelines.md) +- Once there are two or more experiments that run after another, group them together into a [pipeline](../../fundamentals/pipelines.md). ## Manage Your Data Use [ClearML Data](../../clearml_data.md) to version your data, then link it to running experiments for easy reproduction. -Make datasets machine agnostic (i.e. store original dataset in a shared storage location, e.g. shared-folder/S3/Gs/Azure) -ClearML Data supports efficient Dataset storage and caching, differentiable & compressed +Make datasets machine agnostic (i.e. store original dataset in a shared storage location, e.g. shared-folder/S3/Gs/Azure). +ClearML Data supports efficient Dataset storage and caching, differentiable & compressed. ## Scale Your Work Use [ClearML Agent](../../clearml_agent.md) to scale work. Install the agent machines (Remote or local) and manage -training workload with it.
+training workload with it. + Improve team collaboration by transparent resource monitoring, always know what is running where. diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index fba60910..7c042834 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -444,9 +444,9 @@ These controls allow you to better analyze the results. Hover over a plot, and t #### 3D Plot Controls |Icon|Description| |---|---| -| Orbital rotation mode icon| Switch to orbital rotation mode - rotate the plot around its middle point. | -| Turntable rotation mode icon| Switch to turntable rotation mode - rotate the plot around its middle point while constraining one axis | -| reset axes icon| Reset axes to default position. | +| Orbital rotation mode icon| Switch to orbital rotation mode - rotate the plot around its middle point. | +| Turntable rotation mode icon| Switch to turntable rotation mode - rotate the plot around its middle point while constraining one axis | +| reset axes icon| Reset axes to default position. | ### Debug Samples