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

[RLlib][Docs] Restructure Utils API page #33358

Merged
merged 25 commits into from
Mar 22, 2023
Merged

[RLlib][Docs] Restructure Utils API page #33358

merged 25 commits into from
Mar 22, 2023

Conversation

kouroshHakha
Copy link
Contributor

Why are these changes needed?

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

@kouroshHakha
wip utils
0212e84 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
@kouroshHakha
Merge branch 'master' into doc-24-utils
75d3718
@kouroshHakha
Merge branch 'master' into doc-24-utils
61a9794 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
@kouroshHakha
wip
88400e2 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
kouroshHakha and others added 2 commits March 21, 2023 11:19
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
2dd99d5 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
b3f1063 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
b0c4d5e 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
kouroshHakha and others added 5 commits March 21, 2023 13:19
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
80bd60a 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
7930872 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
a32599e 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha
wip
fa61634 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
@kouroshHakha
Merge branch 'doc-24-utils' of github.com:kouroshHakha/ray into doc-2…
a3e5096 
…4-utils
kouroshHakha and others added 3 commits March 21, 2023 13:22
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
afd2bc4 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
2b23581 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
4219ffa 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@angelinalg
Copy link
Contributor

I made a best attempt to make the capitalization of titles consistent. Headings with ---- are title case and headings with ~~~~ are sentence case. If you feel strongly about all titles being title case, you can change them back. My advice is to be consistent with the rest of the docs.

kouroshHakha and others added 9 commits March 21, 2023 16:41
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
b145188 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
25836f1 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
4c05894 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
acdadd9 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
7a50290 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
e317706 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
8cb0130 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@kouroshHakha @angelinalg
Update doc/source/rllib/package_ref/utils.rst
9ebb06b 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: kourosh hakhamaneshi <31483498+kouroshHakha@users.noreply.github.com>
@angelinalg
Update doc/source/rllib/package_ref/utils.rst
425b780 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Jun Gong <gongjunoliver@hotmail.com>
@gjoliver gjoliver merged commit 61ae049 into ray-project:master Mar 22, 2023
edoakes pushed a commit to edoakes/ray that referenced this pull request Mar 22, 2023
@kouroshHakha @edoakes
[RLlib][Docs] Restructure Utils API page (ray-project#33358)
db97028 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
elliottower pushed a commit to elliottower/ray that referenced this pull request Apr 22, 2023
@kouroshHakha @elliottower
[RLlib][Docs] Restructure Utils API page (ray-project#33358)
ee13850 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
Signed-off-by: elliottower <elliot@elliottower.com>
ProjectsByJackHe pushed a commit to ProjectsByJackHe/ray that referenced this pull request May 4, 2023
@kouroshHakha @ProjectsByJackHe
[RLlib][Docs] Restructure Utils API page (ray-project#33358)
274bc07 
Signed-off-by: Kourosh Hakhamaneshi <kourosh@anyscale.com>
Signed-off-by: Jack He <jackhe2345@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angelinalg angelinalg angelinalg left review comments

@gjoliver gjoliver gjoliver approved these changes

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

@avnishn avnishn Awaiting requested review from avnishn

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst

@smorad smorad Awaiting requested review from smorad

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

@krfricke krfricke Awaiting requested review from krfricke

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kouroshHakha @angelinalg @gjoliver