ray/doc/source/tune/api_docs
xwjiang2010 ac831fded4
[air] update documentation to use session.report (#26051)
Update documentation to use `session.report`.

Next steps:
1. Update our internal caller to use `session.report`. Most importantly, CheckpointManager and DataParallelTrainer.
2. Update `get_trial_resources` to use PGF notions to incorporate the requirement of ResourceChangingScheduler. @Yard1 
3. After 2 is done, change all `tune.get_trial_resources` to `session.get_trial_resources`
4. [internal implementation] remove special checkpoint handling logic from huggingface trainer. Optimize the flow for checkpoint conversion with `session.report`.

Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
2022-06-30 10:37:31 -07:00
..
analysis.rst [tune] Next deprecation cycle (#24076) 2022-04-26 09:30:15 +01:00
cli.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
client.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
env.rst [air] update documentation to use session.report (#26051) 2022-06-30 10:37:31 -07:00
execution.rst Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763) 2022-01-20 15:30:56 -08:00
integration.rst [AIR] Move integration logging callbacks to AIR (#26126) 2022-06-28 17:25:19 -07:00
internals.rst [tune/structure] Introduce execution package (#26015) 2022-06-23 11:13:19 +01:00
logging.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
overview.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
reporters.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
schedulers.rst [ci/docs] Fix broken linkcheck URL (#24777) 2022-05-13 15:58:36 +01:00
search_space.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
sklearn.rst Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763) 2022-01-20 15:30:56 -08:00
stoppers.rst [docs] Tune overhaul part II (#22656) 2022-02-26 23:07:34 -08:00
suggestion.rst [tune/structure] Refactor suggest into search package (#26074) 2022-06-25 14:55:30 +01:00
trainable.rst [air] update documentation to use session.report (#26051) 2022-06-30 10:37:31 -07:00