euler-loading 2.21.0__tar.gz → 2.26.0__tar.gz

euler_loading-2.26.0/.gitignore

@@ -0,0 +1,44 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test / coverage artifacts
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.tox/
+.nox/
+
+# Type checkers / linters
+.mypy_cache/
+.ruff_cache/
+.pytype/
+
+# Editors and OS cruft
+.vscode/
+.idea/
+.DS_Store
+
+# Local agent / assistant scratch (never part of a release)
+.claude/
+.ao-mcp/
+.ao-provider-auth/
+CLAUDE.md
+TASK.md
+
+# uv
+uv.lock

euler_loading-2.26.0/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+## Unreleased
+
+- Add `read_extrinsics` to the Synscapes loaders, building a 4x4 rigid
+  transform from the six `camera.extrinsic` scalars. `transform_direction`
+  and `camera_axes` select the pose, its inverse, and vehicle or optical
+  camera axes; the assumed `Rz(yaw) @ Ry(pitch) @ Rx(roll)` order is recorded
+  in the modality metadata because the dataset does not document it.
+- Add Synscapes writers for every modality, making the loader a
+  `DenseDepthCodec`. Depth writes a float32 EXR `Z` channel and needs a
+  filesystem path; the intrinsics and extrinsics writers merge into a single
+  `meta/<id>.json`, replacing it in one step and keeping its permissions,
+  symlink and unmodelled fields rather than truncating it in place.
+- `sky_mask` now honours `meta['sky_class_id']`, or the same key in per-file
+  attributes, instead of hardcoding Cityscapes ID 23, so a dataset that
+  relabels sky round-trips through `write_sky_mask`.
+- Accept the plural `camera.intrinsics` / `camera.extrinsics` spellings and
+  report missing camera fields by name instead of raising `KeyError`.
+
+## 2.24.0 (unreleased)
+
+Add source-backed capture, strict per-output writers, explicit NPY/PNG encoding, typed calibration views and replay. Consolidate pinhole geometry and correct legacy skew scaling.
+
+
+## 2.23.0 (source changes; not published)
+
+- Reject wrapped decoders during dataset export by checking actual built-in
+  function identity. Ordinary callable loading remains supported.
+- Apply boolean thresholds before Pillow dtype conversion, and permit exact
+  int32/int64 crop and identity-resize plans while refusing float32 resampling.
+- Add `SamplePreprocessor.export_descriptor`, `MultiModalDataset.export_transform_plan`,
+  `SerializableTransform`, and `resolve_transform_descriptor`, paired with contract 0.4.0.
+- Freeze profiles, qualified source/calibration bindings, field policies, operation
+  order, and installed CPU backend versions. Infer output profiles and virtual
+  calibration geometry without materialization claims.
+- Add explicit Torch/Pillow execution, corrected pinhole skew in the opt-in path,
+  validity-aware depth policy, source immutability, and worker validator registration.
+- Cover five-field round trips, projected geometry, ambiguous bindings, unsupported
+  semantics, backend choices, schemas, and spawned workers in synthetic tests.
+
+Legacy preprocessing and writer behavior remain unchanged. Execution receipts,
+materialized metadata propagation, producer wiring, and GT replay are later work.

euler_loading-2.26.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Rothenpieler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

