openscvx 2.dev6__py3-none-any.whl → 2.dev8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
openscvx/__init__.py CHANGED
@@ -29,7 +29,10 @@ from openscvx.expert import ByofSpec
29
29
  from openscvx.integrations import DynamicsAdapter, MjxDynamics
30
30
  from openscvx.loader import load_dict, load_json, load_yaml
31
31
  from openscvx.problem import Problem
32
- from openscvx.solvers import PTRSolver
32
+ from openscvx.solvers import CVXPyPTRSolver, PTRSolver
33
+
34
+ # QPAXPTRSolver is exposed lazily via __getattr__ below to keep `import qpax`
35
+ # off the hot import path for users who don't install the optional extra.
33
36
  from openscvx.symbolic.expr import (
34
37
  CTCS,
35
38
  Abs,
@@ -91,6 +94,16 @@ from openscvx.utils.cache import clear_cache, get_cache_dir, get_cache_size
91
94
 
92
95
  load_results = OptimizationResults.load
93
96
 
97
+
98
+ def __getattr__(name: str):
99
+ """Lazy export for backends that depend on optional packages."""
100
+ if name == "QPAXPTRSolver":
101
+ from openscvx.solvers.qpax_ptr_solver import QPAXPTRSolver
102
+
103
+ return QPAXPTRSolver
104
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
105
+
106
+
94
107
  __all__ = [
95
108
  # Main Trajectory Optimization Entrypoint
96
109
  "Problem",
@@ -188,6 +201,8 @@ __all__ = [
188
201
  "VectorizeDiscretizeLinearize",
189
202
  # Convex Solver
190
203
  "PTRSolver",
204
+ "CVXPyPTRSolver",
205
+ "QPAXPTRSolver",
191
206
  # Algorithm & Autotuning
192
207
  "PenalizedTrustRegion",
193
208
  "AugmentedLagrangian",
openscvx/_version.py CHANGED
@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
18
18
  commit_id: str | None
19
19
  __commit_id__: str | None
20
20
 
21
- __version__ = version = '2.dev6'
22
- __version_tuple__ = version_tuple = (2, 'dev6')
21
+ __version__ = version = '2.dev8'
22
+ __version_tuple__ = version_tuple = (2, 'dev8')
23
23
 
24
24
  __commit_id__ = commit_id = None
openscvx/loader.py CHANGED
@@ -40,7 +40,7 @@ from pydantic import BaseModel, ConfigDict
40
40
  from openscvx.algorithms import PenalizedTrustRegionConfig
41
41
  from openscvx.config import SettingsSpec
42
42
  from openscvx.discretization import DiscretizerSpec
43
- from openscvx.solvers import SolverSpec
43
+ from openscvx.solvers import PTRSolverSpec
44
44
  from openscvx.symbolic.expr.control import ControlSpec
45
45
  from openscvx.symbolic.expr.expr import Expr
46
46
  from openscvx.symbolic.expr.parameter import ParameterSpec
@@ -66,7 +66,7 @@ class ProblemSpec(BaseModel):
66
66
  constraints: List[str] = []
67
67
  algorithm: Optional[PenalizedTrustRegionConfig] = None
68
68
  discretizer: Optional[DiscretizerSpec] = None
69
- solver: Optional[SolverSpec] = None
69
+ solver: Optional[PTRSolverSpec] = None
70
70
  settings: Optional[SettingsSpec] = None
71
71
  states_prop: Optional[List[StateSpec]] = None
72
72
  dynamics_prop: Optional[Dict[str, Any]] = None
@@ -17,7 +17,10 @@ class LoweredCvxpyConstraints:
17
17
 
18
18
  Attributes:
19
19
  constraints: List of CVXPy constraint objects (cp.Constraint).
20
- Includes both nodal and cross-node convex constraints.
20
+ Includes both nodal and cross-node convex constraints. Empty
21
+ for backends that don't accept ``.convex()`` constraints — the
22
+ refusal happens earlier, in
23
+ :meth:`openscvx.solvers.base.ConvexSolver.lower_convex_constraints`.
21
24
  """
22
25
 
23
26
  constraints: list["cp.Constraint"] = field(default_factory=list)
openscvx/problem.py CHANGED
@@ -201,9 +201,11 @@ class Problem:
201
201
  discretizer=ox.LinearizeDiscretize(dis_type="ZOH", ode_solver="Dopri8")
202
202
  solver: Convex subproblem solver configuration. Accepts:
203
203
 
204
- - ``None`` — uses ``PTRSolver()`` with defaults (QOCO backend).
204
+ - ``None`` — uses ``CVXPyPTRSolver()`` with defaults (QOCO backend).
205
205
  - A ``ConvexSolver`` instance — used directly.
206
- - A ``dict`` — passed as kwargs to ``PTRSolver()``.
206
+ - A ``dict`` — validated as ``PTRSolverSpec``; the ``backend``
207
+ field (``"cvxpy"`` or ``"qpax"``) selects the concrete
208
+ backend.
207
209
 
208
210
  Examples::
209
211
 
@@ -216,8 +218,12 @@ class Problem:
216
218
  # Enable cvxpygen code generation
217
219
  solver={"cvxpygen": True}
218
220
 
221
+ # JAX-native QPAX backend (no cvx_solver / cvxpygen fields)
222
+ solver={"backend": "qpax"}
223
+
219
224
  # Instance
220
- solver=ox.PTRSolver(cvx_solver="CLARABEL")
225
+ solver=ox.CVXPyPTRSolver(cvx_solver="CLARABEL")
226
+ solver=ox.QPAXPTRSolver()
221
227
  byof (ByofSpec, optional): Expert mode only. Raw JAX functions to
222
228
  bypass symbolic layer. See :class:`openscvx.expert.ByofSpec` for
223
229
  detailed documentation.
@@ -393,9 +399,9 @@ class Problem:
393
399
  def solver(self) -> ConvexSolver:
394
400
  """Access the convex subproblem solver instance.
395
401
 
396
- Attributes such as ``cvx_solver``, ``solver_args``, ``cvxpygen``, and
397
- ``cvxpygen_override`` can be modified freely before ``initialize``
398
- is called::
402
+ Backend-specific attributes (e.g. ``cvx_solver``, ``solver_args``,
403
+ ``cvxpygen``, ``cvxpygen_override`` on :class:`CVXPyPTRSolver`) can
404
+ be modified freely before ``initialize`` is called::
399
405
 
400
406
  problem.solver.solver_args = {"abstol": 1e-6, "reltol": 1e-9}
401
407
  problem.solver.cvxpygen = True
@@ -407,7 +413,7 @@ class Problem:
407
413
  will have no effect on subsequent solves.
408
414
 
409
415
  Returns:
410
- The solver instance (e.g., PTRSolver).
416
+ The solver instance a concrete :class:`PTRSolver` subclass.
411
417
  """
412
418
  return self._solver
413
419
 
@@ -510,12 +516,12 @@ class Problem:
510
516
  self._lowered.x_prop_unified.final[state._slice] = state.final
511
517
  self._lowered.x_prop_unified.final_type[state._slice] = state.final_type
512
518
 
513
- # Update CVXPy solver parameters (only if solver is initialized)
514
- if self._solver._problem is not None:
515
- self._solver.update_boundary_conditions(
516
- x_init=self._lowered.x_unified.initial,
517
- x_term=self._lowered.x_unified.final,
518
- )
519
+ # Push to the solver both backends short-circuit on a pre-initialize
520
+ # call, so this is safe to invoke from any lifecycle point.
521
+ self._solver.update_boundary_conditions(
522
+ x_init=self._lowered.x_unified.initial,
523
+ x_term=self._lowered.x_unified.final,
524
+ )
519
525
 
520
526
  def _sync_guesses(self):
521
527
  """Sync trajectory guesses from State/Control objects to lowered representation.
@@ -26,13 +26,16 @@ class ConvexSolver(ABC):
26
26
  ...
27
27
  ```
28
28
 
29
- This architecture enables users to implement custom solver backends such as:
29
+ The Penalized Trust-Region (PTR) subproblem ships with two concrete backends:
30
30
 
31
- - Direct Clarabel solver (Rust-based, GPU-capable)
32
- - QPAX (JAX-based QP solver for end-to-end differentiability)
33
- - OSQP direct interface (specialized for QP structure)
34
- - Custom embedded solvers for real-time applications
35
- - Research solvers with specialized structure exploitation
31
+ - :class:`CVXPyPTRSolver` DCP graph via CVXPy, dispatched to any of its
32
+ supported conic solvers (QOCO, CLARABEL, ...). Optional code generation
33
+ via cvxpygen for improved per-iteration performance.
34
+ - :class:`QPAXPTRSolver` flat ``(Q, q, A, b, G, h)`` assembled as JAX
35
+ arrays and solved with ``qpax.solve_qp``. Aimed at end-to-end JAX
36
+ differentiability of the SCP loop (follow-up work).
37
+
38
+ Both share the abstract :class:`PTRSolver` contract.
36
39
 
37
40
  Note:
38
41
  Solvers own their optimization variables (e.g., ``CVXPySolver.ocp_vars``).
@@ -41,36 +44,50 @@ Note:
41
44
  for the interface details.
42
45
  """
43
46
 
47
+ import warnings
44
48
  from typing import Any
45
49
 
46
- from .base import _SOLVER_MAP, ConvexSolver, SolverSpec
50
+ from .base import ConvexSolver, PTRSolverSpec
51
+ from .cvxpy_ptr_solver import CVXPyPTRSolver
47
52
  from .ptr_solver import PTRSolver, PTRSolveResult
48
53
 
49
- # ---------------------------------------------------------------------------
50
- # Populate the solver class map now that all classes are imported
51
- # ---------------------------------------------------------------------------
52
54
 
53
- _SOLVER_MAP.update(
54
- {
55
- "PTRSolver": PTRSolver,
56
- }
57
- )
55
+ def resolve_solver_config(val: Any) -> PTRSolverSpec:
56
+ """Validate a dict / Spec into a :class:`PTRSolverSpec` instance."""
57
+ if isinstance(val, PTRSolverSpec):
58
+ return val
59
+ return PTRSolverSpec.model_validate(val)
60
+
58
61
 
62
+ def __getattr__(name: str):
63
+ """Deprecated alias: ``SolverSpec`` → :class:`PTRSolverSpec`."""
64
+ if name == "SolverSpec":
65
+ warnings.warn(
66
+ "openscvx.solvers.SolverSpec is deprecated; use PTRSolverSpec.",
67
+ DeprecationWarning,
68
+ stacklevel=2,
69
+ )
70
+ return PTRSolverSpec
71
+ if name == "QPAXPTRSolver":
72
+ # Lazy import so users without the qpax extra don't pay a hard
73
+ # ImportError just for `from openscvx.solvers import QPAXPTRSolver`
74
+ # — the import error gets deferred to instantiation time, where the
75
+ # error message points at the install command.
76
+ from .qpax_ptr_solver import QPAXPTRSolver
59
77
 
60
- def resolve_solver_config(val: Any) -> SolverSpec:
61
- """Validate a dict/Spec into a :class:`SolverSpec` instance."""
62
- if isinstance(val, SolverSpec):
63
- return val
64
- return SolverSpec.model_validate(val)
78
+ return QPAXPTRSolver
79
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
65
80
 
66
81
 
67
82
  __all__ = [
68
- # Base class
83
+ # Base classes
69
84
  "ConvexSolver",
70
- # PTR solver
71
85
  "PTRSolver",
72
86
  "PTRSolveResult",
87
+ # PTR backends
88
+ "CVXPyPTRSolver",
89
+ "QPAXPTRSolver",
73
90
  # Config
74
- "SolverSpec",
91
+ "PTRSolverSpec",
75
92
  "resolve_solver_config",
76
93
  ]
openscvx/solvers/base.py CHANGED
@@ -5,40 +5,29 @@ must follow for use within successive convexification algorithms.
5
5
 
6
6
  !!! note
7
7
 
8
- Solvers own their optimization variables via ``create_variables()``.
9
- Convex constraint lowering remains in ``lower.py`` but uses the solver's
10
- variables.
11
-
12
- When adding non-CVXPy backends, there are two approaches:
13
-
14
- 1. **Solver owns the lowerer**: The solver implements a
15
- ``lower_convex_constraints()`` method containing the lowering logic.
16
-
17
- 2. **Solver determines the lowerer**: The solver references which lowerer
18
- to use, but the lowering logic stays in ``lower.py``. Example:
19
-
20
- ```python
21
- # In solver
22
- @property
23
- def lowerer(self):
24
- from openscvx.symbolic.lower import lower_cvxpy_constraints
25
- return lower_cvxpy_constraints
26
-
27
- # In lower_symbolic_problem()
28
- lowered_constraints = solver.lowerer(constraints, solver.variables, parameters)
29
- ```
8
+ Solvers own both their optimization variables (``create_variables()``) and
9
+ the lowering of any user ``.convex()`` constraints
10
+ (``lower_convex_constraints()``). The default ``lower_convex_constraints``
11
+ refuses user ``.convex()`` constraints with a clear error — backends that
12
+ accept them override it. This keeps ``openscvx.symbolic.lower``
13
+ backend-agnostic: it never branches on solver type, it just delegates.
14
+
15
+ See :class:`openscvx.solvers.ptr_solver.PTRSolver` for the PTR-specific
16
+ interface every PTR backend implements.
30
17
  """
31
18
 
19
+ import warnings
32
20
  from abc import ABC, abstractmethod
33
- from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional
21
+ from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Tuple
34
22
 
35
- from pydantic import BaseModel, ConfigDict
23
+ from pydantic import BaseModel, ConfigDict, model_validator
36
24
 
37
25
  if TYPE_CHECKING:
38
26
  from openscvx.config import Config
39
27
  from openscvx.lowered import LoweredProblem
40
28
  from openscvx.lowered.jax_constraints import LoweredJaxConstraints
41
29
  from openscvx.lowered.unified import UnifiedControl, UnifiedState
30
+ from openscvx.symbolic.constraint_set import ConstraintSet
42
31
 
43
32
 
44
33
  class ConvexSolver(ABC):
@@ -91,10 +80,6 @@ class ConvexSolver(ABC):
91
80
  return MyResult(...)
92
81
  """
93
82
 
94
- #: Backend solver name (e.g., ``"QOCO"``, ``"CLARABEL"``). Subclasses
95
- #: must set this in ``__init__``.
96
- cvx_solver: str
97
-
98
83
  @abstractmethod
99
84
  def create_variables(
100
85
  self,
@@ -128,6 +113,50 @@ class ConvexSolver(ABC):
128
113
  """
129
114
  raise NotImplementedError
130
115
 
116
+ def lower_convex_constraints(
117
+ self,
118
+ constraints: "ConstraintSet",
119
+ parameters: Optional[Dict[str, Any]] = None,
120
+ ) -> Tuple[List[Any], Dict[str, Any]]:
121
+ """Lower user ``.convex()`` constraints into this backend's form.
122
+
123
+ Called once by :func:`openscvx.symbolic.lower.lower_symbolic_problem`
124
+ after ``create_variables()`` and before ``initialize()``.
125
+
126
+ The default implementation refuses any user ``.convex()``
127
+ constraints — appropriate for backends like
128
+ :class:`openscvx.solvers.qpax_ptr_solver.QPAXPTRSolver` that don't
129
+ accept second-order-cone constraints. Backends that do accept them
130
+ (e.g. :class:`openscvx.solvers.cvxpy_ptr_solver.CVXPyPTRSolver`)
131
+ override this to invoke their backend-specific lowerer.
132
+
133
+ Args:
134
+ constraints: Categorized symbolic constraints. Only the
135
+ ``nodal_convex`` / ``cross_node_convex`` lists matter here;
136
+ non-convex constraints go through the JAX lowering pipeline.
137
+ parameters: Optional dict of symbolic ``Parameter`` objects
138
+ referenced by the constraints. May be ``None``.
139
+
140
+ Returns:
141
+ ``(lowered_list, parameter_map)``. The first is a list of
142
+ backend-specific constraint objects (e.g. ``cp.Constraint``);
143
+ the second maps parameter names to backend-specific parameter
144
+ objects. Both are empty for the default refusal path.
145
+
146
+ Raises:
147
+ NotImplementedError: if the user defined any ``.convex()``
148
+ constraints and this backend doesn't override.
149
+ """
150
+ n = len(constraints.nodal_convex) + len(constraints.cross_node_convex)
151
+ if n:
152
+ raise NotImplementedError(
153
+ f"{type(self).__name__} does not support user-defined "
154
+ f".convex() constraints ({n} defined). Drop the .convex() "
155
+ "constraint or switch to a backend that supports them "
156
+ "(e.g. openscvx.CVXPyPTRSolver)."
157
+ )
158
+ return [], {}
159
+
131
160
  @abstractmethod
132
161
  def initialize(
133
162
  self,
@@ -241,11 +270,17 @@ class ConvexSolver(ABC):
241
270
  # Pydantic spec for dict / YAML validation
242
271
  # =============================================================================
243
272
 
244
- _SOLVER_MAP: Dict[str, type] = {} # populated by __init__.py after all classes are imported
245
273
 
274
+ class PTRSolverSpec(BaseModel):
275
+ """Validates PTR solver configuration from dict/YAML input.
246
276
 
247
- class SolverSpec(BaseModel):
248
- """Validates solver configuration from dict/YAML input.
277
+ The ``backend`` discriminator selects which concrete PTR backend to build:
278
+ ``"cvxpy"`` (the default,
279
+ :class:`openscvx.solvers.cvxpy_ptr_solver.CVXPyPTRSolver`) or ``"qpax"``
280
+ (:class:`openscvx.solvers.qpax_ptr_solver.QPAXPTRSolver`).
281
+
282
+ ``cvx_solver``, ``cvxpygen``, and ``cvxpygen_override`` are CVXPy-only;
283
+ setting them under ``backend="qpax"`` is a configuration error.
249
284
 
250
285
  !!! warning
251
286
  Enabling ``cvxpygen`` currently disables sparse parameter declarations.
@@ -255,15 +290,61 @@ class SolverSpec(BaseModel):
255
290
  """
256
291
 
257
292
  type: Literal["PTRSolver"] = "PTRSolver"
258
- cvx_solver: str = "QOCO"
293
+ backend: Literal["cvxpy", "qpax"] = "cvxpy"
294
+ cvx_solver: Optional[str] = None
259
295
  solver_args: Optional[Dict[str, Any]] = None
260
296
  cvxpygen: bool = False
261
297
  cvxpygen_override: bool = False
262
298
 
263
299
  model_config = ConfigDict(extra="forbid")
264
300
 
301
+ @model_validator(mode="after")
302
+ def _check_backend_fields(self):
303
+ if self.backend == "qpax":
304
+ offenders = [
305
+ name
306
+ for name, value in (
307
+ ("cvx_solver", self.cvx_solver),
308
+ ("cvxpygen", self.cvxpygen),
309
+ ("cvxpygen_override", self.cvxpygen_override),
310
+ )
311
+ if value
312
+ ]
313
+ if offenders:
314
+ raise ValueError(
315
+ f"{offenders} only valid for backend='cvxpy'; "
316
+ "remove these fields or set backend='cvxpy'."
317
+ )
318
+ return self
319
+
265
320
  def build(self) -> ConvexSolver:
266
- cls = _SOLVER_MAP.get(self.type)
267
- if cls is None:
268
- raise ValueError(f"Unknown solver {self.type!r}; expected one of {sorted(_SOLVER_MAP)}")
269
- return cls(**self.model_dump(exclude={"type"}, exclude_unset=True))
321
+ # Local imports keep CVXPy / qpax out of the import path until the
322
+ # corresponding backend is actually requested.
323
+ if self.backend == "cvxpy":
324
+ from .cvxpy_ptr_solver import CVXPyPTRSolver
325
+
326
+ return CVXPyPTRSolver(
327
+ cvx_solver=self.cvx_solver or "QOCO",
328
+ solver_args=self.solver_args,
329
+ cvxpygen=self.cvxpygen,
330
+ cvxpygen_override=self.cvxpygen_override,
331
+ )
332
+ from .qpax_ptr_solver import QPAXPTRSolver
333
+
334
+ return QPAXPTRSolver(solver_args=self.solver_args)
335
+
336
+
337
+ def __getattr__(name: str):
338
+ """Deprecated alias: ``SolverSpec`` → :class:`PTRSolverSpec`.
339
+
340
+ Kept for one release so existing dict/YAML configs and tests that import
341
+ ``SolverSpec`` continue to work. Emit a ``DeprecationWarning`` on access.
342
+ """
343
+ if name == "SolverSpec":
344
+ warnings.warn(
345
+ "openscvx.solvers.base.SolverSpec is deprecated; use PTRSolverSpec.",
346
+ DeprecationWarning,
347
+ stacklevel=2,
348
+ )
349
+ return PTRSolverSpec
350
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")