aws / sagemaker-experiments

Experiment tracking and metric logging for Amazon SageMaker notebooks and model training.
Apache License 2.0
125 stars 36 forks source link

fix trial documentation #156

Closed danabens closed 2 years ago

danabens commented 2 years ago

fix incorrect example in Trial documentation that was leading users to not call close on the tracker.

Testing Done

❯ tox -e docs
...
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 14%] experiment
writing output... [ 28%] index
writing output... [ 42%] links
writing output... [ 57%] metrics
writing output... [ 71%] tracker
writing output... [ 85%] trial
writing output... [100%] trial_component

generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.
_______________________________________________________________ summary ________________________________________________________________
  docs: commands succeeded
  congratulations :)