euler_loading-2.26.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.5
+Name: euler-loading
+Version: 2.26.0
+Summary: Multi-modal PyTorch dataloader using ds-crawler indices
+Project-URL: Homepage, https://github.com/d-rothen/euler-loading
+Project-URL: Repository, https://github.com/d-rothen/euler-loading
+Project-URL: Issues, https://github.com/d-rothen/euler-loading/issues
+Project-URL: Documentation, https://github.com/d-rothen/euler-loading/tree/main/docs
+Author-email: Daniel Rothenpieler <rothenpielerdaniel@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: computer-vision,dataloader,dataset,depth-estimation,multi-modal,pytorch
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: ds-crawler>=2.11.0
+Requires-Dist: euler-dataset-contract>=0.5.0
+Requires-Dist: numpy
+Requires-Dist: pillow
+Provides-Extra: dev
+Requires-Dist: jsonschema>=4.18; extra == 'dev'
+Requires-Dist: openexr>=3.2; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: gpu
+Requires-Dist: torch; extra == 'gpu'
+Provides-Extra: synscapes
+Requires-Dist: openexr>=3.2; extra == 'synscapes'
+Description-Content-Type: text/markdown
+
+<!-- euler header — shared across the euler packages.
+     Per package, change only: the <h1>, the tagline, and the badge URLs. -->
+<p align="center">
+  <img src="https://files.chronodle.com/icons/euler.svg" alt="euler" width="96" height="96">
+</p>
+
+<h1 align="center">euler-loading</h1>
+
+<p align="center">
+  <em>One PyTorch <code>Dataset</code> across arbitrarily many data modalities — matched by ID, not by filename luck.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/euler-loading/"><img alt="PyPI" src="https://img.shields.io/pypi/v/euler-loading.svg"></a>
+  <a href="https://pypi.org/project/euler-loading/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/euler-loading.svg"></a>
+  <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+  <a href="https://github.com/d-rothen/euler-loading/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/d-rothen/euler-loading/actions/workflows/ci.yml/badge.svg"></a>
+</p>
+
+---
+
+Multi-modal datasets arrive as separate directory trees — RGB here, depth there,
+segmentation in a zip, calibration somewhere above it all. Keeping them in step
+usually means a pile of fragile path arithmetic.
+
+euler-loading replaces that. Each modality is indexed by
+[ds-crawler](https://github.com/d-rothen/ds-crawler), and euler-loading
+**intersects the file IDs** across modalities so every sample holds exactly one
+file per modality. Hierarchical files such as per-scene calibration are matched
+by their position in the tree and shared across the samples below them.
+
+```mermaid
+flowchart LR
+    A["rgb/"] --> X
+    B["depth/"] --> X
+    C["segmentation.zip"] --> X
+    X(["intersect file IDs"]) --> S["sample dict<br/>rgb · depth · segmentation<br/>id · full_id · meta · attributes"]
+    D["calib.json<br/><i>hierarchical</i>"] -.->|"matched by tree position"| S
+```
+
+It never interprets file contents. It resolves *which* file to load and hands
+the path — or an in-memory buffer, for zip-backed modalities — to a loader
+function, which you supply or let euler-loading resolve from the dataset's
+`dataset-head.json` contract.
+
+## Install
+
+```bash
+pip install "euler-loading[gpu]"
+```
+
+Requires Python 3.9+. The `[gpu]` extra pulls in PyTorch for the tensor loaders;
+without it the package still works using the CPU (NumPy) loaders.
+
+For Synscapes EXR depth files, install `euler-loading[synscapes]` (NumPy) or
+`euler-loading[gpu,synscapes]` (tensors). See the
+[Synscapes loaders](docs/loaders.md#synscapes--synscapes) for formats and usage.
+
+## Quick start
+
+```python
+from euler_loading import Modality, MultiModalDataset
+from euler_loading.loaders.gpu import vkitti2
+
+dataset = MultiModalDataset(
+    modalities={
+        "rgb":   Modality("/data/vkitti2/rgb",   loader=vkitti2.rgb,   split="train"),
+        "depth": Modality("/data/vkitti2/depth", loader=vkitti2.depth, split="train"),
+    },
+    hierarchical_modalities={
+        "intrinsics": Modality("/data/vkitti2/textgt", loader=vkitti2.read_intrinsics),
+    },
+)
+
+sample = dataset[0]
+sample["rgb"]         # torch.Tensor (3, H, W) float32 in [0, 1]
+sample["depth"]       # torch.Tensor (1, H, W) float32, metres
+sample["intrinsics"]  # {file_id: (3, 3) tensor} for every calib file above this sample
+sample["id"]          # leaf file ID, shared across modalities
+sample["full_id"]     # full hierarchical path, e.g. "/Scene01/Camera_0/00000"
+```
+
+Drop it straight into a `DataLoader` — it is a standard `torch.utils.data.Dataset`:
+
+```python
+loader = DataLoader(dataset, batch_size=16, num_workers=4, pin_memory=True)
+```
+
+## Automatic loader resolution
+
+Omit `loader=` and euler-loading resolves the loader declared by that
+modality's ds-crawler dataset contract:
+
+```python
+dataset = MultiModalDataset(
+    modalities={
+        "rgb": Modality("/data/vkitti2/rgb", split="train"),
+    },
+)
+```
+
+The modality root must contain `.ds_crawler/dataset-head.json` (or the scoped
+equivalent) with a named `euler_loading` entry in its `addons` object. A minimal
+RGB contract looks like this:
+
+```json
+{
+  "contract": {
+    "kind": "dataset_head",
+    "version": "1.0"
+  },
+  "dataset": {
+    "id": "vkitti2_rgb",
+    "name": "Virtual KITTI 2 RGB"
+  },
+  "modality": {
+    "key": "rgb",
+    "meta": {
+      "range": [0, 255]
+    }
+  },
+  "addons": {
+    "euler_loading": {
+      "version": "1.0",
+      "loader": "vkitti2",
+      "function": "rgb"
+    }
+  }
+}
+```
+
+`loader` selects a built-in loader module and `function` selects the callable
+inside it. Automatic resolution uses the GPU variant; pass a loader explicitly
+when you want the CPU variant or a custom callable. See
+[Automatic loader resolution](docs/loaders.md#automatic-loader-resolution) for
+the full contract and writer rules.
+
+## What you get
+
+| | |
+|---|---|
+| **ID intersection** | Every sample has exactly one file per modality. Unmatched files are reported, not silently dropped. |
+| **Hierarchical modalities** | Per-scene or per-sequence calibration is matched by tree position and cached, with deepest-file-wins inheritance. |
+| **Zip-native** | Point a modality at a `.zip` and files are read from the archive without extraction. One handle per worker. |
+| **Splits** | `Modality(path, split="train")` overlays a ds-crawler inline split on the canonical index. |
+| **Scoped metadata** | Several logical modalities can share one physical root or archive via `metadata_scope`. |
+| **Loader resolution** | Loaders and writers resolve from the `dataset-head.json` `addons.euler_loading` contract, so datasets describe how to read themselves. |
+| **Writing back** | Resolved writers put inference outputs back in dataset-native formats, re-indexable with matching IDs. |
+| **Spatial preprocessing** | `SamplePreprocessor` resizes and crops consistently across images, depth, masks, ray maps *and* intrinsics. |
+
+## Built-in loaders
+
+Every dataset module exists in two variants: `loaders.gpu.*` returns
+`torch.Tensor` in CHW layout, `loaders.cpu.*` returns `numpy.ndarray` in HWC.
+All of them accept both filesystem paths and in-memory buffers.
+
+| Module | Dataset | Modalities |
+|---|---|---|
+| `vkitti2` | Virtual KITTI 2 | rgb, depth, class/instance segmentation, scene flow, sky mask, intrinsics, extrinsics |
+| `muses` | MUSES | rgb, reference rgb, semantic & panoptic segmentation, sky mask, lidar point cloud, sparse depth, calibration |
+| `real_drive_sim` | Real Drive Sim | rgb, depth, class segmentation, sky mask, calibration, intrinsics, extrinsics |
+| `princeton_dense` | Princeton DENSE / SeeingThroughFog | rgb, rccb, sparse depth, intrinsics, extrinsics |
+| `generic_dense_depth` | *any* — inferred from file extension | rgb, depth, sky mask, intrinsics |
+| `generic` | *any* — `.npy` / `.npz` modalities | points 3d, maps, segmentation, spherical maps, SH coefficients, … |
+
+Full inventory with shapes, dtypes and units: [docs/loaders.md](docs/loaders.md).
+The machine-readable version is
+[`loaders.json`](euler_loading/loaders/generate/loaders.json).
+
+## Documentation
+
+- [Serializable resize/crop plans](docs/transform-descriptors.md): Phase 1 export,
+  explicit backend and calibration bindings, resolution, and output profiles.
+
+| Guide | Covers |
+|---|---|
+| [Dataset & modalities](docs/dataset.md) | `Modality` and `MultiModalDataset` reference, the sample dict, splits, scoped metadata, zip archives, layout-aware loading |
+| [Loaders & writers](docs/loaders.md) | The loader contract, automatic resolution, per-file attributes, the full built-in inventory |
+| [Preprocessing & transforms](docs/preprocessing.md) | Cross-modal transforms, `SamplePreprocessor`, calibration-aware resize and crop |
+| [Writing outputs](docs/writing.md) | Writing predictions back in dataset-native formats and re-indexing them |
+| [Examples](examples/) | Runnable scripts against real datasets |
+
+## Development
+
+```bash
+git clone https://github.com/d-rothen/euler-loading.git
+cd euler-loading
+pip install -e ".[gpu,dev]"
+pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the loader-authoring workflow and
+release process.
+
+## License
+
+[MIT](LICENSE) © Daniel Rothenpieler
+
+See [Phase 2 materialization](docs/materialization.md) for the opt-in captured spatial workflow (2.24.0, unreleased).

euler_loading-2.26.0/README.md

@@ -0,0 +1,199 @@
+<!-- euler header — shared across the euler packages.
+     Per package, change only: the <h1>, the tagline, and the badge URLs. -->
+<p align="center">
+  <img src="https://files.chronodle.com/icons/euler.svg" alt="euler" width="96" height="96">
+</p>
+
+<h1 align="center">euler-loading</h1>
+
+<p align="center">
+  <em>One PyTorch <code>Dataset</code> across arbitrarily many data modalities — matched by ID, not by filename luck.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/euler-loading/"><img alt="PyPI" src="https://img.shields.io/pypi/v/euler-loading.svg"></a>
+  <a href="https://pypi.org/project/euler-loading/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/euler-loading.svg"></a>
+  <a href="LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+  <a href="https://github.com/d-rothen/euler-loading/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/d-rothen/euler-loading/actions/workflows/ci.yml/badge.svg"></a>
+</p>
+
+---
+
+Multi-modal datasets arrive as separate directory trees — RGB here, depth there,
+segmentation in a zip, calibration somewhere above it all. Keeping them in step
+usually means a pile of fragile path arithmetic.
+
+euler-loading replaces that. Each modality is indexed by
+[ds-crawler](https://github.com/d-rothen/ds-crawler), and euler-loading
+**intersects the file IDs** across modalities so every sample holds exactly one
+file per modality. Hierarchical files such as per-scene calibration are matched
+by their position in the tree and shared across the samples below them.
+
+```mermaid
+flowchart LR
+    A["rgb/"] --> X
+    B["depth/"] --> X
+    C["segmentation.zip"] --> X
+    X(["intersect file IDs"]) --> S["sample dict<br/>rgb · depth · segmentation<br/>id · full_id · meta · attributes"]
+    D["calib.json<br/><i>hierarchical</i>"] -.->|"matched by tree position"| S
+```
+
+It never interprets file contents. It resolves *which* file to load and hands
+the path — or an in-memory buffer, for zip-backed modalities — to a loader
+function, which you supply or let euler-loading resolve from the dataset's
+`dataset-head.json` contract.
+
+## Install
+
+```bash
+pip install "euler-loading[gpu]"
+```
+
+Requires Python 3.9+. The `[gpu]` extra pulls in PyTorch for the tensor loaders;
+without it the package still works using the CPU (NumPy) loaders.
+
+For Synscapes EXR depth files, install `euler-loading[synscapes]` (NumPy) or
+`euler-loading[gpu,synscapes]` (tensors). See the
+[Synscapes loaders](docs/loaders.md#synscapes--synscapes) for formats and usage.
+
+## Quick start
+
+```python
+from euler_loading import Modality, MultiModalDataset
+from euler_loading.loaders.gpu import vkitti2
+
+dataset = MultiModalDataset(
+    modalities={
+        "rgb":   Modality("/data/vkitti2/rgb",   loader=vkitti2.rgb,   split="train"),
+        "depth": Modality("/data/vkitti2/depth", loader=vkitti2.depth, split="train"),
+    },
+    hierarchical_modalities={
+        "intrinsics": Modality("/data/vkitti2/textgt", loader=vkitti2.read_intrinsics),
+    },
+)
+
+sample = dataset[0]
+sample["rgb"]         # torch.Tensor (3, H, W) float32 in [0, 1]
+sample["depth"]       # torch.Tensor (1, H, W) float32, metres
+sample["intrinsics"]  # {file_id: (3, 3) tensor} for every calib file above this sample
+sample["id"]          # leaf file ID, shared across modalities
+sample["full_id"]     # full hierarchical path, e.g. "/Scene01/Camera_0/00000"
+```
+
+Drop it straight into a `DataLoader` — it is a standard `torch.utils.data.Dataset`:
+
+```python
+loader = DataLoader(dataset, batch_size=16, num_workers=4, pin_memory=True)
+```
+
+## Automatic loader resolution
+
+Omit `loader=` and euler-loading resolves the loader declared by that
+modality's ds-crawler dataset contract:
+
+```python
+dataset = MultiModalDataset(
+    modalities={
+        "rgb": Modality("/data/vkitti2/rgb", split="train"),
+    },
+)
+```
+
+The modality root must contain `.ds_crawler/dataset-head.json` (or the scoped
+equivalent) with a named `euler_loading` entry in its `addons` object. A minimal
+RGB contract looks like this:
+
+```json
+{
+  "contract": {
+    "kind": "dataset_head",
+    "version": "1.0"
+  },
+  "dataset": {
+    "id": "vkitti2_rgb",
+    "name": "Virtual KITTI 2 RGB"
+  },
+  "modality": {
+    "key": "rgb",
+    "meta": {
+      "range": [0, 255]
+    }
+  },
+  "addons": {
+    "euler_loading": {
+      "version": "1.0",
+      "loader": "vkitti2",
+      "function": "rgb"
+    }
+  }
+}
+```
+
+`loader` selects a built-in loader module and `function` selects the callable
+inside it. Automatic resolution uses the GPU variant; pass a loader explicitly
+when you want the CPU variant or a custom callable. See
+[Automatic loader resolution](docs/loaders.md#automatic-loader-resolution) for
+the full contract and writer rules.
+
+## What you get
+
+| | |
+|---|---|
+| **ID intersection** | Every sample has exactly one file per modality. Unmatched files are reported, not silently dropped. |
+| **Hierarchical modalities** | Per-scene or per-sequence calibration is matched by tree position and cached, with deepest-file-wins inheritance. |
+| **Zip-native** | Point a modality at a `.zip` and files are read from the archive without extraction. One handle per worker. |
+| **Splits** | `Modality(path, split="train")` overlays a ds-crawler inline split on the canonical index. |
+| **Scoped metadata** | Several logical modalities can share one physical root or archive via `metadata_scope`. |
+| **Loader resolution** | Loaders and writers resolve from the `dataset-head.json` `addons.euler_loading` contract, so datasets describe how to read themselves. |
+| **Writing back** | Resolved writers put inference outputs back in dataset-native formats, re-indexable with matching IDs. |
+| **Spatial preprocessing** | `SamplePreprocessor` resizes and crops consistently across images, depth, masks, ray maps *and* intrinsics. |
+
+## Built-in loaders
+
+Every dataset module exists in two variants: `loaders.gpu.*` returns
+`torch.Tensor` in CHW layout, `loaders.cpu.*` returns `numpy.ndarray` in HWC.
+All of them accept both filesystem paths and in-memory buffers.
+
+| Module | Dataset | Modalities |
+|---|---|---|
+| `vkitti2` | Virtual KITTI 2 | rgb, depth, class/instance segmentation, scene flow, sky mask, intrinsics, extrinsics |
+| `muses` | MUSES | rgb, reference rgb, semantic & panoptic segmentation, sky mask, lidar point cloud, sparse depth, calibration |
+| `real_drive_sim` | Real Drive Sim | rgb, depth, class segmentation, sky mask, calibration, intrinsics, extrinsics |
+| `princeton_dense` | Princeton DENSE / SeeingThroughFog | rgb, rccb, sparse depth, intrinsics, extrinsics |
+| `generic_dense_depth` | *any* — inferred from file extension | rgb, depth, sky mask, intrinsics |
+| `generic` | *any* — `.npy` / `.npz` modalities | points 3d, maps, segmentation, spherical maps, SH coefficients, … |
+
+Full inventory with shapes, dtypes and units: [docs/loaders.md](docs/loaders.md).
+The machine-readable version is
+[`loaders.json`](euler_loading/loaders/generate/loaders.json).
+
+## Documentation
+
+- [Serializable resize/crop plans](docs/transform-descriptors.md): Phase 1 export,
+  explicit backend and calibration bindings, resolution, and output profiles.
+
+| Guide | Covers |
+|---|---|
+| [Dataset & modalities](docs/dataset.md) | `Modality` and `MultiModalDataset` reference, the sample dict, splits, scoped metadata, zip archives, layout-aware loading |
+| [Loaders & writers](docs/loaders.md) | The loader contract, automatic resolution, per-file attributes, the full built-in inventory |
+| [Preprocessing & transforms](docs/preprocessing.md) | Cross-modal transforms, `SamplePreprocessor`, calibration-aware resize and crop |
+| [Writing outputs](docs/writing.md) | Writing predictions back in dataset-native formats and re-indexing them |
+| [Examples](examples/) | Runnable scripts against real datasets |
+
+## Development
+
+```bash
+git clone https://github.com/d-rothen/euler-loading.git
+cd euler-loading
+pip install -e ".[gpu,dev]"
+pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the loader-authoring workflow and
+release process.
+
+## License
+
+[MIT](LICENSE) © Daniel Rothenpieler
+
+See [Phase 2 materialization](docs/materialization.md) for the opt-in captured spatial workflow (2.24.0, unreleased).

euler_loading-2.26.0/docs/README.md

@@ -0,0 +1,34 @@
+# euler-loading documentation
+
+| Guide | Covers |
+|---|---|
+| [Dataset & modalities](dataset.md) | `Modality` and `MultiModalDataset` reference, the sample dict, hierarchical modalities, splits, scoped metadata, zip archives, layout-aware loading |
+| [Loaders & writers](loaders.md) | The loader contract, per-file attributes, automatic resolution, protocols, and the full built-in loader inventory |
+| [Preprocessing & transforms](preprocessing.md) | Cross-modal transforms, `SamplePreprocessor`, field kinds, calibration-aware resize and crop |
+| [Writing outputs](writing.md) | Writing predictions back in dataset-native formats and re-indexing them |
+
+Runnable scripts live in [`examples/`](../examples/). Contributor-facing notes —
+adding a loader, running tests, cutting a release — are in
+[CONTRIBUTING.md](../CONTRIBUTING.md).
+
+## Concepts in one page
+
+**ds-crawler indexes, euler-loading joins.** Each modality root carries its own
+[ds-crawler](https://github.com/d-rothen/ds-crawler) index describing the files
+it contains and the hierarchy they sit in. euler-loading reads those indexes and
+intersects file IDs so every sample holds one file per modality.
+
+**Regular vs hierarchical modalities.** Regular modalities participate in the ID
+intersection — one file each, per sample. Hierarchical modalities do not; their
+files are matched by tree position, so a per-scene calibration file is shared by
+every sample beneath it.
+
+**Loaders own all file semantics.** euler-loading never interprets file
+contents. It resolves which file to read and passes a path — or an in-memory
+buffer, for zip-backed modalities — to a loader function.
+
+**The dataset-head contract drives resolution.** Each modality can declare an
+`addons.euler_loading` entry in `.ds_crawler/dataset-head.json`. Its `loader`
+and `function` fields select the built-in reader, while the same addon can
+describe writer choice, modality roles and logging slots. See
+[Automatic loader resolution](loaders.md#automatic-loader-resolution).