relflow 0.0.1__tar.gz

relflow-0.0.1/LICENSE

@@ -0,0 +1,178 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Grantham Taylor

relflow-0.0.1/NOTICE

@@ -0,0 +1,8 @@
+JSON2Vec
+Copyright 2024-2026 Grantham Taylor
+
+This project is licensed under the Apache License, Version 2.0.
+You may obtain a copy of the License at:
+http://www.apache.org/licenses/LICENSE-2.0
+
+This NOTICE file is provided for attribution purposes.

relflow-0.0.1/PKG-INFO

@@ -0,0 +1,445 @@
+Metadata-Version: 2.4
+Name: relflow
+Version: 0.0.1
+Summary: Schema-first PyTorch models for hierarchical / nested / sequence data structures
+Author: Grantham Taylor
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: beartype>=0.21.0
+Requires-Dist: pluggy>=1.6.0
+Requires-Dist: rich>=14.0.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: jmespath>=1.0.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: anytree>=2.13.0
+Requires-Dist: pyarrow>=21.0.0
+Requires-Dist: polars>=1.35.2
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: lightning>=2.6.4
+Requires-Dist: tensordict>=0.10.0
+Requires-Dist: torch>=2.7.1
+Requires-Dist: torchmetrics>=1.9.0
+Provides-Extra: serving
+Requires-Dist: fastapi>=0.124.0; extra == "serving"
+Requires-Dist: orjson>=3.10.0; extra == "serving"
+Requires-Dist: pydantic-settings>=2.10.1; extra == "serving"
+Requires-Dist: uvicorn>=0.38.0; extra == "serving"
+Provides-Extra: text
+Requires-Dist: transformers>=4.55.0; extra == "text"
+Provides-Extra: docs
+Requires-Dist: marimo>=0.23.8; extra == "docs"
+Dynamic: license-file
+
+<h1 align="center"><code>json2vec</code></h1>
+
+<p align="center">
+  <img alt="Python 3.12+" src="https://img.shields.io/badge/python-3.12%2B-3776AB?logo=python&amp;logoColor=white" />
+  <a href="LICENSE"><img alt="Apache-2.0 license" src="https://img.shields.io/badge/license-Apache--2.0-2E8B57" /></a>
+  <a href="https://json2vec.github.io/json2vec/"><img alt="Documentation" src="https://img.shields.io/badge/docs-Quarto-39729E?logo=quarto&amp;logoColor=white" /></a>
+  <!-- discord-invite:start -->
+  <a href="https://discord.gg/DVyZUkvTFA"><img alt="Discord channel invite" src="https://img.shields.io/badge/discord-join%20the%20channel-5865F2?logo=discord&amp;logoColor=white" /></a>
+  <!-- discord-invite:end -->
+</p>
+
+`json2vec` builds PyTorch/Lightning models directly from JSON-like schemas.
+It is meant for predictive modeling on records that are not naturally flat:
+customers with transactions, orders with line items, sessions with clickstream
+events, devices recurring across histories, and mixed datatypes at every level.
+
+Most ML pipelines flatten that shape first, then train on one fixed feature
+row. `json2vec` takes the opposite path: describe the structured record, and
+the schema becomes the model.
+
+## Core Idea
+
+A `json2vec` schema is both a data contract and an architecture blueprint.
+
+- Leaf fields such as `Number`, `Category`, `Set`, `Entity`, `Text`, and
+  `Vector` become datatype-specific tensorfields.
+- `Branch` nodes define shared contexts for child fields, with optional local
+  attention and pooling before the representation flows upward.
+- Targets, masks, pruning, and embeddings are configured on the same schema
+  tree.
+- Prediction output is keyed by schema address, so decoded values and
+  embeddings remain attached to the part of the record that produced them.
+
+That gives one model surface for supervised prediction, masked reconstruction,
+unsupervised embedding workflows, schema mutation, field importance, batch
+inference, and serving.
+
+## A Model From A Nested Record
+
+```python
+import json2vec as jv
+
+model = jv.Model(
+    name="order",
+    d_model=64,
+    n_layers=2,
+    n_heads=4,
+    embed=True,
+    customer_tier=jv.Category(size=16),
+    line_items=jv.Branch(
+        length=32,
+        embed=True,
+        sku=jv.Category(size=2048),
+        quantity=jv.Number,
+        price=jv.Number,
+    ),
+    returned=jv.Category(target=True, size=2),
+)
+```
+
+This model reads records shaped like:
+
+```python
+{
+    "customer_tier": "gold",
+    "line_items": [
+        {"sku": "A12", "quantity": 2, "price": 19.99},
+        {"sku": "B07", "quantity": 1, "price": 45.50},
+    ],
+    "returned": "false",
+}
+```
+
+The `line_items` branch has its own repeated context, `returned` is withheld
+from input and decoded as a supervised target, and `embed=True` asks prediction
+to emit embeddings at configured addresses.
+
+## Train With Lightning
+
+`jv.Model` is a LightningModule. `jv.PolarsDataModule` and
+`jv.StreamingDataModule` are LightningDataModule implementations. The schema
+defines the model tree, typed losses, prediction outputs, and embeddings;
+Lightning runs `fit`, `validate`, `test`, and `predict`.
+
+```python
+import lightning.pytorch as lit
+import polars as pl
+import torch
+
+import json2vec as jv
+
+records = pl.read_ndjson("docs/data/iris.jsonl").head(36).with_row_index()
+train_records = records.filter((pl.col("index") % 3) != 2).drop("index")
+validate_records = records.filter((pl.col("index") % 3) == 2).drop("index")
+
+model = jv.Model(
+    d_model=16,
+    n_layers=1,
+    n_heads=4,
+    batch_size=8,
+    embed=True,
+    optimizer=lambda module: torch.optim.AdamW(module.parameters(), lr=1e-2),
+    sepal_length=jv.Number,
+    petal_length=jv.Number,
+    species=jv.Category(target=True, size=3, topk=[2]),
+)
+
+datamodule = jv.PolarsDataModule(
+    model=model,
+    train=train_records,
+    validate=validate_records,
+    num_workers=0,
+    persistent_workers=False,
+    pin_memory=False,
+    observation_buffer_size=32,
+    sample_rate=1.0,
+)
+
+trainer = lit.Trainer(
+    accelerator="cpu",
+    max_epochs=1,
+    logger=False,
+    enable_progress_bar=False,
+    enable_model_summary=False,
+    enable_checkpointing=False,
+    limit_train_batches=1,
+    limit_val_batches=1,
+)
+
+trainer.fit(model=model, datamodule=datamodule)
+```
+
+This tiny deterministic split is only a wiring example. Use a representative,
+leakage-safe validation design before interpreting the metrics as model quality.
+
+For larger jobs, the same model can run through normal Lightning callbacks,
+checkpointing, precision settings, device placement, and distributed
+strategies. See
+[Training With Lightning](https://json2vec.github.io/json2vec/guides/lightning.html).
+
+## Predict And Embed
+
+For small interactive batches, call `model.predict(...)` with raw dictionaries.
+
+```python
+requests = validate_records.drop("species").head(3).to_dicts()
+predictions = model.predict(requests)
+
+species = predictions[jv.Address("record", "species")]
+record = predictions[jv.Address("record")]
+
+print(species["content"]["value"])
+print(species["content"]["probability"])
+print(record["embedding"])
+```
+
+For larger offline jobs, configure a `predict` split on a data module and attach
+`jv.Writer` to Lightning's prediction loop.
+
+```python
+writer = jv.Writer("predictions")
+
+trainer = lit.Trainer(
+    accelerator="cpu",
+    callbacks=[writer],
+    logger=False,
+)
+
+predict_datamodule = jv.PolarsDataModule(
+    model=model,
+    predict=validate_records.drop("species"),
+    num_workers=0,
+    persistent_workers=False,
+    pin_memory=False,
+)
+
+trainer.predict(
+    model=model,
+    datamodule=predict_datamodule,
+    return_predictions=False,
+)
+```
+
+`Writer` creates rank-partitioned Parquet files such as
+`predictions/rank-0.parquet`. Use a postprocessor when downstream systems need
+flat columns, renamed addresses, redacted payloads, or fewer fields. See
+[Batch Inference](https://json2vec.github.io/json2vec/guides/batch-inference.html)
+and [Postprocessors](https://json2vec.github.io/json2vec/guides/postprocessors.html).
+
+## Learning Modes
+
+`json2vec` does not maintain separate supervised and self-supervised code
+paths. Supervised learning is the special case where a target field is hidden
+from the input 100% of the time and decoded from the remaining context.
+
+| Setting | What the model sees | What prediction can emit |
+| --- | --- | --- |
+| plain input | value is visible | no decoded output unless otherwise configured |
+| `target=True` | value is hidden | decoded supervised output |
+| `p_mask` | sampled configured leaf positions are hidden in train, validation, and test | decoded reconstruction |
+| `p_prune` | whole leaf instances are hidden in train, validation, and test | decoded reconstruction |
+| `embed=True` | does not hide the value | embedding at that address |
+
+`target=True` is exact shorthand for `p_prune=1.0`. The current `p_mask`
+implementation samples configured positions, including null and padded
+positions, at rates lower than `1.0`; see
+[Dynamic Masking](https://json2vec.github.io/json2vec/core-concepts/dynamic-masking.html)
+for exact selection behavior. Use `embed=True` when you want a representation
+returned from prediction.
+
+## Data Modules
+
+Data modules load raw records, apply optional preprocessing, batch
+observations, tensorize values from the model schema, apply configured masking
+and target pruning in non-predict loops, and hand encoded batches to Lightning.
+
+Choose the data module by where the records live:
+
+| Use case | Module |
+| --- | --- |
+| Tutorials, tests, notebooks, in-memory Polars frames | `PolarsDataModule` |
+| Many local files | `StreamingDataModule` |
+| S3-backed datasets | `StreamingDataModule` |
+| Distributed training or prediction over large inputs | `StreamingDataModule` |
+
+`StreamingDataModule` supports local `ndjson`, `parquet`, `feather`, `csv`,
+`orc`, and `json` inputs. S3 roots use the PyArrow-backed formats—`parquet`,
+`feather`, `csv`, `orc`, and `json`; `ndjson` is local-only. Avro is not
+supported by the current reader. Split arguments are compiled regular
+expressions matched against discovered file paths.
+
+See [Data Modules](https://json2vec.github.io/json2vec/guides/data-modules.html)
+for split configuration, sharding, sampling, buffers, and preprocessors.
+
+## What Makes This Different
+
+- **Hierarchical context encoding:** child records interact locally before
+  their representation flows upward.
+- **Typed datatype architecture:** each built-in field owns validation,
+  tensorization, missing-state handling, masking, decoding, loss, metrics, and
+  output writing. The external registration surface is experimental and
+  same-process only in the current release.
+- **Unified training roles:** `target=True`, `p_prune`, and `p_mask` all use the
+  same reconstruction path.
+- **Embedding trees:** embeddings can come from the root, branches, or selected
+  leaves.
+- **Schema evolution:** fields can be added, removed, updated, reset, or
+  temporarily overridden after construction.
+- **Production missingness semantics:** `valued`, `null`, `padded`, `masked`,
+  and reserved `other` are distinct tensorfield states.
+- **Training-serving parity:** queries, preprocessors, tensorization, model
+  execution, prediction writing, and postprocessors stay on the same configured
+  path.
+
+## Where It Fits
+
+Use `json2vec` when relationships inside the record matter: account histories,
+fraud or risk snapshots, order and fulfillment events, flight itineraries,
+operations telemetry, user sessions, repeated measurements, or mixed datatype
+objects where flattening would discard useful structure.
+
+Use a simpler tabular model when flattening loses no meaningful context. The
+point is not to replace every table. The point is to model nested business data
+without making a feature table the only representation the model can see.
+
+## What It Does Not Do
+
+`json2vec` stops at the representation and typed prediction layer. It is not a
+feature store, governance system, rule engine, authorization layer,
+decision-capture system, or audit platform. Those systems can consume
+`json2vec` embeddings and predictions, but their policies and operational
+controls remain separate concerns.
+
+The open-source layer is the reusable encoder and runtime infrastructure. It
+does not require users to publish data, schemas, checkpoints, or model
+parameters.
+
+## Install
+
+JSON2Vec requires Python `>=3.12`. The currently documented user installation
+is directly from the GitHub repository:
+
+```bash
+python -m pip install "json2vec @ git+https://github.com/json2vec/json2vec.git"
+```
+
+This follows the repository's default branch. Pin a tag or commit in the Git
+URL for reproducible environments; the published documentation currently
+tracks `main` and does not retain versioned snapshots.
+
+Install optional functionality from the same source:
+
+```bash
+python -m pip install "json2vec[text] @ git+https://github.com/json2vec/json2vec.git"
+python -m pip install "json2vec[serving] @ git+https://github.com/json2vec/json2vec.git"
+```
+
+Verify the environment:
+
+```bash
+python -c "import importlib.metadata; import json2vec; print(importlib.metadata.version('json2vec'))"
+```
+
+For a contributor checkout, use the locked development environment instead:
+
+```bash
+uv sync
+```
+
+Contributor extras:
+
+```bash
+uv sync --extra text
+uv sync --extra serving
+uv sync --extra docs
+```
+
+The `text` extra installs Hugging Face `transformers`. The `serving` extra
+installs FastAPI-backed deployment dependencies. The `docs` extra installs the
+Python packages used by the Quarto docs.
+
+## Documentation Map
+
+Start with:
+
+- [Getting Started](https://json2vec.github.io/json2vec/getting-started.html)
+- [AI / Expert Quickstart](https://json2vec.github.io/json2vec/ai-quickstart.html)
+- [Model Tree](https://json2vec.github.io/json2vec/core-concepts/model-tree.html)
+- [Data Flow](https://json2vec.github.io/json2vec/core-concepts/data-flow.html)
+- [Binding Data](https://json2vec.github.io/json2vec/core-concepts/binding-data.html)
+- [Query Paths](https://json2vec.github.io/json2vec/core-concepts/querypaths.html)
+- [Built-In Data Types](https://json2vec.github.io/json2vec/core-concepts/data-types.html)
+- [Learning Modes & Embeddings](https://json2vec.github.io/json2vec/core-concepts/embeddings.html)
+- [Training With Lightning](https://json2vec.github.io/json2vec/guides/lightning.html)
+- [Data Modules](https://json2vec.github.io/json2vec/guides/data-modules.html)
+- [Evaluation And Metrics](https://json2vec.github.io/json2vec/guides/evaluation.html)
+- [Model Lifecycle](https://json2vec.github.io/json2vec/guides/model-lifecycle.html)
+- [Batch Inference](https://json2vec.github.io/json2vec/guides/batch-inference.html)
+- [Serving](https://json2vec.github.io/json2vec/guides/serving.html)
+
+Tutorials and guides:
+
+- [Postprocessors](https://json2vec.github.io/json2vec/guides/postprocessors.html)
+- [Field Importance](https://json2vec.github.io/json2vec/guides/field-importance.html)
+- [Field Stacking](https://json2vec.github.io/json2vec/guides/field-stacking.html)
+- [Model Configuration](https://json2vec.github.io/json2vec/guides/model-configuration.html)
+- [Performance And Scaling](https://json2vec.github.io/json2vec/guides/performance.html)
+- [Temporal Validation](https://json2vec.github.io/json2vec/guides/temporal-validation.html)
+- [Schema Mutation](https://json2vec.github.io/json2vec/guides/schema-mutation.html)
+- [Troubleshooting](https://json2vec.github.io/json2vec/guides/troubleshooting.html)
+- [Experimental Custom Tensorfields](https://json2vec.github.io/json2vec/guides/custom-tensorfields.html)
+- [Public API Map](https://json2vec.github.io/json2vec/reference/public-api.html)
+- [Branch](https://json2vec.github.io/json2vec/data-types/branch.html)
+- [Number](https://json2vec.github.io/json2vec/data-types/number.html)
+- [Boolean](https://json2vec.github.io/json2vec/data-types/boolean.html)
+- [Category](https://json2vec.github.io/json2vec/data-types/category.html)
+- [Set](https://json2vec.github.io/json2vec/data-types/set.html)
+- [Entity](https://json2vec.github.io/json2vec/data-types/entity.html)
+- [DateParts](https://json2vec.github.io/json2vec/data-types/dateparts.html)
+- [Vector](https://json2vec.github.io/json2vec/data-types/vector.html)
+- [Text](https://json2vec.github.io/json2vec/data-types/text.html)
+- [Reproducible Iris Case Study](https://json2vec.github.io/json2vec/case-studies/iris-reproducible.html)
+- [Device Tenure Case Study](https://json2vec.github.io/json2vec/case-studies/device-tenure.html)
+
+Build the docs locally with:
+
+```bash
+make render
+uv run pytest tests/examples/test_e2e_examples.py
+```
+
+## Repository Layout
+
+- `src/json2vec/architecture`: model assembly, attention, pooling, and routing
+- `src/json2vec/data`: dataset fetch/read/process/batch/encode pipeline and preprocessor exports
+- `src/json2vec/inference`: serving and prediction callbacks
+- `src/json2vec/logging`: runtime logging callbacks
+- `src/json2vec/structs`: pydantic config models, enums, and tree nodes
+- `src/json2vec/tensorfields`: tensorfield plugin system and built-in fields
+- `tests/`: package test suite
+- `docs/`: Quarto project, pages, guides, stylesheets, and sample data
+
+## Development
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+Run type and lint checks:
+
+```bash
+uv run ty check src/json2vec --output-format concise
+uv run ruff check
+```
+
+## Community
+
+Join the [`json2vec` Discord](https://discord.gg/DVyZUkvTFA) for questions,
+design discussion, and release notes.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See `LICENSE` and `NOTICE`.
+
+## References
+
+- `BIBLIOGRAPHY.md`
+- `CITATION.bib`