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 v1, the ForecastOutput schema mandates that every prediction be accompanied by a structured causal graph (logical_trace) and a calibrated confidence interval.

from xrtm.data import ForecastOutput, CausalNode

prediction = ForecastOutput(
    question_id="q_123",
    probability=0.75,
    reasoning="Base rate analysis suggests...",
    logical_trace=[
        CausalNode(event="Inflation rises", probability=0.8),
        CausalNode(event="Fed cuts rates", probability=0.4)
    ]
)

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/         # ForecastQuestion, ForecastOutput, 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.2.5.tar.gz (42.4 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.2.5-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xrtm_data-0.2.5.tar.gz
  • Upload date:
  • Size: 42.4 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.2.5.tar.gz
Algorithm Hash digest
SHA256 7b76953a62d69d3e3e02134eb64bc56664732f2887e06b0764dde9c572bf524f
MD5 b026cb38f067e295fa623343e10bc964
BLAKE2b-256 a3f678a17e65efe8bf37be61958f1a4751f04dd67493308e15434acc342743f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for xrtm_data-0.2.5.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.2.5-py3-none-any.whl.

File metadata

  • Download URL: xrtm_data-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 46.4 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.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3f0f05b1da62fcb5dc9bca38ba4c7dd2c696dd8cf7bf17aa960479bfb7c848be
MD5 2e8653065f693fa789b624ee36a5a326
BLAKE2b-256 90361d5f14a92ebddd665a5ffa6846e2429e55b017db603c85a823c5e20e19b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for xrtm_data-0.2.5-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