Skip to content

docs: add scipy least squares API docs#645

Open
Haihan-Jiang wants to merge 1 commit into
google:mainfrom
Haihan-Jiang:codex/jaxopt-scipy-least-squares-api
Open

docs: add scipy least squares API docs#645
Haihan-Jiang wants to merge 1 commit into
google:mainfrom
Haihan-Jiang:codex/jaxopt-scipy-least-squares-api

Conversation

@Haihan-Jiang

Copy link
Copy Markdown

Fixes #184.

What

  • Add jaxopt.ScipyLeastSquares and jaxopt.ScipyBoundedLeastSquares to the API overview under nonlinear least squares.
  • Add a short SciPy wrappers section to the nonlinear least squares docs so the classes have visible autosummary entries.

Testing

  • git diff --check
  • Temporary venv smoke test importing jaxopt.ScipyLeastSquares and jaxopt.ScipyBoundedLeastSquares with jax, jaxlib, and scipy installed.

The full Sphinx docs build was not run locally because the docs requirements install the full documentation stack, including TensorFlow/Flax.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing documentation for ScipyLeastSquares

1 participant