Skip to main content

Compile Markdown/LaTeX MIP models into standalone Python solver scripts

Project description

md2mip

Compile natural-language optimization models into standalone solver CLIs.

markdown → (LLM) → IR → codegen → solver CLI (Python + HiGHS)
image    → (OCR) → markdown → …

Examples

1. Quick run — data in markdown (knapsack)

models/knapsack.md:

0-1 Knapsack

We have 5 items. Knapsack capacity W=15.

Values: v = (4, 2, 10, 1, 2)

Weights: w = (12, 1, 4, 1, 2)

Pick items to maximize value: max ∑ v_i x_i   s.t. ∑ w_i x_i ≤ W,   x_i ∈ {0, 1}

One command — the LLM extracts the data automatically:

md2mip run models/knapsack.md

Output:

Status: optimal
Objective: 15.0
Solution:
  x[item1] = 0.0
  x[item2] = 1.0
  x[item3] = 1.0
  x[item4] = 1.0
  x[item5] = 1.0

2. Compile + run with different data (transportation)

models/transportation.md:

Transportation Problem

Sources I={1,2}, destinations J={1,2,3}. Cost matrix c, supply s=(30, 50), demand d=(20, 25, 35).

min ∑ c_ij x_ij   s.t. ∑_j x_ij ≤ s_i,   ∑_i x_ij ≥ d_j

# Compile — generates solver script AND data template
md2mip compile models/transportation.md

Output:

Parsed: 2 sets, 3 params, 1 vars, 2 constraints
Confidence: high (no warnings)
Written: out/transportation_solver.py
Written: out/transportation_data.yaml
Run:     python out/transportation_solver.py out/transportation_data.yaml

Run the generated solver directly — swap in any data file:

# Run with the generated default data
python out/transportation_solver.py out/transportation_data.yaml

# Run with a larger instance
python out/transportation_solver.py data/transportation_large.yaml

Output:

Status: optimal
Objective: 215.0000
Solution:
  x[factory1,warehouse1] = 20.0000
  x[factory1,warehouse3] = 10.0000
  x[factory2,warehouse2] = 25.0000
  x[factory2,warehouse3] = 25.0000

compile always writes two files:

  • out/<name>_solver.py — standalone solver script
  • out/<name>_data.yaml — complete data (if model has inline data) or template to fill in

3. OCR — image to markdown

Got a photo of a model? OCR extracts it:

Knapsack model photo

md2mip ocr docs/knapsack_photo.png -o model.md

Output:

Extracted model from docs/knapsack_photo.png
Written: model.md
Run:     md2mip compile model.md

Install

pip install md2mip

Configuration

cp .env.template .env
# Set your ANTHROPIC_API_KEY in .env

CLI

Command Description
compile Markdown → standalone solver CLI
run Compile and immediately run with data
validate Compile, run, check expected objective
ocr Extract a math model from an image (LLM vision)

Run md2mip --help or md2mip <command> --help for details.

Development

make test       # offline tests (no LLM)
make test-llm   # LLM integration tests
make lint       # ruff check
make fmt        # ruff format
make typecheck  # mypy

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

md2mip-0.1.1.tar.gz (32.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

md2mip-0.1.1-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file md2mip-0.1.1.tar.gz.

File metadata

  • Download URL: md2mip-0.1.1.tar.gz
  • Upload date:
  • Size: 32.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for md2mip-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c9fb88a8fd7aa2528b2a8e5cf8802afea8d85c09bd8c0c406ab0adce1c539cd5
MD5 f1bb2b20b67f81e22c9d395a90261bd0
BLAKE2b-256 e11c160acd32bea1efa083a1e111ef26c756db308f8ba0a1f53d27d5f8392506

See more details on using hashes here.

Provenance

The following attestation bundles were made for md2mip-0.1.1.tar.gz:

Publisher: publish.yml on spoorendonk/md2mip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file md2mip-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: md2mip-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 25.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for md2mip-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ff57418382099ec0c193be79c0d24bb6ac85a22e316af986772d165ef4245be
MD5 e5c905d68fe58cb9324f8e556645a74a
BLAKE2b-256 3743ec991b7474bfca7ff185cd3e7a38677ef50b24c38aa678237a3df9bb4043

See more details on using hashes here.

Provenance

The following attestation bundles were made for md2mip-0.1.1-py3-none-any.whl:

Publisher: publish.yml on spoorendonk/md2mip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page