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.

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

Automatically generate the intra doc links #246

Merged
merged 8 commits into from
Oct 11, 2022

Conversation

gkobeaga
Copy link
Contributor

Addresses #245

The doc links are changed from [comment](struct.StructName.html) to [comment](StructName).

I realized that the documentation for TweedieRegressor was not generating. To fix it and to match the public API of linfa-linear with the other crates (e.g. KMeans and KMeansParams from linfa_clustering), I made the following changes:

  • The documentation for TweedieRegressorValidParams (which is not public), is moved for TweedieRegressor
  • TweedieRegressorParams is now public

Small fixes:

  • FittedCountVectorizer -> CountVectorizer in linfa-preprocessing

@YuhanLiin
Copy link
Collaborator

YuhanLiin commented Sep 30, 2022

I think TweedieRegressorValidParams should also be made public.

Also, do you mind setting #![deny(rustdoc::broken_intra_doc_links)] for the crates to see if it catches broken links?

@codecov-commenter
Copy link

codecov-commenter commented Oct 5, 2022

Codecov Report

Base: 39.22% // Head: 55.42% // Increases project coverage by +16.19% 🎉

Coverage data is based on head (399298e) compared to base (bf0d362).
Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff             @@
##           master     #246       +/-   ##
===========================================
+ Coverage   39.22%   55.42%   +16.19%     
===========================================
  Files          92       96        +4     
  Lines        6085     8936     +2851     
===========================================
+ Hits         2387     4953     +2566     
- Misses       3698     3983      +285     
Impacted Files Coverage Δ
...ms/linfa-clustering/src/appx_dbscan/hyperparams.rs 7.89% <ø> (ø)
...orithms/linfa-clustering/src/dbscan/hyperparams.rs 0.00% <ø> (ø)
...linfa-clustering/src/gaussian_mixture/algorithm.rs 55.88% <ø> (+12.66%) ⬆️
...nfa-clustering/src/gaussian_mixture/hyperparams.rs 33.33% <ø> (ø)
...rithms/linfa-clustering/src/k_means/hyperparams.rs 44.06% <ø> (+10.73%) ⬆️
...orithms/linfa-clustering/src/optics/hyperparams.rs 26.47% <ø> (ø)
algorithms/linfa-linear/src/glm/hyperparams.rs 12.96% <ø> (+1.85%) ⬆️
algorithms/linfa-linear/src/glm/mod.rs 55.55% <ø> (+2.77%) ⬆️
algorithms/linfa-logistic/src/lib.rs 67.94% <ø> (+20.45%) ⬆️
algorithms/linfa-nn/src/balltree.rs 56.80% <ø> (+2.41%) ⬆️
... and 67 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@gkobeaga
Copy link
Contributor Author

gkobeaga commented Oct 5, 2022

Instead of adding #![deny(rustdoc::broken_intra_doc_links)] for the crates, how about checking the broken links in the CI? I tested it with c00c9af, and the CI is failing now for that commit.

I also added the --workspace flag to cargo doc in the CI to build the documents of all the crates.

TweedieRegressorValidParams is public now, as you suggested.

@YuhanLiin YuhanLiin merged commit 5ebe23c into rust-ml:master Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants