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

Add docstrings! #209

Merged
merged 7 commits into from
Aug 22, 2022
Merged

Add docstrings! #209

merged 7 commits into from
Aug 22, 2022

Conversation

josephsdavid
Copy link
Contributor

With code cleaned up and (hopefully) working CI!

@codecov-commenter
Copy link

codecov-commenter commented Jul 12, 2022

Codecov Report

Merging #209 (8aaa88f) into dev (b3fa3a8) will increase coverage by 0.75%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev     #209      +/-   ##
==========================================
+ Coverage   92.27%   93.03%   +0.75%     
==========================================
  Files           9        9              
  Lines         246      244       -2     
==========================================
  Hits          227      227              
+ Misses         19       17       -2     
Impacted Files Coverage Δ
src/classifier.jl 100.00% <ø> (ø)
src/image.jl 100.00% <ø> (ø)
src/regressor.jl 100.00% <ø> (ø)
src/types.jl 100.00% <ø> (+14.28%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b3fa3a8...8aaa88f. Read the comment docs.

src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
src/types.jl Show resolved Hide resolved
src/types.jl Outdated Show resolved Hide resolved
Copy link
Collaborator

@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 work. You have erred on the verbose side, which has made it easier to review 😉 . Please make the cuts suggested in annotations. Some of these could go into separate MLJFlux documentation (replacing current readme) but we'll need to come back to that later.

It's very nice to have the builder illustrations. One comment: I think we could use the macro for all of them, to save defining extra structs. In some models (classifiers?) you are still using the explicit definitions. And be sure to test all examples. They should be self-contained.

@ablaom ablaom merged commit ab5c3e1 into FluxML:dev Aug 22, 2022
@ablaom
Copy link
Collaborator

ablaom commented Aug 22, 2022

Thanks @josephsdavid for your valuable contribution. 🎆

@ablaom ablaom mentioned this pull request Aug 22, 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