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.

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

"invalid escape sequence" warning in BoxOSQP docstring #584

Open
nardi opened this issue Mar 15, 2024 · 0 comments
Open

"invalid escape sequence" warning in BoxOSQP docstring #584

nardi opened this issue Mar 15, 2024 · 0 comments

Comments

@nardi
Copy link

nardi commented Mar 15, 2024

Kind of a minor issue, but the lines

jaxopt/jaxopt/_src/osqp.py

Lines 333 to 336 in 501cc20

Dual Ineq variables: :math:`\mu, \phi`
ADMM computes :math:`y` at each iteration. :math:`\mu` and :math:`\phi` can be deduced from :math:`y`.

in the BoxOSQP docstring cause a DeprecationWarning: invalid escape sequence '\m'. Would changing them to

  Dual Ineq variables: :math:`\\mu, \\phi`


  ADMM computes :math:`y` at each iteration. :math:`\\mu` and :math:`\\phi` can be deduced from :math:`y`.

fix that while leaving the proper docstring in tact?

There is also another mistake in the same docstring:

If the inequality is one-sided then ``jnp.inf can be used for u,

Here ``jnp.inf does not have a closing ``.

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

No branches or pull requests

1 participant