ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-31 14:37:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

edit ds/best_practices (#77)

Browse Source
This commit is contained in:
pollfly 2021-10-03 11:08:45 +03:00 committed by GitHub
parent 5805a392de
commit dace2299d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/getting_started/ds/best_practices.md
View File

@ -47,8 +47,8 @@ that we need.
accessed, [compared](../../webapp/webapp_exp_comparing.md) and [tracked](../../webapp/webapp_exp_track_visual.md). accessed, [compared](../../webapp/webapp_exp_comparing.md) and [tracked](../../webapp/webapp_exp_track_visual.md).
- [ClearML Agent](../../clearml_agent.md) does the heavy lifting. It reproduces the execution environment, clones your code, - [ClearML Agent](../../clearml_agent.md) does the heavy lifting. It reproduces the execution environment, clones your code,
applies code patches, manages parameters (Including overriding them on the fly), executes the code and queues multiple tasks applies code patches, manages parameters (Including overriding them on the fly), executes the code and queues multiple tasks
It can even [build](../../clearml_agent.md#buildingdockercontainers) the docker container for you! It can even [build](../../clearml_agent.md#exporting-a-task-into-a-standalone-docker-container) the docker container for you!
-[ClearML Pipelines](../../fundamentals/pipelines.md) ensures that steps run in the same order, - [ClearML Pipelines](../../fundamentals/pipelines.md) ensure that steps run in the same order,
programmatically chaining tasks together, while giving an overview of the execution pipeline's status. programmatically chaining tasks together, while giving an overview of the execution pipeline's status.
**Your entire environment should magically be able to run on any machine, without you working hard.** **Your entire environment should magically be able to run on any machine, without you working hard.**
@ -58,9 +58,9 @@ that we need.
We believe that you should track everything! From obscure parameters to weird metrics, it's impossible to know what will end up We believe that you should track everything! From obscure parameters to weird metrics, it's impossible to know what will end up
improving our results later on! improving our results later on!
- Make sure experiments are reproducible! ClearML logs code, parameters, environment in a single, easily searchable place. - Make sure experiments are reproducible! ClearML logs code, parameters, environment in a single, easily searchable place.
- Development is not linear. Configuration / Parameters should not be stored in your git - Development is not linear. Configuration / Parameters should not be stored in your git, as
they are temporary, and we constantly change them. But we still need to log them because who knows, one day... they are temporary and constantly changing. They still need to be logged because who knows, one day...
- Uncommitted changes to your code should be stored for later forensics in case that magic number actually saved the day. Not every line change should be committed. - Uncommitted changes to your code should be stored for later forensics in case that magic number actually saved the day. Not every line change should be committed.
- Mark potentially good experiments, make them the new baseline for comparison. - Mark potentially good experiments, make them the new baseline for comparison.