[Tune] Update BayesOptSearch docs
#49848
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: till-m <musertill@gmail.com>
hongpeng-guo
approved these changes
Jan 21, 2025
There was a problem hiding this comment.
Thank you so much for fixing the doc string. It looks good to me. cc @matthewdeng @justinvyu for merging.
BayesOptSearch docsBayesOptSearch docs
win5923
pushed a commit
to win5923/ray
that referenced
this pull request
Jan 23, 2025
The current documentation of the `BayesOptSearch` is incomplete/wrong. - It doesn't specify the version of the package which should be installed (`1.4.3` as far as I can tell: link) - There is a link to an example notebook, but it is not version pinned, instead pointing to `master`. - References to the repo are still going to @fmfn's personal repository and not the the organization repository. Signed-off-by: till-m <musertill@gmail.com>
simonsays1980
pushed a commit
to simonsays1980/ray
that referenced
this pull request
Jan 23, 2025
The current documentation of the `BayesOptSearch` is incomplete/wrong. - It doesn't specify the version of the package which should be installed (`1.4.3` as far as I can tell: link) - There is a link to an example notebook, but it is not version pinned, instead pointing to `master`. - References to the repo are still going to @fmfn's personal repository and not the the organization repository. Signed-off-by: till-m <musertill@gmail.com>
anson627
pushed a commit
to anson627/ray
that referenced
this pull request
Jan 31, 2025
The current documentation of the `BayesOptSearch` is incomplete/wrong. - It doesn't specify the version of the package which should be installed (`1.4.3` as far as I can tell: link) - There is a link to an example notebook, but it is not version pinned, instead pointing to `master`. - References to the repo are still going to @fmfn's personal repository and not the the organization repository. Signed-off-by: till-m <musertill@gmail.com> Signed-off-by: Anson Qian <anson627@gmail.com>
anson627
pushed a commit
to anson627/ray
that referenced
this pull request
Jan 31, 2025
The current documentation of the `BayesOptSearch` is incomplete/wrong. - It doesn't specify the version of the package which should be installed (`1.4.3` as far as I can tell: link) - There is a link to an example notebook, but it is not version pinned, instead pointing to `master`. - References to the repo are still going to @fmfn's personal repository and not the the organization repository. Signed-off-by: till-m <musertill@gmail.com> Signed-off-by: Anson Qian <anson627@gmail.com>
srinathk10
pushed a commit
that referenced
this pull request
Feb 2, 2025
The current documentation of the `BayesOptSearch` is incomplete/wrong. - It doesn't specify the version of the package which should be installed (`1.4.3` as far as I can tell: link) - There is a link to an example notebook, but it is not version pinned, instead pointing to `master`. - References to the repo are still going to @fmfn's personal repository and not the the organization repository. Signed-off-by: till-m <musertill@gmail.com>
anyadontfly
pushed a commit
to anyadontfly/ray
that referenced
this pull request
Feb 13, 2025
The current documentation of the `BayesOptSearch` is incomplete/wrong. - It doesn't specify the version of the package which should be installed (`1.4.3` as far as I can tell: link) - There is a link to an example notebook, but it is not version pinned, instead pointing to `master`. - References to the repo are still going to @fmfn's personal repository and not the the organization repository. Signed-off-by: till-m <musertill@gmail.com> Signed-off-by: Puyuan Yao <williamyao034@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
The current documentation of the
BayesOptSearchis incomplete/wrong.1.4.3as far as I can tell: link)master.I've updated the docstrings. The PR is untested, as I assume the docstring change should not affect tests passing.
NB: I am a member of bayesian-optimization.
Related issue number
see also #49845
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.