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

[tune] Improve docstring for tune.grid_search() #31793

Merged
merged 4 commits into from
Jan 20, 2023
Merged

[tune] Improve docstring for tune.grid_search() #31793

merged 4 commits into from
Jan 20, 2023

Conversation

krfricke
Copy link
Contributor

Signed-off-by: Kai Fricke [email protected]

Why are these changes needed?

The current docstring for tune.grid_search is lacking information and explanation. This PR adds proper documentation and an example.

Related issue number

Closes #29733

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

bveeramani
bveeramani approved these changes Jan 20, 2023
View reviewed changes
Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

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

LGTM! I remember being confused by grid_search when I first learned about it, so I think this'll be a great improvement.

python/ray/tune/search/variant_generator.py Outdated Show resolved Hide resolved
python/ray/tune/search/variant_generator.py Outdated Show resolved Hide resolved
Kai Fricke added 3 commits January 19, 2023 17:06
better phrasing
09c1a59 
Signed-off-by: Kai Fricke <[email protected]>
fix doc
8104b37 
Signed-off-by: Kai Fricke <[email protected]>
inline literals
d250a9d 
Signed-off-by: Kai Fricke <[email protected]>
@krfricke krfricke merged commit 0452d15 into ray-project:master Jan 20, 2023
@krfricke krfricke deleted the tune/clarify-grid branch January 20, 2023 19:36
andreapiso pushed a commit to andreapiso/ray that referenced this pull request Jan 22, 2023
@krfricke @andreapiso
[tune] Improve docstring for tune.grid_search() (ray-project#31793)
ff003ba 
The current docstring for `tune.grid_search` is lacking information and explanation. This PR adds proper documentation and an example.

Signed-off-by: Kai Fricke <[email protected]>
Signed-off-by: Andrea Pisoni <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bveeramani bveeramani bveeramani approved these changes

@xwjiang2010 xwjiang2010 Awaiting requested review from xwjiang2010

Assignees

@bveeramani bveeramani

@xwjiang2010 xwjiang2010

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Tune] tune.grid_search reference doesn't explain what a grid search is
3 participants
@krfricke @bveeramani @xwjiang2010