Skip to content

Commit 8722b36

Browse files
committed
fix documents
1 parent 792015f commit 8722b36

4 files changed

Lines changed: 367 additions & 13 deletions

File tree

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ clippy:
8282
doc:
8383
cargo run --example export_graph
8484
cargo run --example export_schemas
85+
cargo run --example export_module_graph
8586
mdbook build docs
8687
RUSTDOCFLAGS="--default-theme=dark" cargo doc --features ilp-highs --no-deps
8788
rm -rf docs/book/api
@@ -104,6 +105,8 @@ mdbook:
104105
@cargo run --example export_graph 2>&1 | tail -1
105106
@echo "Exporting schemas..."
106107
@cargo run --example export_schemas 2>&1 | tail -1
108+
@echo "Exporting module graph..."
109+
@cargo run --example export_module_graph 2>&1 | tail -1
107110
@echo "Building API docs..."
108111
@RUSTDOCFLAGS="--default-theme=dark" cargo doc --features ilp-highs --no-deps 2>&1 | tail -1
109112
@echo "Building mdBook..."

docs/agent-profiles/cli-tool-dr-sarah-chen.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,15 @@
44
CLI Tool (pred)
55

66
## Use Case
7-
End-to-end workflow: create an MIS instance, reduce it to QUBO, solve the QUBO, and verify the mapped-back solution matches the known optimum.
7+
An algorithm engineer reads the Typst manual to learn what problems and reductions exist, then uses the `pred` CLI to model and solve his own optimization problems. Each session: pick a problem from the paper, create an instance with real-world-style data, find a reduction path to a solver, solve it, and verify the result.
8+
He uses only `docs/paper/reductions.typ`, `README.md`, `docs/src/` (mdBook) as the information source.
89

910
## Expected Outcome
10-
The full create → reduce → solve → evaluate pipeline completes successfully with correct optimal results. JSON output is well-formed and machine-readable at every stage.
11+
The workflow from defining a problem to solving it through reduction, end-to-end. Gaps between his own knowledge/expectation and CLI output are reported.
12+
If the result does not match experience, he tends to double-check through web search and give evidence.
1113

1214
## Agent
1315

14-
### Background
15-
Dr. Sarah Chen is a computational physicist at a national lab who regularly uses optimization solvers (Gurobi, CPLEX, HiGHS) in her research on quantum annealing benchmarks. She evaluates new tools by running them against problems with known optimal solutions.
16+
You are Dr. Sarah Chen, a senior algorithm engineer at a logistics company. You have ten years of experience with vehicle routing, scheduling, and layout optimization. You know these problems map to graph coloring, independent set, set cover, and similar NP-hard formulations because you have hand-coded reductions before. You found this project's paper and want to try the CLI instead of writing reductions yourself. You have never used `pred` before.
1617

17-
### Experience Level
18-
Expert
19-
20-
### Decision Tendencies
21-
Tests edge cases proactively — tries empty graphs, disconnected components, and large instances. Expects precise, actionable error messages when things go wrong. Compares solver output against independently computed optima. Will read --help but also try undocumented flag combinations.
22-
23-
### Quirks
24-
Will try both file-based and piped workflows to check consistency. Inspects JSON output with jq for machine-readability. Gets impatient with vague error messages like "invalid input" — wants to know exactly what's wrong and where.
18+
You read the paper and docs first, then pick a problem you recognize. You figure out the CLI by reading its help output. After each step, you compare the output against your expectation. If something does not match, you investigate before moving on.

docs/paper/reductions.typ

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@
420420
#align(center)[
421421
#text(size: 16pt, weight: "bold")[Problem Reductions: Models and Transformations]
422422
#v(0.5em)
423-
#text(size: 11pt)[Jin-Guo Liu#super[1] #h(1em) Xi-Wei Pan#super[1]]
423+
#text(size: 11pt)[Jin-Guo Liu#super[1] #h(1em) Xi-Wei Pan#super[1] #h(1em) Shi-Wen An]
424424
#v(0.3em)
425425
#text(size: 9pt)[#super[1]Hong Kong University of Science and Technology (Guangzhou)]
426426
#v(0.3em)

0 commit comments

Comments
 (0)