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

Cleaner and Better Documentation #56

Merged
merged 7 commits into from
Jun 19, 2022
Merged

Cleaner and Better Documentation #56

merged 7 commits into from
Jun 19, 2022

Conversation

avik-pal
Copy link
Member

@avik-pal avik-pal commented Jun 18, 2022

TODOs:

  • Use @doc doc for docstrings containing LaTeX
  • Shift to MKDocs Material theme (it is just prettier)
    • Can we make the functions more prominently highlighted?
    • Code highlighting?
  • Restructure Parts of the Documentation
  • Add docs for packages in lib/
  • Turn off draft mode before merging

@codecov
Copy link

codecov bot commented Jun 18, 2022

Codecov Report

Merging #56 (a6e0141) into main (ea5e73d) will increase coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main      #56      +/-   ##
==========================================
+ Coverage   48.37%   48.42%   +0.05%     
==========================================
  Files          13       13              
  Lines         955      954       -1     
==========================================
  Hits          462      462              
+ Misses        493      492       -1     
Impacted Files Coverage Δ
src/Lux.jl 100.00% <ø> (ø)
src/core.jl 60.46% <ø> (ø)
src/layers/basic.jl 54.40% <ø> (+0.28%) ⬆️
src/layers/conv.jl 47.11% <ø> (ø)
src/layers/dropout.jl 100.00% <ø> (ø)
src/layers/normalize.jl 33.64% <ø> (ø)
src/layers/recurrent.jl 100.00% <ø> (ø)
src/nnlib.jl 61.68% <ø> (ø)
src/utils.jl 51.80% <ø> (ø)

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 ea5e73d...a6e0141. Read the comment docs.


- `initialparameters(rng::AbstractRNG, layer::CustomAbstractExplicitLayer)` -- This
returns a `NamedTuple` containing the trainable parameters for the layer.
- `initialstates(rng::AbstractRNG, layer::CustomAbstractExplicitLayer)` -- This returns a
Copy link
Contributor

Choose a reason for hiding this comment

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

My understanding is that if my custom layer does not have a state then I don't need to implement this function? Since it is calling initialstates(::AbstractRNG, ::Any) = NamedTuple()

@avik-pal avik-pal changed the title [WIP] Cleaner and Better Documentation Cleaner and Better Documentation Jun 19, 2022
@avik-pal avik-pal merged commit 1107fea into main Jun 19, 2022
@avik-pal avik-pal deleted the ap/docs-refined branch June 19, 2022 01:32
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.

2 participants