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] [Tune] ResultGrid Docs and API reference #28068

Merged
merged 6 commits into from
Aug 26, 2022

Conversation

amogkam
Copy link
Contributor

@amogkam amogkam commented Aug 23, 2022

Improve docstring for ResultGrid and show API reference and docstring in Tune API section.

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

Signed-off-by: Amog Kamsetty <[email protected]>
Copy link
Member

@Yard1 Yard1 left a comment

Choose a reason for hiding this comment

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

LGTM, some nits and a question

python/ray/tune/result_grid.py Outdated Show resolved Hide resolved
python/ray/tune/result_grid.py Outdated Show resolved Hide resolved
python/ray/tune/result_grid.py Outdated Show resolved Hide resolved
python/ray/tune/result_grid.py Outdated Show resolved Hide resolved
Signed-off-by: Amog Kamsetty <[email protected]>
Signed-off-by: Amog Kamsetty <[email protected]>
@amogkam amogkam merged commit 00f6273 into ray-project:master Aug 26, 2022
@amogkam amogkam deleted the result-grid-docs branch August 26, 2022 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants