pyPESTO icon indicating copy to clipboard operation
pyPESTO copied to clipboard

Gradient check example

Open m-philipps opened this issue 1 year ago • 2 comments
trafficstars

  • add a documentation example for performing gradient checks (closes #1481)
  • fix #1494

I'd be happy about suggestions on the "Best practices" and "How to fix my gradients".

m-philipps avatar Oct 20 '24 21:10 m-philipps

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.51%. Comparing base (5ec891d) to head (df580c3).

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

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1497      +/-   ##
===========================================
- Coverage    84.57%   84.51%   -0.06%     
===========================================
  Files          163      163              
  Lines        14006    14006              
===========================================
- Hits         11845    11837       -8     
- Misses        2161     2169       +8     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: 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.

codecov-commenter avatar Oct 20 '24 21:10 codecov-commenter

I think I would just skip over check_grad and directly introduce check_grad_multi_eps. The latter performs much better.

I agree that check_grad_multi_eps is convenient to use in practice; I like showcasing check_grad first to build it up like a tutorial, such that it is easier to understand what check_grad_multi_eps is doing for people who aren't so familiar with gradient checks. I'm also fine with changing it though.

m-philipps avatar Oct 22 '24 00:10 m-philipps