-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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.
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
[docs][train]Make Train example titles, heading more consistent #39606
Conversation
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
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
Reverting changes to docstrings Signed-off-by: angelinalg <[email protected]>
There was a problem hiding this 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!
@@ -1,5 +1,5 @@ | |||
Horovod | |||
Hugging Face | |||
hyperparameters? |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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/examples/transformers/huggingface_text_classification.ipynb
Outdated
Show resolved
Hide resolved
Co-authored-by: Yunxuan Xiao <[email protected]> Signed-off-by: angelinalg <[email protected]>
…fication.ipynb Co-authored-by: Yunxuan Xiao <[email protected]> Signed-off-by: angelinalg <[email protected]>
There was a problem hiding this 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/lightning/lightning_cola_advanced.ipynb
Outdated
Show resolved
Hide resolved
feedback from code review Co-authored-by: matthewdeng <[email protected]> Signed-off-by: angelinalg <[email protected]>
… buttons Signed-off-by: angelinalg <[email protected]>
Signed-off-by: angelinalg <[email protected]>
…project#39606) Signed-off-by: angelinalg <[email protected]> Co-authored-by: Yunxuan Xiao <[email protected]> Co-authored-by: matthewdeng <[email protected]>
* [Doc] Fix Title of the Transformers GLUE example (#39605) Signed-off-by: woshiyyya <[email protected]> * [docs][train]Make Train example titles, heading more consistent (#39606) Signed-off-by: angelinalg <[email protected]> Co-authored-by: Yunxuan Xiao <[email protected]> Co-authored-by: matthewdeng <[email protected]> * [docs][clusters] Change title of RayService doc to Deploy Ray Serve Apps (#39641) Signed-off-by: angelinalg <[email protected]> --------- Signed-off-by: woshiyyya <[email protected]> Signed-off-by: angelinalg <[email protected]> Co-authored-by: Yunxuan Xiao <[email protected]> Co-authored-by: Yunxuan Xiao <[email protected]> Co-authored-by: matthewdeng <[email protected]>
…project#39606) Signed-off-by: angelinalg <[email protected]> Co-authored-by: Yunxuan Xiao <[email protected]> Co-authored-by: matthewdeng <[email protected]>
…project#39606) Signed-off-by: angelinalg <[email protected]> Co-authored-by: Yunxuan Xiao <[email protected]> Co-authored-by: matthewdeng <[email protected]> Signed-off-by: Victor <[email protected]>
Make examples more consistent:
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.