ray-project / ray

Ray is an AI compute engine. Ray consists of a core distributed runtime and a set of AI Libraries for accelerating ML workloads.
https://ray.io
Apache License 2.0
34k stars 5.78k forks source link

[Doc][Tune] Add a docstring example for `tune.sample_from` #33483

Open justinvyu opened 1 year ago

justinvyu commented 1 year ago

Description

Show conditional search space example, currently there's no example in the docs on this.

Link

https://docs.ray.io/en/latest/tune/api/doc/ray.tune.sample_from.html#ray-tune-sample-from

gjoliver commented 1 year ago

good issue. can I expand on this suggest we add a reference page for all the search space operators available? I noticed from doing on-call that for example users are always confused between random_int() vs grid_search(). it would be nice to have a page, listing all the primitives we have, and compare the differences between them.

justinvyu commented 1 year ago

Does this page do the job? https://docs.ray.io/en/latest/tune/api/search_space.html @gjoliver