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

[docs][train]Make Train example titles, heading more consistent #39606

Merged
merged 18 commits into from
Sep 14, 2023
Merged

[docs][train]Make Train example titles, heading more consistent #39606

merged 18 commits into from
Sep 14, 2023

Conversation

angelinalg
Copy link
Contributor

Make examples more consistent:

  • titles
  • See also
  • headings

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

@angelinalg
copy editing lightning-mnist and torch-fashion-mnist examples
a4ad14f 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
rebase
1f37f18 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
rebase 2
6991189 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
polish examples: make titles more consistent, add links to guides
9d793ab 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
make remaining examples consistent; add see also's
b7f2a0e 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg angelinalg added docs An issue or change related to documentation train Ray Train Related Issue v2.7.0-pick labels Sep 12, 2023
@angelinalg
fixed missing inline end string
7904767 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
trying to fix premerge error
828d202 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg angelinalg changed the title [WIP][docs][train]Train examples [WIP][docs][train]Make Train example titles, heading more consistent Sep 12, 2023
@angelinalg
trying to fix premerge error again with removing trailing spaces
6446a30 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg angelinalg marked this pull request as ready for review September 13, 2023 00:35
angelinalg
angelinalg commented Sep 13, 2023
View reviewed changes
python/ray/train/examples/accelerate/accelerate_torch_trainer.py Outdated Show resolved Hide resolved
python/ray/train/examples/accelerate/accelerate_torch_trainer.py Outdated Show resolved Hide resolved
python/ray/train/examples/pytorch/torch_fashion_mnist_example.py Outdated Show resolved Hide resolved
python/ray/train/examples/pytorch/torch_fashion_mnist_example.py Outdated Show resolved Hide resolved
python/ray/train/examples/pytorch/torch_fashion_mnist_example.py Outdated Show resolved Hide resolved
python/ray/train/examples/transformers/transformers_torch_trainer_basic.py Outdated Show resolved Hide resolved
python/ray/train/examples/transformers/transformers_torch_trainer_basic.py Outdated Show resolved Hide resolved
python/ray/train/torch/torch_trainer.py Outdated Show resolved Hide resolved
python/ray/train/torch/torch_trainer.py Outdated Show resolved Hide resolved
python/ray/train/torch/torch_trainer.py Outdated Show resolved Hide resolved
@angelinalg
Apply suggestions from code review
0d35ba9 
Reverting changes to docstrings

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
woshiyyya
woshiyyya approved these changes Sep 13, 2023
View reviewed changes
Copy link
Member

@woshiyyya woshiyyya left a comment

Choose a reason for hiding this comment

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

Looks good to me. I left some minor comments.
Thanks again and these greatly improved the quality and readability of our doc!

.github/styles/Vocab/Train/accept.txt
@@ -1,5 +1,5 @@
Horovod
Hugging Face
hyperparameters?
Copy link
Member

Choose a reason for hiding this comment

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

do we need to have the question mark here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe this is a regex that matches "hyperparameter" and "hyperparameters"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bveeramani - would you be able to confirm that this is the correcct syntax?

Copy link
Member

Choose a reason for hiding this comment

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

The quotation mark means the "s" is optional.

You might also want to add a "$" to the end (hyperparameters?$) to avoid matching words like "hyperparametere"

doc/source/train/distributed-tensorflow-keras.rst Outdated Show resolved Hide resolved
doc/source/train/distributed-xgboost-lightgbm.rst Show resolved Hide resolved
doc/source/train/examples/pytorch/dreambooth_finetuning.rst Outdated Show resolved Hide resolved
doc/source/train/getting-started-transformers.rst Show resolved Hide resolved
doc/source/train/examples/transformers/huggingface_text_classification.ipynb Outdated Show resolved Hide resolved
@angelinalg angelinalg changed the title [WIP][docs][train]Make Train example titles, heading more consistent [docs][train]Make Train example titles, heading more consistent Sep 13, 2023
angelinalg and others added 2 commits September 12, 2023 21:05
@angelinalg @woshiyyya
Apply suggestions from code review
29c9358 
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg @woshiyyya
Update doc/source/train/examples/transformers/huggingface_text_classi…
2fc77b7 
…fication.ipynb

Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
matthewdeng
matthewdeng approved these changes Sep 13, 2023
View reviewed changes
Copy link
Contributor

