Skip to content

docs: add OptStep API reference #644

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

Open
Haihan-Jiang wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add OptStep API reference #644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
API at a glance
===============

Base containers
---------------

.. autosummary::
:toctree: _autosummary

jaxopt.OptStep

Optimization
------------

Expand Down Expand Up @@ -180,4 +188,3 @@ Tree utilities
jaxopt.tree_util.tree_sum
jaxopt.tree_util.tree_l2_norm
jaxopt.tree_util.tree_zeros_like

6 changes: 6 additions & 0 deletions jaxopt/_src/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@
NUM_EVAL_DTYPE = 'int32'

class OptStep(NamedTuple):
"""Container returned by solvers.

Attributes:
params: solution parameters returned by the solver.
state: solver-specific state associated with ``params``.
"""
params: Any
state: Any

Expand Down