[tune][docs/util] gputil check, docs (#11260)

Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com>
This commit is contained in:
Richard Liaw
2020-10-10 00:54:31 -07:00
committed by GitHub
co-authored by Amog Kamsetty
parent defd41aad7
commit 56f858ed1a
11 changed files with 229 additions and 98 deletions
+8
View File
@@ -111,6 +111,14 @@ def checkpoint_dir(step):
Store any files related to restoring state within the
provided checkpoint dir.
You should call this *before* calling ``tune.report``. The reason is
because we want checkpoints to be correlated with the result
(i.e., be able to retrieve the best checkpoint, etc). Many algorithms
depend on this behavior too.
Calling ``checkpoint_dir`` after report could introduce
inconsistencies.
Args:
step (int): Index for the checkpoint. Expected to be a
monotonically increasing quantity.