diffapqp 0.1.0__tar.gz

diffapqp-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 DiffAPQP contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

diffapqp-0.1.0/PKG-INFO

@@ -0,0 +1,457 @@
+Metadata-Version: 2.4
+Name: diffapqp
+Version: 0.1.0
+Summary: Learning-augmented optimization: differentiable APQP/APLP layers on CVXPY and PyTorch.
+Author: DiffAPQP contributors
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2026 DiffAPQP contributors
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/xuwkk/diffapqp
+Project-URL: Repository, https://github.com/xuwkk/diffapqp
+Project-URL: Documentation, https://xuwkk.github.io/diffapqp/
+Project-URL: CVXPY fork, https://github.com/xuwkk/cvxpy
+Keywords: optimization,convex,differentiable,pytorch,cvxpy,qp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: scipy>=1.10
+Requires-Dist: cvxpy>=1.4
+Requires-Dist: torch>=2.0
+Requires-Dist: threadpoolctl>=3.0
+Requires-Dist: loky>=3.4; sys_platform == "win32" or sys_platform == "darwin"
+Provides-Extra: proxqp
+Requires-Dist: proxsuite<0.7; extra == "proxqp"
+Provides-Extra: gurobi
+Requires-Dist: gurobipy; extra == "gurobi"
+Provides-Extra: benchmark
+Requires-Dist: cvxpylayers==1.0.0; extra == "benchmark"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: loky>=3.4; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: pymdown-extensions>=10.0; extra == "docs"
+Dynamic: license-file
+
+# DiffAPQP
+
+DiffAPQP connects continuous affine-parametric quadratic and linear programs
+written in [CVXPY](https://www.cvxpy.org/) to
+[PyTorch](https://pytorch.org/). It provides differentiable layers for two
+common learning targets:
+
+- `SolMapLayer` differentiates losses that depend on the optimal decision
+  $\hat z^\star$.
+- `ValueFuncLayer` differentiates losses that depend on the optimal objective
+  value $\alpha(\hat y)$.
+
+Write the optimization model naturally in CVXPY and pass the original
+`cvxpy.Problem` to either layer. DiffAPQP validates and canonicalizes compatible
+problems internally, so **no manual standard-form construction is required**.
+
+The package is developed by Dr. Wangkun Xu from Imperial College London,
+partially funded by EPSRC under Grant EP/Y025946/1.
+
+- More details can be found in the [documentation](https://xuwkk.github.io/diffapqp/).
+- Please also refer to our preprint paper: Structured Differentiable Optimization for Efficient Decision-focused Learning in Power Systems and 
+- power system application repository: diffapqp-power-system.
+
+## Highlights
+
+- **Native CVXPY modeling:** parameter and variable names become the keys of
+  the layer's input and output dictionaries.
+- **Batched execution:** independent parameter instances can be solved
+  concurrently.
+- **Flexible forward solvers:** CVXPY-compatible QP and conic backends can be
+  used independently of the backward method.
+- **Repeated-solve acceleration:** solver warm starts and in-place data updates
+  are available where the backend and CVXPY interface support them.
+- **Specialized differentiation:** solution-map losses use full- or reduced-KKT
+  adjoints, while value-function losses use a direct value derivative without
+  solving an adjoint system.
+
+## Installation
+
+Install the core package from PyPI:
+
+```bash
+python -m pip install diffapqp
+```
+
+This installs CVXPY and its standard dependencies, which normally provide
+Clarabel, OSQP, and SCS. Optional solver packages can be installed with:
+
+```bash
+python -m pip install "diffapqp[gurobi]"  # Gurobi; a licence is required
+python -m pip install "diffapqp[proxqp]"  # PROXQP
+```
+
+DiffAPQP's explicit sample-indexed warm starts and in-place solver-data updates
+for OSQP, SCS, QPALM, and PROXQP require the pinned custom CVXPY fork:
+
+```bash
+python -m pip install \
+  "cvxpy @ git+https://github.com/xuwkk/cvxpy.git@v1.9.0-lapso.7"
+python -m pip install diffapqp
+```
+
+The custom fork requires Python 3.11 or later. The core DiffAPQP package
+supports Python 3.9 or later. Install PyTorch separately first when a particular
+CUDA build is required.
+
+See the [installation guide](https://xuwkk.github.io/diffapqp/installation/)
+for editable installs, compatibility imports, and additional solver backends.
+
+## Quick Start
+
+The following example defines a parameterized QP, solves two instances as a
+batch, and differentiates a loss through the optimal decisions:
+
+```python
+import cvxpy as cp
+import torch
+
+from diffapqp import SolMapLayer
+
+z = cp.Variable(2, name="z")
+q = cp.Parameter(2, name="q")
+
+problem = cp.Problem(
+    cp.Minimize(0.5 * cp.sum_squares(z) + q @ z),
+    [z >= 0, z <= 10],
+)
+
+layer = SolMapLayer(problem, max_n_cores=1)
+
+q_batch = torch.tensor(
+    [[-1.0, -2.0], [0.5, -1.5]],
+    dtype=torch.double,
+    requires_grad=True,
+)
+
+primal_dict, *_ = layer(
+    {"q": q_batch},
+    solver="OSQP",
+    reduced_kkt=True,
+)
+
+loss = primal_dict["z"].square().mean()
+loss.backward()
+
+print(primal_dict["z"])
+print(q_batch.grad)
+```
+
+The leading tensor dimension is the batch dimension. Input keys must match the
+names of CVXPY parameters, and `primal_dict` restores the names and shapes of
+the original CVXPY variables.
+
+## Choose a Layer
+
+| Training loss depends on | Layer | Differentiable output | Backward method |
+| --- | --- | --- | --- |
+| Optimal decisions $\hat z^\star$ | [`SolMapLayer`](https://xuwkk.github.io/diffapqp/implementation/solution-map-layer/) | Named variables in `primal_dict` | Full- or reduced-KKT adjoint |
+| Optimal value $\alpha(\hat y)$ | [`ValueFuncLayer`](https://xuwkk.github.io/diffapqp/implementation/value-function-layer/) | `value_batch` | Direct value-function derivative |
+
+## Supported Problem Class
+
+DiffAPQP targets continuous affine-parametric QPs and LPs whose canonical form
+is
+
+$$
+\begin{aligned}
+\underset{\tilde z}{\operatorname{minimize}}\quad
+& \frac{1}{2}\tilde z^\top P\tilde z
+  + q(\hat y)^\top\tilde z + c(\hat y) \\
+\text{subject to}\quad
+& A\tilde z = b(\hat y), \\
+& G\tilde z \le h(\hat y).
+\end{aligned}
+$$
+
+The matrices $P$, $A$, and $G$ are constant, while $q$, $c$, $b$, and $h$ may
+depend affinely on the parameter vector $\hat y$. Linear programs are the
+special case $P=0$.
+
+The original CVXPY problem must:
+
+- be continuous, DCP compliant, and reducible through CVXPY's QP
+  canonicalization;
+- satisfy CVXPY's DPP rules when parameterized;
+- assign explicit names to all parameters and decision variables.
+
+Parameterized quadratic or constraint matrices, nonlinear constraints, and
+integer or Boolean decisions are outside the current layer contract. The
+[problem setup](https://xuwkk.github.io/diffapqp/theory/problem-setup/)
+explains the accepted model and internal canonicalization in detail.
+
+## Warm Start and Update
+
+With the custom CVXPY fork, repeated solves can associate warm-start iterates
+with stable sample identifiers and reuse a solver workspace for each batch
+slot:
+
+```python
+primal_dict, *_ = layer(
+    param_dict,
+    idx_list=sample_ids,
+    solver="OSQP",
+    warm_start=True,
+    update=True,
+)
+```
+
+The first call initializes the relevant state; later calls reuse it. Warm start
+and update are distinct mechanisms, and their exact behavior is solver
+dependent. See
+[Efficient Forward Pass](https://xuwkk.github.io/diffapqp/theory/forward-pass/)
+for the lifecycle and [Solvers](https://xuwkk.github.io/diffapqp/solvers/) for
+backend coverage and default arguments.
+
+## Documentation
+
+- [Documentation home](https://xuwkk.github.io/diffapqp/)
+- [Installation](https://xuwkk.github.io/diffapqp/installation/)
+- [Solvers and default arguments](https://xuwkk.github.io/diffapqp/solvers/)
+- [API overview](https://xuwkk.github.io/diffapqp/api_overview/)
+- [Theory overview](https://xuwkk.github.io/diffapqp/theory/)
+- [Solution-map layer](https://xuwkk.github.io/diffapqp/implementation/solution-map-layer/)
+- [Value-function layer](https://xuwkk.github.io/diffapqp/implementation/value-function-layer/)
+
+## Tutorials, Tests, and Benchmarks
+
+- [Tutorials](https://github.com/xuwkk/diffapqp/blob/main/tutorial/README.md)
+  provide runnable examples of both differentiable layers.
+- [Tests](https://github.com/xuwkk/diffapqp/blob/main/tests/README.md) cover
+  canonicalization, forward solves, gradients, and package compatibility.
+- [Benchmarks](https://github.com/xuwkk/diffapqp/blob/main/benchmark/README.md)
+  compare runtime, gradient agreement, CPU usage, and memory usage.
+
+## Development
+
+```bash
+git clone https://github.com/xuwkk/diffapqp.git
+cd diffapqp
+python -m pip install -e ".[dev,docs]"
+python -m pytest
+python -m mkdocs build --strict
+```
+
+Install the custom CVXPY fork before the editable package when developing or
+testing sample-indexed warm-start/update behavior.
+
+## License
+
+DiffAPQP is released under the
+[Apache License 2.0](https://github.com/xuwkk/diffapqp/blob/main/LICENSE).