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.

Sign up for GitHub

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

Jump to bottom

Documentation revamp #102

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Documentation revamp #102

wants to merge 9 commits into from

Conversation

BatyLeo
Copy link
Member

@BatyLeo BatyLeo commented Dec 12, 2023 •
edited

  • Use DocStringExtensions.jl
  • Separate API between specific problems, losses, optim layers and internals
  • Background page for math (optim + ML), focus on discrete functions rather than linear programs
    • explain chain rules
    • add math details on each feature
  • Guide for choosing the right tool (as in https://scikit-learn.org/stable/tutorial/machine_learning_map/index.html)
  • Lots of tutorials (remove GridGraphs from the graph tuto)
    • remove grid graphs from the graphs tutorial
    • add a tutorial with JuMP
    • showcase all features in the tutorial
    • demonstrate use of kwargs

@BatyLeo BatyLeo added the documentation Improvements or additions to documentation label Dec 12, 2023
@BatyLeo BatyLeo self-assigned this Dec 12, 2023
This was linked to issues Dec 12, 2023
Docs revamp #101
Open
Better documentation #70
Open
Clarify & demonstrate use of kwargs #56
Open
Explain chain rules #76
Open
@codecov-commenter
Copy link

codecov-commenter commented Dec 12, 2023 •
edited

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (5584bbe) 89.78% compared to head (20ff86e) 89.76%.
Report is 3 commits behind head on main.

Files Patch % Lines
src/perturbed/additive.jl 0.00% 2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #102      +/-   ##
==========================================
- Coverage   89.78%   89.76%   -0.02%     
==========================================
  Files          24       24              
  Lines         695      694       -1     
==========================================
- Hits          624      623       -1     
  Misses         71       71

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@BatyLeo BatyLeo

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs revamp Explain chain rules Better documentation Clarify & demonstrate use of kwargs
2 participants
@BatyLeo @codecov-commenter