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

Simplify tutorial and README #216

Merged
merged 8 commits into from
Apr 26, 2024
Merged

Simplify tutorial and README #216

merged 8 commits into from
Apr 26, 2024

Conversation

adrhill
Copy link
Collaborator

@adrhill adrhill commented Apr 25, 2024

  • replace @repl blocks by @example blocks to reduce visual noise (fewer julia>, ; and newlines)
  • this is me being opinionated, but I opted for using ADTypes instead of import ADTypes
  • use several backends in README example to make the point of this package overly obvious
  • minor additions to tutorial

@codecov-commenter
Copy link

codecov-commenter commented Apr 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.60%. Comparing base (0f71a42) to head (de68eaa).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #216   +/-   ##
=======================================
  Coverage   95.60%   95.60%           
=======================================
  Files          73       73           
  Lines        3820     3820           
=======================================
  Hits         3652     3652           
  Misses        168      168           

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

DifferentiationInterface/README.md Outdated Show resolved Hide resolved
DifferentiationInterface/docs/src/tutorial.md Show resolved Hide resolved
DifferentiationInterface/docs/src/tutorial.md Outdated Show resolved Hide resolved
DifferentiationInterface/docs/src/tutorial.md Outdated Show resolved Hide resolved
DifferentiationInterface/docs/src/tutorial.md Show resolved Hide resolved
@adrhill
Copy link
Collaborator Author

adrhill commented Apr 25, 2024

I will make some more changes to this once #217 is merged.

@gdalle
Copy link
Member

gdalle commented Apr 26, 2024

it is merged, you can track all the places in the docs where ADTypes is used and remove them

@adrhill
Copy link
Collaborator Author

adrhill commented Apr 26, 2024

Ready for review!

@adrhill
Copy link
Collaborator Author

adrhill commented Apr 26, 2024

@gdalle A test on coloring currently fails:

Coloring: Test Failed at /home/runner/work/DifferentiationInterface.jl/DifferentiationInterface.jl/DifferentiationInterface/test/coloring.jl:11
  Expression: maximum(row_colors) < size(A, 1) ÷ 2
   Evaluated: 51 < 50

Stacktrace:
  [1] macro expansion
    @ /opt/hostedtoolcache/julia/1.10.2/x64/share/julia/stdlib/v1.10/Test/src/Test.jl:672 [inlined]
  [2] top-level scope
    @ ~/work/DifferentiationInterface.jl/DifferentiationInterface.jl/DifferentiationInterface/test/coloring.jl:508

@gdalle
Copy link
Member

gdalle commented Apr 26, 2024

It's a randomized test, should nearly never fail. Fix the seed and call it a day for now

DifferentiationInterface/docs/src/tutorial.md Outdated Show resolved Hide resolved
DifferentiationInterface/README.md Outdated Show resolved Hide resolved
DifferentiationInterface/README.md Outdated Show resolved Hide resolved
@adrhill adrhill merged commit 0047722 into main Apr 26, 2024
5 checks passed
@adrhill adrhill deleted the ah/tutorial branch April 26, 2024 16:58
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.

3 participants