[tune] tune.track -> tune.report (#8388)

This commit is contained in:
Richard Liaw
2020-05-16 12:55:08 -07:00
committed by GitHub
parent c8cd716295
commit 67c01455fe
20 changed files with 228 additions and 395 deletions
+4 -4
View File
@@ -1,9 +1,9 @@
.. _trainable-docs:
Training (tune.Trainable, tune.track)
=====================================
Training (tune.Trainable, tune.report)
======================================
Training can be done with either a **Class API** (``tune.Trainable``) or **function-based API** (``track.log``).
Training can be done with either a **Class API** (``tune.Trainable``) or **function-based API** (``tune.report``).
You can use the **function-based API** for fast prototyping. On the other hand, the ``tune.Trainable`` interface supports checkpoint/restore functionality and provides more control for advanced algorithms.
@@ -27,7 +27,7 @@ Function-based API
for x in range(20):
score = objective(x, config["a"], config["b"])
tune.track.log(score=score) # This sends the score to Tune.
tune.report(score=score) # This sends the score to Tune.
analysis = tune.run(
trainable,