Update docstrings of basic.jl and conv.jl#1978
Merged
ToucheSir merged 21 commits intoFluxML:masterfrom Jun 27, 2022
Merged
Conversation
ToucheSir
reviewed
May 27, 2022
mcabbott
reviewed
May 27, 2022
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1978 +/- ##
=======================================
Coverage 87.10% 87.10%
=======================================
Files 20 20
Lines 1528 1528
=======================================
Hits 1331 1331
Misses 197 197 ☔ View full report in Codecov by Sentry. |
mcabbott
reviewed
May 28, 2022
mcabbott
reviewed
May 28, 2022
Saransh-cpp
force-pushed
the
some-docstrings
branch
from
4635520 to
8ca109f
Compare
Saransh-cpp
commented
May 30, 2022
Saransh-cpp
changed the title
basic.jl and conv.jl
ToucheSir
reviewed
Jun 8, 2022
Shorten docstrings
Co-authored-by: Brian Chen <[email protected]>
Co-authored-by: Brian Chen <[email protected]>
Fix docstrings for different conv layers
Co-authored-by: Brian Chen <[email protected]>
Co-authored-by: Michael Abbott <[email protected]>
Co-authored-by: Michael Abbott <[email protected]>
Co-authored-by: Brian Chen <[email protected]>
Saransh-cpp
force-pushed
the
some-docstrings
branch
from
9c3a3b4 to
1dc6910
Compare
Member
Author
|
Moved the normalisation layers to #1995 |
ToucheSir
reviewed
Jun 14, 2022
Co-authored-by: Brian Chen <[email protected]>
ToucheSir
approved these changes
Jun 16, 2022
Member
ToucheSir
left a comment
ToucheSir
left a comment
There was a problem hiding this comment.
Ok, this looks to be in a good place. I'm going to give it another day or so and then merge :)
Member
Author
|
Thank you for the reviews! Is this ready to be merged? |
Member
|
Yes it is, sorry it fell through the cracks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi everyone! Super excited to work on Flux's documentation as a JSoC student! This PR begins the first phase of my work, mainly auditing the documentation, fixing the outdated documentation, adding missing docstrings, and adding doctests to every docstring.
Summarising this PR, I have added missing docstrings, updated the existing ones, and added some doctests in the following files -
basics.jlconv.jlThere are some minor changes in
normalise.jlbut I will be taking that complete file with some other files in the next PR. Or I can update all the files in this PR altogether, whichever method is easier to review :)cc: @DhairyaLGandhi and all other community members!
PR Checklist