@matthewdeng matthewdeng left a comment

Choose a reason for hiding this comment

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

Love this!!

doc/source/train/examples/deepspeed/deepspeed_example.rst Outdated Show resolved Hide resolved
doc/source/train/examples/accelerate/accelerate_example.rst Outdated Show resolved Hide resolved
doc/source/train/examples/lightning/lightning_cola_advanced.ipynb Outdated Show resolved Hide resolved
doc/source/train/examples/deepspeed/deepspeed_example.rst Outdated Show resolved Hide resolved
doc/source/train/examples/pytorch/dreambooth_finetuning.rst Outdated Show resolved Hide resolved
doc/source/train/examples/pytorch/dreambooth_finetuning.rst Outdated Show resolved Hide resolved
doc/source/train/huggingface-accelerate.rst Outdated Show resolved Hide resolved
doc/source/train/examples.rst Outdated Show resolved Hide resolved
angelinalg and others added 4 commits September 13, 2023 10:00
@angelinalg @matthewdeng
Apply suggestions from code review
82db390 
feedback from code review

Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
change button text to with instead of and to be consistent with other…
264223c 
… buttons

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@angelinalg
Merge branch 'master' into train-examples
55f348f
@angelinalg
Merge branch 'master' into train-examples
6368840 
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@matthewdeng matthewdeng merged commit 4ed4b52 into ray-project:master Sep 14, 2023
100 of 108 checks passed
@angelinalg angelinalg deleted the train-examples branch September 14, 2023 01:43
angelinalg added a commit to angelinalg/ray that referenced this pull request Sep 14, 2023
@angelinalg @woshiyyya @matthewdeng
[docs][train]Make Train example titles, heading more consistent (ray-…
c70eceb 
…project#39606)

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
@angelinalg angelinalg mentioned this pull request Sep 14, 2023
Merged
8 tasks
GeneDer pushed a commit that referenced this pull request Sep 14, 2023
@angelinalg @woshiyyya @matthewdeng
[docs][cherry-pick] Doc updates for Train (#39657)
8cfb98a 
* [Doc] Fix Title of the Transformers GLUE example (#39605)

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>

* [docs][train]Make Train example titles, heading more consistent (#39606)

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>

* [docs][clusters] Change title of RayService doc to Deploy Ray Serve Apps (#39641)

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>

---------

Signed-off-by: woshiyyya <xiaoyunxuan1998@gmail.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Co-authored-by: Yunxuan Xiao <yunxuanx@anyscale.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
simonsays1980 pushed a commit to simonsays1980/ray that referenced this pull request Sep 15, 2023
@angelinalg @woshiyyya
@matthewdeng @simonsays1980
[docs][train]Make Train example titles, heading more consistent (ray-…
544d34c 
…project#39606)

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
@angelinalg @woshiyyya @matthewdeng
[docs][train]Make Train example titles, heading more consistent (ray-…
8c7b507 
…project#39606)

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Co-authored-by: Yunxuan Xiao <xiaoyunxuan1998@gmail.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: Victor <vctr.y.m@example.com>
@rickyyx rickyyx mentioned this pull request Oct 24, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bveeramani bveeramani bveeramani left review comments

@woshiyyya woshiyyya woshiyyya approved these changes

@matthewdeng matthewdeng matthewdeng approved these changes

@richardliaw richardliaw Awaiting requested review from richardliaw

@krfricke krfricke Awaiting requested review from krfricke

@xwjiang2010 xwjiang2010 Awaiting requested review from xwjiang2010

@amogkam amogkam Awaiting requested review from amogkam

@Yard1 Yard1 Awaiting requested review from Yard1

@maxpumperla maxpumperla Awaiting requested review from maxpumperla

Assignees

@woshiyyya woshiyyya

Labels
docs An issue or change related to documentation train Ray Train Related Issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

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