Skip to content

docs: add OptStep API reference#644

Open
Haihan-Jiang wants to merge 1 commit into
google:mainfrom
Haihan-Jiang:codex/jaxopt-optstep-api-doc
Open

docs: add OptStep API reference#644
Haihan-Jiang wants to merge 1 commit into
google:mainfrom
Haihan-Jiang:codex/jaxopt-optstep-api-doc

Conversation

@Haihan-Jiang

Copy link
Copy Markdown

Summary

  • Adds jaxopt.OptStep to the API autosummary so solver return types can link to a generated reference page.
  • Adds a short docstring for the OptStep container fields.

Fixes #251.

Testing

  • python3.12 -m compileall -q jaxopt/_src/base.py
  • git diff --check
  • Temporary Python 3.12 venv smoke test with jax/jaxlib: imported jaxopt.OptStep and jaxopt.base.OptStep, verified they are the same object, and constructed an OptStep.

I did not run the full Sphinx docs build locally because docs/requirements.txt installs the full docs stack, including TensorFlow/Flax, for this small autosummary/docstring change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant