feat(docs): update README and plan to reflect task implementations
- mark tasks 10 and 11 as implemented in the project overview - add provenance note regarding the initial prompt in README.md - clarify the relationship between the prompt and specifications in 00_PLAN.md - update documentation structure to include Initial_Prompt.md for historical context
This commit is contained in:
12
README.md
12
README.md
@@ -66,8 +66,8 @@ machine (no parallel work). Every task writes a completion marker
|
||||
| 07 Convert to RDF | `convert_rdf.py` | `out/rdf/dataset.nt.gz`, `dataset.ttl`, oxigraph store | implemented |
|
||||
| 08 Benchmark queries | `make_queries.py` | `out/bench/queries/`, `out/bench/expected/` | implemented |
|
||||
| 09 Benchmark execution | `bench_runner.py` | `out/bench/results_raw.csv`, `results_median.csv` | implemented |
|
||||
| 10 Extrapolation | `extrapolate.py` | `out/bench/extrapolation.csv`, `hardware_sizing.csv` | planned |
|
||||
| 11 Reporting | `report.py` | `out/report/REPORT.md`, charts, tables | planned |
|
||||
| 10 Extrapolation | `extrapolate.py` | `out/bench/extrapolation.csv`, `hardware_sizing.csv` | implemented |
|
||||
| 11 Reporting | `report.py` | `out/report/REPORT.md`, charts, tables | implemented |
|
||||
|
||||
## The simulated laboratory
|
||||
|
||||
@@ -140,6 +140,7 @@ measurement counts. See
|
||||
|
||||
```
|
||||
docs/
|
||||
Initial_Prompt.md the generative prompt behind specs 00-11 (provenance, non-binding)
|
||||
specs/ task specifications 00-11 (WHAT to build)
|
||||
rules/ binding conventions (HOW work is done)
|
||||
research/ measured design studies (e.g. FK key-schema study)
|
||||
@@ -157,13 +158,18 @@ convert_postgresql.py task 06 entry script (TRIBO_PG_DSN, TRIBO_PROM_URL)
|
||||
convert_rdf.py task 07 entry script
|
||||
make_queries.py task 08 entry script (canonical results need TRIBO_PG_DSN)
|
||||
bench_runner.py task 09 entry script (TRIBO_PG_DSN, TRIBO_PROM_URL)
|
||||
extrapolate.py task 10 entry script (seeds editable out/config/hw_prices.yaml)
|
||||
report.py task 11 entry script (REPORT.md, charts, tables, scoring)
|
||||
requirements.txt closed dependency list (docs/rules/code-python-style.md)
|
||||
```
|
||||
|
||||
The `out/` tree - including the ~150 MB CSV corpus, the ~1 GB JSON-LD variant,
|
||||
databases, and benchmark results - is **excluded from git**. Sources of truth
|
||||
are the specs, the rules, and the code; every artifact regenerates
|
||||
deterministically from them.
|
||||
deterministically from them. [docs/Initial_Prompt.md](docs/Initial_Prompt.md)
|
||||
is the original prompt the 12 specification files were generated from - kept
|
||||
for provenance only, never authoritative: where it disagrees with the specs,
|
||||
rules, or code (e.g. the SQLite key schema, the JSON-LD vocabulary), those win.
|
||||
|
||||
## Getting started
|
||||
|
||||
|
||||
Reference in New Issue
Block a user