Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[air/train/docs] Add trainer user guide and update trainer docs #27389

Merged
merged 44 commits into from
Aug 4, 2022
Merged

[air/train/docs] Add trainer user guide and update trainer docs #27389

merged 44 commits into from
Aug 4, 2022

Conversation

xwjiang2010
Copy link
Contributor

@xwjiang2010 xwjiang2010 commented Aug 2, 2022 •
edited by richardliaw
Loading

Signed-off-by: xwjiang2010 xwjiang2010@gmail.com

Why are these changes needed?

This PR adds a user guide to AIR for using Ray Train. It provides a high level overview of the trainers and removes redundant sections.

The main file to review is here: doc/source/ray-air/trainer.rst.

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 :(

xwjiang2010 and others added 2 commits August 2, 2022 14:21
@xwjiang2010
tryout sphinx...
e9b690e 
Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
@richardliaw
update-annotations
6705481 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw richardliaw changed the title [draft] tryout sphinx... [air/train/docs] Update trainer docs Aug 2, 2022
@richardliaw
remove-train-tf-example
8b46170 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
remove train torch dataset example
28e8241 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
Remove tune train tf example
333dfec 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
richardliaw and others added 13 commits August 2, 2022 15:29
@richardliaw
reference-benchmarks
0d2a201 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update train faq
e7d4047 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@xwjiang2010
skeleton code for trainer guide.
e842a72 
Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
@richardliaw
Merge branch 'trainer_doc' of https://github.com/xwjiang2010/ray into…
fd9db20 
… trainer_doc
@xwjiang2010
add more trainer doc.
6c09d36 
Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
@xwjiang2010
Merge branch 'trainer_doc' of https://github.com/xwjiang2010/ray into…
dbffccd 
… trainer_doc
@xwjiang2010
add more
2563512 
Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
@richardliaw
get-build
51d1831 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
add-trainers
88fa63c 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
Merge branch 'master' into trainer_doc
4421c58
@richardliaw
update-trainer-docs
c0c8384 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update-trainer
0b01075 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update
11e0a2d 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
Update code examples
005023c 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update
86f1a83 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update
bfdded7 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
dmatrix
dmatrix requested changes Aug 3, 2022
View reviewed changes
doc/source/ray-air/key-concepts.rst Outdated Show resolved Hide resolved
doc/source/ray-air/trainer.rst Show resolved Hide resolved
doc/source/ray-air/trainer.rst Outdated Show resolved Hide resolved
doc/source/ray-air/trainer.rst Outdated Show resolved Hide resolved
doc/source/ray-air/trainer.rst Outdated
How to report metrics and checkpoints?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

During model training, you may want to save training metrics and checkpoints for downstream processing (e.g. serving the model).
Copy link
Contributor

Choose a reason for hiding this comment

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

e.g.,

doc/source/ray-air/trainer.rst Show resolved Hide resolved
doc/source/ray-air/trainer.rst Show resolved Hide resolved
dmatrix
dmatrix reviewed Aug 3, 2022
View reviewed changes
Copy link
Contributor

@dmatrix dmatrix left a comment

Choose a reason for hiding this comment

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

Left minor comments and edits. Did not use inline edits but suggested via comments.

@dmatrix dmatrix self-requested a review August 3, 2022 22:40
@richardliaw
update-comments
672a929 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update
d4932d4 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
richardliaw and others added 5 commits August 3, 2022 18:16
@richardliaw
lint
e9b7c47 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
update-regression-test
42a39e9 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw
Merge branch 'master' into trainer_doc
b98b47c
Merge remote-tracking branch 'upstream/master' into air/doc/trainer-doc
6f530f0
@richardliaw
update-docs
5c3027d 
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw richardliaw mentioned this pull request Aug 4, 2022
Merged
7 tasks
Fix hf trainer but don't run on CI
2ce2069 
Signed-off-by: Kai Fricke <kai@anyscale.com>
krfricke
krfricke approved these changes Aug 4, 2022
View reviewed changes
Copy link
Contributor

@krfricke krfricke left a comment

Choose a reason for hiding this comment

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

LGTM let's wait until CI passes

Kai Fricke added 2 commits August 4, 2022 11:44
Fix GPU test import
dc8b71a 
Signed-off-by: Kai Fricke <kai@anyscale.com>
fix torch trainer example
99bb074 
Signed-off-by: Kai Fricke <kai@anyscale.com>
@krfricke krfricke merged commit 8d5c07b into ray-project:master Aug 4, 2022
richardliaw added a commit to richardliaw/ray that referenced this pull request Aug 5, 2022
@xwjiang2010 @richardliaw
[air/train/docs] Add trainer user guide and update trainer docs (ray-…
b7c202b 
…project#27389)

This PR adds a user guide to AIR for using Ray Train. It provides a high level overview of the trainers and removes redundant sections.

The main file to review is here: doc/source/ray-air/trainer.rst.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: Kai Fricke <kai@anyscale.com>

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Co-authored-by: Kai Fricke <kai@anyscale.com>
@richardliaw richardliaw mentioned this pull request Aug 5, 2022
Merged
7 tasks
scv119 pushed a commit that referenced this pull request Aug 7, 2022
@richardliaw @xwjiang2010
[air/train/docs] Add trainer user guide and update trainer docs (#27389…
74bbca8 
…) (#27570)

This PR adds a user guide to AIR for using Ray Train. It provides a high level overview of the trainers and removes redundant sections.

The main file to review is here: doc/source/ray-air/trainer.rst.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: Kai Fricke <kai@anyscale.com>

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Co-authored-by: Kai Fricke <kai@anyscale.com>

Co-authored-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <kai@anyscale.com>
Stefan-1313 pushed a commit to Stefan-1313/ray_mod that referenced this pull request Aug 18, 2022
@xwjiang2010 @richardliaw
[air/train/docs] Add trainer user guide and update trainer docs (ray-…
f014752 
…project#27389)

This PR adds a user guide to AIR for using Ray Train. It provides a high level overview of the trainers and removes redundant sections.

The main file to review is here: doc/source/ray-air/trainer.rst.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: Kai Fricke <kai@anyscale.com>

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Co-authored-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Stefan van der Kleij <s.vanderkleij@viroteq.com>
@xwjiang2010 xwjiang2010 deleted the trainer_doc branch July 26, 2023 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krfricke krfricke krfricke approved these changes

@richardliaw richardliaw richardliaw approved these changes

@dmatrix dmatrix dmatrix approved these changes

@amogkam amogkam Awaiting requested review from amogkam

@matthewdeng matthewdeng Awaiting requested review from matthewdeng matthewdeng is a code owner

@Yard1 Yard1 Awaiting requested review from Yard1

@maxpumperla maxpumperla Awaiting requested review from maxpumperla

@pcmoritz pcmoritz Awaiting requested review from pcmoritz

@ericl ericl Awaiting requested review from ericl

@stephanie-wang stephanie-wang Awaiting requested review from stephanie-wang

@sriram-anyscale sriram-anyscale Awaiting requested review from sriram-anyscale

Assignees

@dmatrix dmatrix

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@xwjiang2010 @dmatrix @richardliaw @krfricke