Skip to content

Create MLJ standard docstrings for all Nearest Neighbor models#53

Merged
ablaom merged 6 commits intodevfrom
docstring
Mar 21, 2023
Merged

Create MLJ standard docstrings for all Nearest Neighbor models#53
ablaom merged 6 commits intodevfrom
docstring

Conversation

@OkonSamuel
Copy link
Copy Markdown
Member

@OkonSamuel OkonSamuel commented Mar 14, 2023

Addresses #51

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 14, 2023

Codecov Report

Merging #53 (f83ca08) into dev (ea14cce) will decrease coverage by 0.24%.
The diff coverage is 50.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##              dev      #53      +/-   ##
==========================================
- Coverage   93.16%   92.92%   -0.24%     
==========================================
  Files           4        3       -1     
  Lines         395      396       +1     
==========================================
  Hits          368      368              
- Misses         27       28       +1     
Impacted Files Coverage Δ
src/models.jl 91.58% <50.00%> (-0.42%) ⬇️

... and 1 file with indirect coverage changes

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

Copy link
Copy Markdown
Member

@ablaom ablaom left a comment

Choose a reason for hiding this comment

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

Great to have this @OkonSamuel .

Apart from the comments above:

  • We need to move the docstrings so that they occur after the metadata declaration because the docstring header interpolator is not working:
A model type for constructing a multitarget knn regressor, based on unknown.jl (unknown), and implementing
  the MLJ model interface.
  • I suggest we declare human_name traits, eg
    human_name = "K-nearest neighbor classifier" to make the doc header read better.

OkonSamuel and others added 3 commits March 20, 2023 17:03
Co-authored-by: Anthony Blaom, PhD <anthony.blaom@gmail.com>
Co-authored-by: Anthony Blaom, PhD <anthony.blaom@gmail.com>
Copy link
Copy Markdown
Member

@ablaom ablaom left a comment

Choose a reason for hiding this comment

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

Thanks again for this.

@ablaom ablaom merged commit 4c2fa46 into dev Mar 21, 2023
@ablaom ablaom mentioned this pull request Mar 21, 2023
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