-
-
Notifications
You must be signed in to change notification settings - Fork 486
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
pybamm.JaxSolver docstring improvement #3994
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, @buddhiwisr, a suggestion: could you also link to JAX's intersphinx inventory in the |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #3994 +/- ##
===========================================
+ Coverage 99.55% 99.58% +0.03%
===========================================
Files 288 257 -31
Lines 21789 21249 -540
===========================================
- Hits 21692 21161 -531
+ Misses 97 88 -9 ☔ View full report in Codecov by Sentry. |
@buddhiwisr Are you still on it? |
@arjxn-py I am not working on it anymore, afraid. |
Would you like to pick it up from here, @arjxn-py? Though the hackathon has passed, I think these contributions will still be useful |
Sure, I'd be happy to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs look correct now, but the example notebooks are failing. This passed right before this, so I am going to try just retriggering it |
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
Looks like doctests are failing because of |
Makes sense. Jax doesn't provide mappings for |
|
Just giving the function name instead of direct linking should work, not the perfect solution but better than spending much time on something minor cc: @kratman |
Co-authored-by: Arjun Verma <arjunverma.oc@gmail.com>
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>
The rendering in the original requested change was fixed
Description
pybamm.JaxSolver. Arg method is optional. Link to jax.experimental.odeint and format as code. For method=‘BDF’ option summarise method used (use docstrings in jax_bdf_integrate.py) or simply link to the docstrings in jax_bdf_integrate.py
Fixes # (issue)
API Docs - Small fixes suitable for first time contributors - pybamm.JaxSolver
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Key checklist:
$ pre-commit run
(or$ nox -s pre-commit
) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)$ python run-tests.py --all
(or$ nox -s tests
)$ python run-tests.py --doctest
(or$ nox -s doctests
)You can run integration tests, unit tests, and doctests together at once, using
$ python run-tests.py --quick
(or$ nox -s quick
).Further checks: