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.

Sign up for GitHub

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

Jump to bottom

pybamm.JaxSolver docstring improvement #3994

Merged
merged 17 commits into from
May 31, 2024
Merged

pybamm.JaxSolver docstring improvement #3994

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
fc5b3d0
pybamm.JaxSolver docstring improvement
buddhiwisr Apr 11, 2024
64018cc
Merge branch 'develop' into hackathon-issue
agriyakhetarpal Apr 11, 2024
1b5e92c
Merge branch 'develop' into hackathon-issue
arjxn-py Apr 14, 2024
1bf5169
Merge branch 'develop' into hackathon-issue
kratman Apr 15, 2024
4b8858c
Merge branch 'develop' into hackathon-issue
arjxn-py Apr 19, 2024
37c7516
Merge branch 'develop' into hackathon-issue
kratman May 29, 2024
e65ddb6
Update conf.py to add `intersphinx_mapping` for `jax`
arjxn-py May 31, 2024
f336297
Merge branch 'develop' into hackathon-issue
arjxn-py May 31, 2024
3a40d42
Update jax_solver.py to fix docstring rendering
arjxn-py May 31, 2024
af87780
Merge branch 'develop' into hackathon-issue
kratman May 31, 2024
ade96fa
Update docs/conf.py
kratman May 31, 2024
1260e45
Update pybamm/solvers/jax_solver.py
arjxn-py May 31, 2024
52d0293
Update docs/conf.py
arjxn-py May 31, 2024
09d7828
Apply suggestions from code review
arjxn-py May 31, 2024
8575bf0
Update pybamm/solvers/jax_solver.py
kratman May 31, 2024
13d82f7
Update pybamm/solvers/jax_solver.py
kratman May 31, 2024
6a15163
Update docs/conf.py
agriyakhetarpal May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pybamm/solvers/jax_solver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ class JaxSolver(pybamm.BaseSolver):

Parameters
----------
method: str
'RK45' (default) uses jax.experimental.odeint
'BDF' uses custom jax_bdf_integrate (see jax_bdf_integrate.py for details)
method: str, optional (see `jax.experimental.ode.odeint` for details)
* 'RK45' (default) uses jax.experimental.ode.odeint
* 'BDF' uses custom jax_bdf_integrate (see `jax_bdf_integrate.py` for details)
root_method: str, optional
Method to use to calculate consistent initial conditions. By default this uses
the newton chord method internal to the jax bdf solver, otherwise choose from
Expand Down
Loading