ray/doc/source/tune/api_docs
Kai Fricke 6313ddc47c
[tune] Refactor Syncer / deprecate Sync client (#25655)
This PR includes / depends on #25709

The two concepts of Syncer and SyncClient are confusing, as is the current API for passing custom sync functions.

This PR refactors Tune's syncing behavior. The Sync client concept is hard deprecated. Instead, we offer a well defined Syncer API that can be extended to provide own syncing functionality. However, the default will be to use Ray AIRs file transfer utilities.

New API:
- Users can pass `syncer=CustomSyncer` which implements the `Syncer` API
- Otherwise our off-the-shelf syncing is used
- As before, syncing to cloud disables syncing to driver

Changes:
- Sync client is removed
- Syncer interface introduced
- _DefaultSyncer is a wrapper around the URI upload/download API from Ray AIR
- SyncerCallback only uses remote tasks to synchronize data
- Rsync syncing is fully depracated and removed
- Docker and kubernetes-specific syncing is fully deprecated and removed
- Testing is improved to use `file://` URIs instead of mock sync clients
2022-06-14 14:46:30 +02: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 [tune] Refactor Syncer / deprecate Sync client (#25655) 2022-06-14 14:46:30 +02:00
execution.rst Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763) 2022-01-20 15:30:56 -08:00
integration.rst [tune] Refactor Syncer / deprecate Sync client (#25655) 2022-06-14 14:46:30 +02:00
internals.rst [tune] Remove TrialExecutor base class (#25404) 2022-06-03 10:16:47 +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 Fix broken links in documentation and put linkcheck linter in place on CI (#23340) 2022-03-18 21:02:52 -07:00
trainable.rst [tune/train] Consolidate checkpoint manager 3: Ray Tune (#24430) 2022-06-08 12:05:34 +01:00