Skip to content

Add tutorial for resolves#405

Merged
pulsipher merged 22 commits intomasterfrom
resolveTutorial
Jan 10, 2026
Merged

Add tutorial for resolves#405
pulsipher merged 22 commits intomasterfrom
resolveTutorial

Conversation

@wenwen0231
Copy link
Collaborator

This PR aims to add a comprehensive tutorial on how to setup efficient resolves on CPU & GPU.

@codecov
Copy link

codecov bot commented Dec 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.77%. Comparing base (d714461) to head (922e277).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #405   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          38       38           
  Lines        6586     6586           
=======================================
  Hits         6571     6571           
  Misses         15       15           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pulsipher
Copy link
Collaborator

Please get the docs to pass, so I can review

Copy link
Collaborator

@pulsipher pulsipher left a comment

Choose a reason for hiding this comment

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

See comments below. We need to be more careful with the math notation and I think we need to clearly define and discuss what the re-solve interface is at the beginning before diving into the example. Subsections for all the different definition steps is probably also unnecessary and distracts from the key focuses. The underlying use of transformation backends should also be made more clear since this is a key piece of information to contextualize what is happening.

Copy link
Collaborator

@pulsipher pulsipher left a comment

Choose a reason for hiding this comment

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

Almost there, my comments are mostly minor now. The major item left is improving the diagram.

@pulsipher
Copy link
Collaborator

pulsipher commented Dec 19, 2025

Also, is there a way to avoid using DifferentialEquations in this tutorial? Including it, increases the documentation build time to 15 minutes (up from 7 minutes). Since we only do one re-solve, perhaps we can just provide manual measurements and say one could use DifferentialEquations, but we don't run it in the documentation to minimize precompilation time.

Copy link
Collaborator

@pulsipher pulsipher left a comment

Choose a reason for hiding this comment

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

See below

Copy link
Collaborator

@pulsipher pulsipher left a comment

Choose a reason for hiding this comment

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

This is looking great now, just one final tweak and it'll be there.

Copy link
Collaborator

@pulsipher pulsipher left a comment

Choose a reason for hiding this comment

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

Ok, another minor thing would be that we should not display the solver output, because this may change over time with different versions which will be annoying to maintain. Let's set it to silent and instead make generic queries. You can query the number of iterations via barrier_iterations(model)

@pulsipher pulsipher merged commit c6c6cf7 into master Jan 10, 2026
10 checks passed
@pulsipher pulsipher deleted the resolveTutorial branch January 10, 2026 23:01
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