[docs] migrate AIR API references #38632
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Matthew Deng <matt@anyscale.com>
matthewdeng
requested review from
richardliaw,
gjoliver,
krfricke,
xwjiang2010,
amogkam,
Yard1,
maxpumperla,
a team,
ericl,
scv119,
c21,
scottjlee,
bveeramani and
raulchen
as code owners
|
Are we removing all the non-tabular preprocessor API references from the documentation? |
richardliaw
approved these changes
Aug 21, 2023
| @@ -0,0 +1,3 @@ | |||
| from ray.air.integrations.comet import CometLoggerCallback | |||
|
|
|||
| CometLoggerCallback.__module__ = "ray.tune.logger.comet" | |||
There was a problem hiding this comment.
not totally sure what this does, so skipping this part of the review
There was a problem hiding this comment.
This just makes the path show up properly
>>> from ray.tune.logger.comet import CometLoggerCallback
>>> CometLoggerCallback
<class 'ray.tune.logger.comet.CometLoggerCallback'>| @@ -1,25 +0,0 @@ | |||
|
|
|||
| Ray AIR Configurations | |||
| ====================== | |||
There was a problem hiding this comment.
assuming this already got moved to train?
There was a problem hiding this comment.
Yep, the configs are in the Train/Tune API references already.
|
|
||
| Experiment Tracking Integrations | ||
| ================================ | ||
|
|
There was a problem hiding this comment.
assuming this file moved to train?
There was a problem hiding this comment.
The callbacks are in Tune, and we are choosing to not recommend to setup methods
Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Matthew Deng <matt@anyscale.com>
amogkam
approved these changes
Aug 21, 2023
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
12 tasks
vymao
pushed a commit
to vymao/ray
that referenced
this pull request
Oct 11, 2023
Signed-off-by: Matthew Deng <matt@anyscale.com> Signed-off-by: Victor <vctr.y.m@example.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR disbands the AIR API References page. Most API references were already defined within their individual libraries.
Additional changes include:
Preprocessorsto Data.LoggerCallbacks to Tune.Related issue number
#38365
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.