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

Docs and Docstrings #383

Merged
merged 15 commits into from
Nov 21, 2024
Merged

Docs and Docstrings #383

merged 15 commits into from
Nov 21, 2024

Conversation

willtebbutt
Copy link
Member

@willtebbutt willtebbutt commented Nov 20, 2024

Following a discussion with @gdalle this morning, this PR

  • changes how the docs specified (rather than specifying section_name => file_name, just specifying file_name and letting Documenter.jl figure out the appropriate section_name itself from the title of the file)
  • making internal docstrings into comments
  • fixing any issues with docstrings
  • bump patch

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/Mooncake.jl 100.00% <ø> (ø)
src/fwds_rvs_data.jl 96.84% <ø> (ø)
src/interpreter/abstract_interpretation.jl 83.05% <ø> (ø)
src/interpreter/bbcode.jl 96.08% <100.00%> (+0.02%) ⬆️
src/interpreter/ir_normalisation.jl 85.60% <ø> (ø)
src/interpreter/ir_utils.jl 89.16% <100.00%> (+5.83%) ⬆️
src/interpreter/s2s_reverse_mode_ad.jl 92.07% <100.00%> (+0.01%) ⬆️
src/rrules/builtins.jl 97.21% <ø> (ø)
src/utils.jl 82.60% <ø> (ø)

🚨 Try these New Features:

Copy link
Contributor

github-actions bot commented Nov 20, 2024

Performance Ratio:
Ratio of time to compute gradient and time to compute function.
Warning: results are very approximate! See here for more context.

┌────────────────────────────┬──────────┬─────────┬─────────────┬─────────┐
│                      Label │ Mooncake │  Zygote │ ReverseDiff │  Enzyme │
│                     String │   String │  String │      String │  String │
├────────────────────────────┼──────────┼─────────┼─────────────┼─────────┤
│                   sum_1000 │     70.3 │     1.0 │        5.41 │ missing │
│                  _sum_1000 │     6.81 │  1420.0 │        34.1 │ missing │
│               sum_sin_1000 │      2.3 │    1.69 │        10.7 │ missing │
│              _sum_sin_1000 │     2.67 │   261.0 │        13.2 │ missing │
│                   kron_sum │     66.3 │    3.65 │       233.0 │ missing │
│              kron_view_sum │     49.9 │    8.18 │       201.0 │ missing │
│      naive_map_sin_cos_exp │     2.52 │ missing │        7.13 │ missing │
│            map_sin_cos_exp │     2.91 │    1.44 │        6.17 │ missing │
│      broadcast_sin_cos_exp │     2.63 │    2.26 │        1.46 │ missing │
│                 simple_mlp │     6.53 │    3.12 │        10.1 │ missing │
│                     gp_lml │     8.96 │    3.78 │     missing │ missing │
│ turing_broadcast_benchmark │     3.19 │ missing │        27.7 │ missing │
│         large_single_block │     4.01 │  4190.0 │        31.0 │ missing │
└────────────────────────────┴──────────┴─────────┴─────────────┴─────────┘

@gdalle
Copy link
Collaborator

gdalle commented Nov 20, 2024

Beware that once you add docstrings, Documenter will complain if they're not in the docs website somewhere.
I think the easiest fix is an autodocs bloc with Public=false on one of the dev documentation pages

@willtebbutt willtebbutt merged commit eaf1fb8 into main Nov 21, 2024
43 checks passed
@willtebbutt willtebbutt deleted the wct/tidy-up-docs branch November 21, 2024 10:10
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