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 user guides and API docs #7716

Merged
merged 10 commits into from
Apr 6, 2020
Merged

[tune] Improve user guides and API docs #7716

merged 10 commits into from
Apr 6, 2020

Conversation

richardliaw
Copy link
Contributor

@richardliaw richardliaw commented Mar 23, 2020 •
edited
Loading

Why are these changes needed?

Part of Tune documentation revamp.

Build the documentation by going to ray/doc and running make html.

Related issue number

Checks

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23603/
Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23908/
Test FAILed.

@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23913/
Test PASSed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/23967/
Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/24253/
Test FAILed.

@richardliaw richardliaw changed the title [wip][tune] Convert to gallery format [tune] Convert to gallery format Apr 5, 2020
@richardliaw richardliaw marked this pull request as ready for review April 5, 2020 03:14
@richardliaw richardliaw changed the title [tune] Convert to gallery format [tune] Improve user guides and API docs Apr 5, 2020
@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/24257/
Test PASSed.

@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/24258/
Test PASSed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/24262/
Test FAILed.

@richardliaw richardliaw added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Apr 5, 2020
sven1977
sven1977 reviewed Apr 6, 2020
View reviewed changes
Copy link
Contributor

@sven1977 sven1977 left a comment

Choose a reason for hiding this comment

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

Very nice! Just some suggestions/typos.

doc/source/tune/guides/plot_tune-tutorial.rst Outdated Show resolved Hide resolved
doc/source/tune/guides/plot_tune-distributed.rst Outdated Show resolved Hide resolved
doc/source/tune/guides/plot_tune-distributed.rst Outdated Show resolved Hide resolved
doc/source/tune/guides/plot_tune-advanced-tutorial.rst Outdated Show resolved Hide resolved
doc/source/tune/guides/plot_tune-advanced-tutorial.rst Outdated Show resolved Hide resolved
doc/source/tune/api_docs/grid_random.rst Outdated Show resolved Hide resolved
doc/source/tune/api_docs/grid_random.rst Outdated Show resolved Hide resolved
doc/source/tune/api_docs/grid_random.rst Outdated Show resolved Hide resolved
doc/source/tune/api_docs/grid_random.rst Outdated Show resolved Hide resolved
doc/source/tune/api_docs/analysis.rst Outdated Show resolved Hide resolved
richardliaw and others added 2 commits April 6, 2020 11:37
@richardliaw @sven1977
Apply suggestions from code review
5ec595e 
Co-Authored-By: Sven Mika <sven@anyscale.io>
@richardliaw @sven1977
Apply suggestions from code review
b56d2f3 
Co-Authored-By: Sven Mika <sven@anyscale.io>
@richardliaw
Copy link
Contributor Author

Fixed!

sven1977
sven1977 approved these changes Apr 6, 2020
View reviewed changes
Copy link
Contributor

@sven1977 sven1977 left a comment

Choose a reason for hiding this comment

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

👍

@richardliaw richardliaw merged commit a67edc4 into ray-project:master Apr 6, 2020
@richardliaw richardliaw deleted the tune-more-doc branch April 6, 2020 19:16
@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/24312/
Test PASSed.

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

@sven1977 sven1977 sven1977 approved these changes

@deanwampler deanwampler Awaiting requested review from deanwampler

@ujvl ujvl Awaiting requested review from ujvl

@bllchmbrs bllchmbrs Awaiting requested review from bllchmbrs

Assignees

@sven1977 sven1977

Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@richardliaw @AmplabJenkins @sven1977