diff --git a/docs/getting_started/ds/best_practices.md b/docs/getting_started/ds/best_practices.md index 13d02bfb..cc10954e 100644 --- a/docs/getting_started/ds/best_practices.md +++ b/docs/getting_started/ds/best_practices.md @@ -47,8 +47,8 @@ that we need. 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, 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! --[ClearML Pipelines](../../fundamentals/pipelines.md) ensures that steps run in the same order, + 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) ensure that steps run in the same order, 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.** @@ -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 improving our results later on! -- 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 - they are temporary, and we constantly change them. But we still need to log them because who knows, one day... +- 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, as + 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. - Mark potentially good experiments, make them the new baseline for comparison.