Skip to content

[docs] Tune overhaul part II#22656

Merged
richardliaw merged 37 commits intomasterfrom
mp_tune_part_2
Feb 27, 2022
Merged

[docs] Tune overhaul part II#22656
richardliaw merged 37 commits intomasterfrom
mp_tune_part_2

Conversation

@maxpumperla
Copy link
Contributor

@maxpumperla maxpumperla commented Feb 25, 2022

Preview: docs

Largely completes the Tune docs overhaul. Notable improvements:

  • Key concepts page improved.
  • Content deeply hidden in API docs now surfaced (either in guides or key concepts).
  • Feature guides now collectively under "user guides"
  • "Examples" are now all executable (.ipynb). Apart from the 8 good tutorials converted, we added 6 new ones.
  • There are barely any untested code snippets anymore. They are either included and tested, or are notebooks and tested.
  • Testing simplified. A bazel rule picks up all notebook examples and doc test snippets. New examples can now just be added by users without touching our CI (which is massive for adoption), at least for Tune.

Checks

  • 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.
  • Testing Strategy
    • Unit tests

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
@maxpumperla maxpumperla added the docs An issue or change related to documentation label Feb 25, 2022
@maxpumperla maxpumperla self-assigned this Feb 25, 2022
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.

Awesome work!

maxpumperla and others added 2 commits February 25, 2022 18:33
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
maxpumperla and others added 12 commits February 25, 2022 18:33
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
@maxpumperla maxpumperla requested a review from Yard1 February 25, 2022 18:20
@richardliaw
Copy link
Contributor

One nit is that the intro "pytorch optuna" code doesn't seem to run. Missing imports i think?

@maxpumperla
Copy link
Contributor Author

@richardliaw the example is too long to show in its entirety, but the snippet is tested. we could have a link to the full example though?

@richardliaw
Copy link
Contributor

richardliaw commented Feb 26, 2022 via email

@richardliaw richardliaw merged commit 372c620 into master Feb 27, 2022
@richardliaw richardliaw deleted the mp_tune_part_2 branch February 27, 2022 07:07
simonsays1980 pushed a commit to simonsays1980/ray that referenced this pull request Feb 27, 2022
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
@yingbaihu
Copy link

I have one question, can anybody help me?
In the example mlflow_ptl_example.rst
it imports ray.air, and use air.RunConfig command as a parameter in tune.Tuner,
is there any way that not use ray.air package? any replace function of air.RunConfig?

@richardliaw
Copy link
Contributor

richardliaw commented Mar 3, 2023 via email

@yingbaihu
Copy link

Whats the reason for that?

On Thu, Mar 2, 2023 at 12:06 PM yingbaihu @.> wrote: I have one question, can anybody help me? In the example mlflow_ptl_example.rst https://github.com/ray-project/ray/blob/master/doc/source/tune/examples/includes/mlflow_ptl_example.rst it imports ray.air, and use air.RunConfig command as a parameter in tune.Tuner, is there any way that not use ray.air package? any replace function of air.RunConfig? — Reply to this email directly, view it on GitHub <#22656 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABCRZZLE7O7HYJ2LXB3H4MDW2D4UTANCNFSM5PKG34KA . You are receiving this because you modified the open/close state.Message ID: @.>

Because my plan is only to use ray for optimization, so I just installed ray.tune package

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs An issue or change related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants