Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

[doc] Add auto-generated docs #279

Merged
merged 2 commits into from
Oct 30, 2023
Merged

Conversation

justinvyu
Copy link
Contributor

@justinvyu justinvyu commented Oct 28, 2023

Adds auto-generated docs to make this library self-sufficient rather than relying on links in the ray docs -- those will soon be removed. Uses lazydocs and relies on a recompilation on every release for now. Can add an automation in the future.

See here.

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Copy link

@matthewdeng matthewdeng left a comment

Choose a reason for hiding this comment

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

I've never heard of lazydocs before, this is nice!

@@ -191,5 +191,16 @@ Tune-sklearn also supports the use of other machine learning libraries such as P
* [Pytorch (Skorch)](https://github.com/ray-project/tune-sklearn/blob/master/examples/torch_nn.py)
* [XGBoost](https://github.com/ray-project/tune-sklearn/blob/master/examples/xgbclassifier.py)

## [Documentation](docs)

Choose a reason for hiding this comment

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

Is this expected to have a link to the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it's a working link to the docs overview page

@justinvyu justinvyu merged commit f309725 into ray-project:master Oct 30, 2023
3 checks passed
@justinvyu justinvyu deleted the add_docs branch October 30, 2023 16:55
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants