Skip to main content

The Snapshot Vault for XRTM.

Project description

xrtm-data

License Python PyPI

The Snapshot Vault for XRTM.

xrtm-data provides the rigid schemas and temporal sandboxing infrastructure required for zero-leakage forecasting. It defines the "Ground Truth" data structures that the rest of the ecosystem (Forecast, Eval, Train) relies on.

Part of the XRTM Ecosystem

Layer 4: xrtm-train    → (imports all)
Layer 3: xrtm-forecast → (imports eval, data)
Layer 2: xrtm-eval     → (imports data)
Layer 1: xrtm-data     → (zero dependencies) ← YOU ARE HERE

xrtm-data is the foundation layer with zero dependencies on other xrtm packages.

Installation

pip install xrtm-data

Core Primitives

1. The Forecast Object Standard

Adhering to strict Governance, the canonical runtime schema is ForecastResult (legacy alias: ForecastOutput). Every forecast result carries forecast_request_id, probability, a reasoning_trace, and an optional execution_trace. Legacy question_id, reasoning, logical_trace, logical_edges, and structural_trace inputs remain accepted for compatibility.

from xrtm.data import ForecastResult, CausalNode

forecast_result = ForecastResult(
    forecast_request_id="q_123",
    probability=0.75,
    reasoning_trace={
        "narrative": "Base rate analysis suggests...",
        "causal_graph": {
            "nodes": [
                CausalNode(event="Inflation rises", probability=0.8),
                CausalNode(event="Fed cuts rates", probability=0.4),
            ]
        },
    },
    execution_trace=["ingestion", "forecast"],
)

2. Zero Leakage

The MetadataBase enforces a strict snapshot_time. This timestamp represents the "End of History" for the model. Any data point generated after this time is considered "Future Leakage" and is programmatically inaccessible during backtesting.

Project Structure

src/xrtm/data/
├── core/            # Interfaces & Schemas (domain-agnostic)
│   ├── interfaces.py    # DataSource protocol
│   └── schemas/         # ForecastRequest, ForecastResult, etc.
├── kit/             # Composable utilities (processors)
└── providers/       # External data source implementations
    ├── local/           # LocalDataSource (JSON files)
    └── online/          # PolymarketSource (Gamma API)

Development

Prerequisites:

# Install dependencies
uv sync

# Run tests
uv run pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xrtm_data-0.3.0.tar.gz (34.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xrtm_data-0.3.0-py3-none-any.whl (39.5 kB view details)

Uploaded Python 3

File details

Details for the file xrtm_data-0.3.0.tar.gz.

File metadata

  • Download URL: xrtm_data-0.3.0.tar.gz
  • Upload date:
  • Size: 34.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xrtm_data-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6c48b396792f49f51353ee61a341b9d08289fef2d2538b4fd2a24a4561990124
MD5 31c4abbca860b61d6b727045a5415619
BLAKE2b-256 d9aceafebeae95ca61612ff115f2ff493dba1a9de2f6ff4822f05d000b2a233e

See more details on using hashes here.

Provenance

The following attestation bundles were made for xrtm_data-0.3.0.tar.gz:

Publisher: publish.yml on xrtm-org/data

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xrtm_data-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: xrtm_data-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 39.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xrtm_data-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 364eddaaac22f96e6a18acca6656656f05cba68691e1fb91f298eda11c72bb59
MD5 860cf0d76d36277b4dea8d1a7083b468
BLAKE2b-256 74380cdd5e41021808029661ae3d913fc33c6762d1b3d2f6add860f82569161b

See more details on using hashes here.

Provenance

The following attestation bundles were made for xrtm_data-0.3.0-py3-none-any.whl:

Publisher: publish.yml on xrtm-org/data

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page