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

Revamp documentation #276

Merged
merged 11 commits into from
May 27, 2024
Merged

Revamp documentation #276

merged 11 commits into from
May 27, 2024

Conversation

gdalle
Copy link
Owner

@gdalle gdalle commented May 27, 2024

Preview links:

DI compat

  • Bump version to 0.4.2

DI source

  • Add more details to operator docstrings

DI docs

  • Split the tutorial into "Basics" and "Sparsity"
  • Add more details to the overview, renamed as "Operators"
  • Add a page on "Preparation" detailing the choices in each backend
  • Restructure the "API" page to have fewer sections

DIT docs

  • Adjust the link to the DI docs
  • Replace @repl with @example in the tutorial

@codecov-commenter
Copy link

codecov-commenter commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.81%. Comparing base (dc317b0) to head (3fd9caa).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #276   +/-   ##
=======================================
  Coverage   96.81%   96.81%           
=======================================
  Files          72       72           
  Lines        3740     3740           
=======================================
  Hits         3621     3621           
  Misses        119      119           

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

@gdalle gdalle linked an issue May 27, 2024 that may be closed by this pull request
@gdalle gdalle merged commit 170a729 into main May 27, 2024
32 checks passed
@gdalle gdalle deleted the gd/tutorials branch May 27, 2024 18:03
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.

Clarify documentation on sparse second-order differentiation
2 participants