lp2graph 0.3.0__tar.gz

lp2graph-0.3.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.egg-info/
+dist/
+build/
+.eggs/
+*.pyc
+.venv/
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.tox/
+site/
+*.swp
+.DS_Store
+.idea/
+.vscode/

lp2graph-0.3.0/CHANGELOG.md

@@ -0,0 +1,137 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+- **`metrics.model_completeness`** — the second model-level well-formedness
+  indicator described in *LP Mining with LP2Graph* (objective declared together
+  with ≥1 variable and ≥1 constraint), companion to `model_coherence`. Now
+  computed and wired into the Level-M structural feature document
+  (`mining.cluster.taxonomy.model_feature_document`) as a `complete:{0,1}`
+  feature, closing a paper↔code gap where the paper named both indicators but
+  only coherence was implemented.
+- **LP mining extensions** (`lp2graph.mining`, issues #38–#43) — six
+  deterministic modules implementing the *LP Mining with LP2Graph* method on
+  top of the core library. Every frozen resource is versioned in
+  `lp2graph.mining.versions` and stamped into emitted records.
+  - **M1 `mining.ingest`** — heterogeneous ingestion front-end: a Pyomo
+    importer (`from_pyomo`), a versioned non-canonical LaTeX normalizer with
+    source-span provenance (`normalize_latex` / `ingest_latex`), and an
+    extension dispatcher (`ingest`) that reports failures as structured
+    `IngestionResult`s rather than dropping them.
+  - **M2 `mining.homologize`** — lexical homologizer (tokenize / lemmatize /
+    versioned stop-list / frozen domain thesaurus + optional WordNet) and a
+    TF-IDF `ConceptVectorizer` over a sorted, diffable `Vocabulary`, plus the
+    type signature `τ(s)` and the `Entity` model for levels V/C/M.
+  - **M3 `mining.cluster`** — the cluster-and-name operator `CN` (deterministic
+    average-linkage default, `fixed_k`+silhouette, optional HDBSCAN), the
+    bottom-up Level V→C→M taxonomy `induce`, and `stability_report`
+    (silhouette + bootstrap ARI + sensitivity).
+  - **M4 `mining.label`** — two-stage labeling service: rule layer + calibrated
+    one-vs-rest `LinearSVM`, a confidence-gated closed loop with a versioned,
+    replayable `LabelStore`, rule promotion, retraining, and gold-set
+    guardrails (drift, per-class P/R, Cohen's κ, rollback flag).
+  - **M5 `mining.corpusmgr`** — provenance records, a regeneration `CorpusManifest`
+    (frozen search date + queries), deterministic dedup (schema-graph hash or
+    bibliographic key), and reproducible representative selection.
+  - **M6 `mining.isomorphism`** — per-cluster schema-graph isomorphism rate via
+    the NetworkX export (`isomorphism_report`).
+
+### Changed
+
+- **CI now gates formatting:** added a `ruff format --check src tests` step to
+  `ci.yml` (previously only `ruff check` ran, so format drift could land
+  undetected). Bumped the `ruff-pre-commit` pin v0.4.10 → v0.15.12 and the
+  `dev` extra to `ruff>=0.15.12,<0.16` so local, pre-commit, and CI agree;
+  reformatted 21 pre-existing files to the current ruff style.
+
+### Docs
+
+- Added `docs/STACK.md` (software-stack reference) and ADR-0006 (determinism as
+  a hard requirement) and ADR-0007 (optional dependencies are lazily imported),
+  wired into the MkDocs nav.
+
+## [0.3.0] - 2026-06-01
+
+### Added
+
+- **Deterministic LaTeX ⇄ graph codec** (`lp2graph.codec`): paper-style
+  LaTeX (`\mathcal` index sets, `\sum`, `\forall`, big-M) round-trips with
+  the canonical model with no LLM in the loop.
+  `to_canonical_latex` / `from_canonical_latex`, plus
+  `canonical_normal_form` for round-trip comparison. The LaTeX
+  serialization is a tested fixed point (`to(from(to(f))) == to(f)`); the
+  solvable content round-trips exactly.
+- **Real grounding solver back-end** (`lp2graph.solve`): replaces the v0.1
+  Pyomo stub. Grounds a formulation with an `Instance` (cardinalities +
+  parameter values) into a concrete `pulp.LpProblem` and solves it
+  (CBC / HiGHS / Gurobi). Covers the linear core including big-M and PESP
+  modulo; boundary-degenerate constraint instances are correctly omitted.
+- **Deterministic graph → natural-language describer** (`lp2graph.nl`):
+  generates a Markdown problem description (sets, data, decisions,
+  per-constraint sentences, objective) with parameter **data tables** when
+  an instance is supplied.
+- **End-to-end validation suite** (`corpus/validation/codec_pipeline/`):
+  runs the full JSON→LaTeX→parse→ground→solve loop and checks codec
+  round-trip, pipeline-vs-direct equality, cross-solver agreement, and
+  match to independently established optima (assignment 13, big-M ordering
+  30, fixed-sequence 18, PESP 1, time-indexed 4). Records paper anchors
+  (timtab1 = 764772, marcotallone = 3913.47).
+- New formulations: `assignment.json`, `pesp_solvable.json`.
+- CLI: `lp2graph latex | parse | describe | solve`.
+- New tests: `test_codec.py`, `test_solve.py`, `test_describe.py`.
+- Optional `solver` extra (`pulp`, `highspy`).
+
+## [0.2.0] - 2026-05-20
+
+### Changed
+
+- **BREAKING:** the import package is renamed `optgraph` → `lp2graph`, so it
+  now matches the distribution name. Update imports
+  (`from optgraph import …` → `from lp2graph import …`) and the console
+  script (`optgraph …` → `lp2graph …`). No behaviour changed; this is a
+  pure rename. The canonical `schema_version` is unaffected (still `0.1.0`).
+
+## [0.1.0] - 2026-05-03
+
+### Added
+
+- Canonical JSON schema (`schema/canonical.schema.json`) with index
+  families, parameters, variable templates, constraint templates,
+  first-class objectives, and term-level refs/bindings/role/sign
+  semantics.
+- Pydantic v2 model (`lp2graph.core.model`) mirroring the schema.
+- Two-phase validator (JSON Schema + semantic invariants).
+- Three view derivations: `lp2graph.views.schema`, `.hybrid`, `.ground`.
+- Internal typed graph (`lp2graph.core.graph`) — library-agnostic.
+- Structural metrics: `node_counts_by_class`, `edge_density`,
+  `constraint_variable_ratio`, `minimal_size`, `model_coherence`,
+  `graph_diameter`.
+- Presence flags: `has_big_m`, `has_integer_vars`,
+  `has_modulo_offset`, `has_soft_slack`,
+  `has_aggregation_operator`.
+- Constraint classification (heuristic, regex-based; ported from the
+  source repo with attribution).
+- SVG renderer with the design-context palette and typography.
+- Static interactive viewer (`viewer/index.html`).
+- Export adapters: NetworkX (full), PyG (HeteroData), DGL, LaTeX,
+  Pyomo (skeleton; bodies are stubs in v0.1).
+- CLI: `lp2graph validate | view | render | metrics | export`.
+- Initial catalog: 5 constraint-focused and 3 objective-focused
+  formulations across LP and MILP families.
+- 36 tests covering schema validation, view derivations, metrics,
+  rendering, and exports.
+- CI for Linux + macOS, Python 3.11/3.12/3.13.
+- Docs: data-model, views, metrics, add-a-formulation, design context,
+  extraction report; ADRs 0001-0005.
+
+### Origin
+
+Bootstrapped from
+[`joernmht/raiLPminerExperimentation`](https://github.com/joernmht/raiLPminerExperimentation)
+(MIT). See `docs/extraction-report.md` for the manifest.

lp2graph-0.3.0/CITATION.cff

@@ -0,0 +1,33 @@
+cff-version: 1.2.0
+title: lp2graph
+message: "If you use this software, please cite it as below."
+type: software
+authors:
+  - name: "lp2graph contributors"
+url: "https://github.com/joernmht/lp2graph"
+repository-code: "https://github.com/joernmht/lp2graph"
+license: Apache-2.0
+version: 0.1.0
+date-released: "2026-05-03"
+abstract: >-
+  Typed-graph representation of LP, MIP, and MILP formulations. Provides
+  schema-validated canonical models, three view derivations (schema /
+  hybrid / ground), structural metrics, SVG rendering, and export
+  adapters to PyG, DGL, NetworkX, LaTeX, and Pyomo.
+keywords:
+  - optimization
+  - linear programming
+  - mixed-integer programming
+  - graph neural networks
+  - typed graphs
+references:
+  - type: software
+    title: raiLPminerExperimentation
+    authors:
+      - name: "Joern Methner"
+    url: "https://github.com/joernmht/raiLPminerExperimentation"
+    license: MIT
+    notes: >-
+      Source repository for the structural metric algorithms and
+      constraint-classification keyword tables; see
+      docs/extraction-report.md for the attribution manifest.

lp2graph-0.3.0/LICENSE

@@ -0,0 +1,205 @@
+                                 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 restrict the use of the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for 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 Support. 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 support.
+
+   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 lp2graph 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.
+
+   This work is partially derived from joernmht/raiLPminerExperimentation
+   (MIT License); see docs/extraction-report.md for the attribution
+   manifest.

lp2graph-0.3.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: lp2graph
+Version: 0.3.0
+Summary: Typed-graph representation of LP, MIP, and MILP formulations.
+Project-URL: Homepage, https://github.com/joernmht/lp2graph
+Project-URL: Documentation, https://github.com/joernmht/lp2graph#readme
+Project-URL: Issues, https://github.com/joernmht/lp2graph/issues
+Project-URL: Source, https://github.com/joernmht/lp2graph
+Author: lp2graph contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: gnn,graph,linear-programming,milp,optimization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: all
+Requires-Dist: hdbscan>=0.8; extra == 'all'
+Requires-Dist: highspy>=1.7; extra == 'all'
+Requires-Dist: networkx>=3.0; extra == 'all'
+Requires-Dist: nltk>=3.8; extra == 'all'
+Requires-Dist: pulp>=2.8; extra == 'all'
+Requires-Dist: pyomo>=6.7; extra == 'all'
+Requires-Dist: torch-geometric>=2.4; extra == 'all'
+Requires-Dist: torch>=2.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: jsonschema>=4.0; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: networkx>=3.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.6; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff<0.16,>=0.15.12; extra == 'dev'
+Provides-Extra: dgl
+Requires-Dist: dgl>=2.0; extra == 'dgl'
+Requires-Dist: torch>=2.0; extra == 'dgl'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
+Provides-Extra: mining
+Requires-Dist: hdbscan>=0.8; extra == 'mining'
+Requires-Dist: networkx>=3.0; extra == 'mining'
+Requires-Dist: nltk>=3.8; extra == 'mining'
+Requires-Dist: pyomo>=6.7; extra == 'mining'
+Provides-Extra: networkx
+Requires-Dist: networkx>=3.0; extra == 'networkx'
+Provides-Extra: pyg
+Requires-Dist: torch-geometric>=2.4; extra == 'pyg'
+Requires-Dist: torch>=2.0; extra == 'pyg'
+Provides-Extra: pyomo
+Requires-Dist: pyomo>=6.7; extra == 'pyomo'
+Provides-Extra: solver
+Requires-Dist: highspy>=1.7; extra == 'solver'
+Requires-Dist: pulp>=2.8; extra == 'solver'
+Description-Content-Type: text/markdown
+
+# lp2graph
+
+[![ci](https://github.com/joernmht/lp2graph/actions/workflows/ci.yml/badge.svg)](https://github.com/joernmht/lp2graph/actions/workflows/ci.yml)
+[![docs](https://github.com/joernmht/lp2graph/actions/workflows/docs.yml/badge.svg)](https://github.com/joernmht/lp2graph/actions/workflows/docs.yml)
+[![PyPI](https://img.shields.io/pypi/v/lp2graph.svg)](https://pypi.org/project/lp2graph/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+**Typed-graph representation of LP, MIP, and MILP formulations.**
+
+`lp2graph` is a focused library for representing optimization problems as
+typed graphs and deriving multiple views of them — schema, hybrid, and
+ground — from a single canonical data model. It ships:
+
+- A version-stable JSON schema for formulations.
+- Three view derivations that turn a formulation into a typed graph.
+- Structural metrics computed deterministically over the model and views.
+- SVG renderers and a static interactive viewer.
+- Export adapters to PyG, DGL, NetworkX, LaTeX, and Pyomo.
+
+The core has no solver dependency. Pyomo, JuMP, and friends are optional
+extras.
+
+## Install
+
+```bash
+pip install lp2graph                       # core only
+pip install "lp2graph[networkx]"           # NetworkX export
+pip install "lp2graph[pyg]"                # PyG export
+pip install "lp2graph[all]"                # everything
+```
+
+## 60-second tour
+
+```python
+from lp2graph import load
+from lp2graph.views import schema, hybrid, ground
+from lp2graph.metrics.structural import structural_summary
+from lp2graph.metrics.flags import presence_flags
+from lp2graph.render.svg import render_svg
+
+f = load("formulations/constraints/mip_2_1_big_m.json")
+
+# Three views from one canonical model.
+g_schema  = schema(f)                       # templates and indices
+g_hybrid  = hybrid(f)                       # + offset-labeled edges
+g_ground  = ground(f, {"I": 4})             # + degeneracy filters
+
+# Metrics, deterministic.
+print(structural_summary(g_schema)["graph_diameter"].value)
+print(presence_flags(f)["has_big_m"].value)
+
+# Render with the deliberate visual identity.
+open("graph.svg", "w").write(render_svg(g_hybrid, title=f.name))
+```
+
+Or from the command line:
+
+```bash
+lp2graph validate formulations/constraints/lp_1_1_fixed_sequence.json
+lp2graph render   formulations/constraints/mip_2_1_big_m.json --view hybrid --output mip_2_1.svg
+lp2graph metrics  formulations/constraints/mip_2_4_time_indexed.json
+lp2graph export   formulations/constraints/mip_2_8_pesp.json --format latex
+```
+
+## Text ⇄ graph, and solving (deterministic, no LLM)
+
+Beyond the views, lp2graph offers a **bidirectional, deterministic**
+interface between a formulation's *text* and its *graph*, plus a real
+solver back-end:
+
+```bash
+# graph -> paper-style LaTeX (\mathcal sets, \sum, \forall, big-M) and back
+lp2graph latex   formulations/constraints/pesp_solvable.json --output pesp.tex
+lp2graph parse   pesp.tex                         # LaTeX -> canonical JSON
+
+# ground with instance data and solve the MILP (CBC / HiGHS / Gurobi)
+lp2graph solve   formulations/constraints/assignment.json \
+                 --instance corpus/validation/codec_pipeline/instances/assignment_4x4.json
+
+# graph -> natural-language problem description (+ data tables)
+lp2graph describe formulations/constraints/pesp_solvable.json --instance ...
+```
+
+```python
+from lp2graph import load, to_canonical_latex, from_canonical_latex, describe
+from lp2graph.solve import Instance, solve
+
+f = load("formulations/constraints/assignment.json")
+g = from_canonical_latex(to_canonical_latex(f))   # text round-trips the graph
+print(solve(g, Instance(cardinalities={"W": 4, "J": 4},
+                        parameters={"c": [[9, 2, 7, 8], ...]})).objective)
+```
+
+The codec is a tested fixed point and the solvable content round-trips
+exactly; an [end-to-end suite](corpus/validation/codec_pipeline/) confirms
+the JSON→LaTeX→parse→ground→solve loop reproduces independently-known
+optima across CBC/HiGHS/Gurobi. See
+[`docs/text-graph-interface.md`](docs/text-graph-interface.md).
+
+## What goes in, what comes out
+
+A **formulation** is a JSON document validated against
+[`schema/canonical.schema.json`](schema/canonical.schema.json). It declares
+*index families* (e.g. `I`, `T`), *parameters*, *variable templates*,
+*constraint templates* with quantifiers and bindings, and an optional
+*objective* with first-class terms.
+
+The **schema view** exposes templates and indices — the topology of the
+problem. The **hybrid view** adds per-term offset, sign, and modulo
+labels. The **ground view** materializes every instance at given index
+cardinalities and applies degeneracy filters.
+
+See [`docs/data-model.md`](docs/data-model.md) and
+[`docs/views.md`](docs/views.md) for the long form.
+
+## Status
+
+v0.1 is an alpha. The schema and the canonical model are stable for a
+representative cross-section of formulations; the catalog is in active
+expansion. Tracked open questions live as `open-question` issues so they
+are visible.
+
+## Documentation
+
+- [Data model](docs/data-model.md)
+- [Views](docs/views.md)
+- [Metrics](docs/metrics.md)
+- [Add a formulation](docs/add-a-formulation.md)
+- [Design context](docs/design-context.md) (the seed document)
+- [Extraction report](docs/extraction-report.md) (provenance from the source repo)
+- ADRs in [`docs/adr/`](docs/adr/)
+
+## Contributing
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md). Bugs, new formulations, design
+decisions, and good-first-issues all have dedicated templates.
+
+## License
+
+Apache 2.0. Portions adapted from
+[`joernmht/raiLPminerExperimentation`](https://github.com/joernmht/raiLPminerExperimentation)
+under MIT — see [`docs/extraction-report.md`](docs/extraction-report.md).