thundercode commited on
Commit
e92a5b5
·
verified ·
1 Parent(s): 8c67d35

release: add README_FULL.md

Browse files
Files changed (1) hide show
  1. README_FULL.md +29 -13
README_FULL.md CHANGED
@@ -375,18 +375,34 @@ a hard zero cannot become a NaN.
375
 
376
  ### Repository map
377
 
 
 
 
 
 
 
 
 
378
  | Path | Contents |
379
  |---|---|
380
- | `app/` | FastAPI inference service and its composition root |
381
- | `core/` | Config registry, evidence engine, contracts |
382
- | `specialists/` | One module per specialist (vqa, caption, grounding, change, optical_sar) |
383
- | `router/` | MiniLM intent router |
384
- | `gateway/` | Render orchestration hub (`/api/*`, CORS, wake flow) |
385
- | `frontend/` | The static console (HTML/CSS/JS) |
386
- | `configs/base.yaml` | The frozen configuration registry — single source of truth |
387
- | `evaluation/`, `training/` | Evaluation harnesses and training entry points |
388
- | `artifacts/` | Trained heads, checkpoints, evaluation outputs, provenance |
389
- | `docs/` | Architecture, models, benchmarks, deployment, limitations |
 
 
 
 
 
 
 
 
390
 
391
  The component inventory in full (every path is the authoritative location):
392
 
@@ -1116,8 +1132,8 @@ The deployed stack is reachable. Note the authoring sandbox has a dead proxy, so
1116
  `--noproxy '*'` (curl) or `ProxyHandler({})` (Python):
1117
 
1118
  ```bash
1119
- curl --noproxy '*' https://satquery-backend-m4yv.onrender.com/api/health
1120
- curl --noproxy '*' https://satquery-backend-m4yv.onrender.com/api/capabilities
1121
  ```
1122
 
1123
  `/api/capabilities` returns six tasks, all `available: true`. A live run requires the tunnel agent to be
@@ -1144,7 +1160,7 @@ Render → start the Codespace if stopped → poll `/v1/health` → surface *"Wa
1144
  | Component | Repository | Visibility | Revision | Host |
1145
  |---|---|---|---|---|
1146
  | Frontend | `Anish-lab-blip/SatQuery-Frontend` | private | **`2d7ae53b482d`** | Cloudflare Pages → `satquery.pages.dev` |
1147
- | Backend / orchestrator | `Anish-lab-blip/SatQuery-Backend` | private | **`89d80eaddec5`** | Render → `satquery-backend-m4yv.onrender.com` |
1148
  | Inference | `Anish-lab-blip/SatQuery-Inference` | private | **`5a0936ace491`** | Codespace, port 8000, via outbound tunnel |
1149
  | Public umbrella | `Anish-lab-blip/SatQuery-AI` | **public** | `3dcabd32da41` | this release home |
1150
 
 
375
 
376
  ### Repository map
377
 
378
+ > **Scope of this repository.** It contains the **documentation and the source code only**. It
379
+ > deliberately does **not** contain: datasets, the `artifacts/` tree (trained weights, checkpoints,
380
+ > evaluation outputs), Jupyter notebooks, the static frontend, logs, or any credential. The six
381
+ > trained artifacts are published on the [Hugging Face Hub](https://huggingface.co/thundercode/SatQuery);
382
+ > the frozen backbones are fetched from the Hub at run time. Some documents cite the source
383
+ > repository's internal phase reports by filename as provenance — those files are not part of this
384
+ > release.
385
+
386
  | Path | Contents |
387
  |---|---|
388
+ | `app/` | FastAPI inference service and its composition root (`build_space_app()`, `serving.py`) |
389
+ | `core/` | The typed contracts, config registry + loader, nine-state controller, planner, registry, errors |
390
+ | `router/` | The MiniLM intent router: encoder, five-head adapter, classifier, lexical fallback, label space, dataset, training |
391
+ | `specialists/` | One module per specialist: `vqa/`, `grounding/`, `change/`, `optical_sar/`, plus `base.py` |
392
+ | `evidence/` | The evidence engine (aggregation) and the confidence/calibration module |
393
+ | `preprocessing/`, `geospatial/` | Raster handling, tiling, normalisation, sensor adapters |
394
+ | `gateway/` | The orchestrator / gateway (`/api/*`, CORS, wake flow, error translation) |
395
+ | `deploy/` | Deployment entrypoints: Codespace `serve.py` + `tunnel_agent.py`, Render blueprint |
396
+ | `training/`, `evaluation/` | Training entry points and evaluation harnesses |
397
+ | `scripts/` | Repository scripts (data prep, calibration fitting, packaging) |
398
+ | `tests/` | The test suite |
399
+ | `configs/base.yaml` | The frozen configuration registry — the single source of truth for every tunable |
400
+ | `docs/` | Architecture, models, benchmarks, datasets, training, evaluation, deployment, security, testing, operations, performance, glossary, limitations |
401
+ | `models/` | The **generated** artifact manifest and checksums (identities, not the weights) |
402
+ | `tools/` | Verification tooling (metric verification, manifest generation, archive tools) |
403
+ | `screenshots/` | Real live-run captures referenced by the documentation |
404
+
405
+ Not in this repository: `artifacts/`, `data/`, `notebooks/`, `frontend/`, `logs/`, `reports/`.
406
 
407
  The component inventory in full (every path is the authoritative location):
408
 
 
1132
  `--noproxy '*'` (curl) or `ProxyHandler({})` (Python):
1133
 
1134
  ```bash
1135
+ curl --noproxy '*' https://<backend-host>/api/health
1136
+ curl --noproxy '*' https://<backend-host>/api/capabilities
1137
  ```
1138
 
1139
  `/api/capabilities` returns six tasks, all `available: true`. A live run requires the tunnel agent to be
 
1160
  | Component | Repository | Visibility | Revision | Host |
1161
  |---|---|---|---|---|
1162
  | Frontend | `Anish-lab-blip/SatQuery-Frontend` | private | **`2d7ae53b482d`** | Cloudflare Pages → `satquery.pages.dev` |
1163
+ | Backend / orchestrator | `Anish-lab-blip/SatQuery-Backend` | private | **`89d80eaddec5`** | Render → `<backend-host>` |
1164
  | Inference | `Anish-lab-blip/SatQuery-Inference` | private | **`5a0936ace491`** | Codespace, port 8000, via outbound tunnel |
1165
  | Public umbrella | `Anish-lab-blip/SatQuery-AI` | **public** | `3dcabd32da41` | this release home |
1166