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.

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]copy edits and adding links to docstrings #39617

Merged
merged 4 commits into from
Oct 20, 2023

Conversation

angelinalg
Copy link
Contributor

Fixing style issues and adding links to our new content, like get started guides and key concepts in the Overview.

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

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 labels Sep 13, 2023
Comment on lines 26 to 28
For more details, see :ref:`PyTorch Guide <train-pytorch>`,
:ref:`PyTorch Lightning Guide <train-pytorch-lightning>`,
or :ref:`Hugging Face Transformers Guide <train-pytorch-transformers>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Change this to list format?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good call!

Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@stale
Copy link

stale bot commented Oct 15, 2023

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

  • If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@stale stale bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Oct 15, 2023
@stale stale bot removed the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Oct 20, 2023
@aslonnie aslonnie merged commit a2f0a63 into ray-project:master Oct 20, 2023
26 of 29 checks passed
volks73 pushed a commit to volks73/ray that referenced this pull request Oct 22, 2023
…9617)

Fixing style issues and adding links to our new content, like get started guides and key concepts in the Overview.

Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Christopher Field <chris.field@theiascientific.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation train Ray Train Related Issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants