Skip to content

[AIR][Doc] Add back important Ray Train integration methods (for Torch/TF) - #32551

Merged
richardliaw merged 12 commits into
ray-project:masterfrom
justinvyu:doc/fix_air_api_refs
Feb 15, 2023
Merged

[AIR][Doc] Add back important Ray Train integration methods (for Torch/TF)#32551
richardliaw merged 12 commits into
ray-project:masterfrom
justinvyu:doc/fix_air_api_refs

Conversation

@justinvyu

Copy link
Copy Markdown
Contributor

Why are these changes needed?

The API restructure from #32360 accidentally removed important Ray Train utilities such as ray.train.torch.prepare_model and ray.train.tensorflow.prepare_dataset_shard. This PR adds these back as part of the Train API ref.

This PR also fixes doc failures/link checks that resulted from moved files/duplicate API refs (from #32520).

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>

@matthewdeng matthewdeng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general looks good to me, will take another look when the docs render.

Comment thread doc/source/train/api/api.rst Outdated
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
@justinvyu

Copy link
Copy Markdown
Contributor Author

@matthewdeng Changes made. Rendered version from before for review: https://ray--32551.org.readthedocs.build/en/32551/

Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
@jjyao

jjyao commented Feb 15, 2023

Copy link
Copy Markdown
Contributor

Seems the latest doc build timed out (>3000s). Can we reduce the usage of template class_with_autosummary?

Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
.. rubric:: {{ _('Methods') }}

.. autosummary::
:toctree:

@justinvyu justinvyu Feb 15, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jjyao This is needed to prevent every single member from getting its own file. This is often not what you want when you "opt in" to class_with_autosummary.

@richardliaw
richardliaw merged commit 789e683 into ray-project:master Feb 15, 2023
jjyao added a commit that referenced this pull request Feb 16, 2023
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Co-authored-by: Justin Yu <justinvyu@anyscale.com>
edoakes pushed a commit to edoakes/ray that referenced this pull request Mar 22, 2023
…h/TF) (ray-project#32551)

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
peytondmurray pushed a commit to peytondmurray/ray that referenced this pull request Mar 22, 2023
elliottower pushed a commit to elliottower/ray that referenced this pull request Apr 22, 2023
…h/TF) (ray-project#32551)

Signed-off-by: elliottower <elliot@elliottower.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants