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

[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train #37295

Merged
merged 8 commits into from
Jul 18, 2023
Merged

[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train #37295

merged 8 commits into from
Jul 18, 2023

Conversation

woshiyyya
Copy link
Member

@woshiyyya woshiyyya commented Jul 11, 2023 •
edited
Loading

Why are these changes needed?

This is a follow-up PR to make all Ray Train's docstring tests testable.

  • lightning_checkpoint.py
    • Remove doctest: +SKIP from LightningCheckpoint class docstring
  • mosaic_trainer.py
    • Convert MosaicTrainer example from REPL-style to testcode
  • tensorflow_checkpoint.py
    • Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
    • Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
    • Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
  • tensorflow_predictor.py
    • Convert TensorflowPredictor example from REPL-style to testcode

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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

@woshiyyya
init
ddf4a8d 
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
@woshiyyya
fix output
3dcd32f 
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
@woshiyyya
fix
4e0617d 
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
@woshiyyya
Merge remote-tracking branch 'upstream/master' into train/doctest/fix…
f395065 
…_REPL_tests
@woshiyyya woshiyyya marked this pull request as ready for review July 17, 2023 16:35
@woshiyyya
fix from_model
16ad6d9 
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
@woshiyyya
Merge remote-tracking branch 'upstream/master' into train/doctest/fix…
6ced465 
…_REPL_tests
@woshiyyya woshiyyya added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Jul 18, 2023
@woshiyyya woshiyyya force-pushed the train/doctest/fix_REPL_tests branch from 22d482b to 6ced465 Compare July 18, 2023 19:04
bveeramani
bveeramani approved these changes Jul 18, 2023
View reviewed changes
Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

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

LGTM! We might remove LightningCheckpoint, and I'm not sure if anyone uses MosaicTrainer, so let's just skip them for now

woshiyyya and others added 2 commits July 18, 2023 12:07
@woshiyyya
add comments
39b521e 
Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
@bveeramani
Fix comment
1bef9b9 
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
@amogkam amogkam merged commit 50e9530 into ray-project:master Jul 18, 2023
41 of 43 checks passed
Bhav00 pushed a commit to Bhav00/ray that referenced this pull request Jul 24, 2023
@woshiyyya @bveeramani @Bhav00
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
d439d94 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@anyscale.com>
Bhav00 pushed a commit to Bhav00/ray that referenced this pull request Jul 28, 2023
@woshiyyya @bveeramani @Bhav00
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
dcccc29 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@anyscale.com>
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
@woshiyyya @bveeramani @NripeshN
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
214db80 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: NripeshN <nn2012@hw.ac.uk>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
@woshiyyya @bveeramani @harborn
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
be5fcb1 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: harborn <gangsheng.wu@intel.com>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
@woshiyyya @bveeramani @harborn
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
72fef76 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@anyscale.com>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
@woshiyyya @bveeramani @arvind-chandra
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
b45e05b 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
@woshiyyya @bveeramani
[Train][doctest] Part 2: Remove REPL-style doctest in Ray Train (ray-…
0f47bd0 
…project#37295)

This is a follow-up PR to make all Ray Train's docstring tests testable.

lightning_checkpoint.py
Remove doctest: +SKIP from LightningCheckpoint class docstring
mosaic_trainer.py
Convert MosaicTrainer example from REPL-style to testcode
tensorflow_checkpoint.py
Remove doctest: +SKIP from TensorflowCheckpoint.from_model example
Convert TensorflowCheckpoint.from_h5 example from REPL-style to testcode
Convert TensorflowCheckpoint.from_saved_model example from REPL-style to testcode
tensorflow_predictor.py
Convert TensorflowPredictor example from REPL-style to testcode

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Co-authored-by: Balaji Veeramani <balaji@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
Reviewers

@bveeramani bveeramani bveeramani approved these changes

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

Assignees

@bveeramani bveeramani

Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@woshiyyya @bveeramani @matthewdeng @amogkam