Skip to main content

The xRtm Framework (Generative Forecasting).

Project description

xRtm: The Generative Forecasting Framework

PyPI License

xRtm is an open-source framework for institutional-grade generative forecasting and agentic reasoning.

Installation

python3.11 -m venv .venv
. .venv/bin/activate
pip install xrtm==0.3.0

This installs the complete framework, including all components below.

Supported Python versions are >=3.11,<3.13. Python 3.13 is intentionally excluded until the dependency stack is validated there.


Product shell

The top-level xrtm command is the local-first product cockpit for the stack:

xrtm doctor
xrtm demo --provider mock --limit 2
xrtm profile create local-mock --provider mock --limit 2
xrtm run profile local-mock
xrtm runs list
xrtm runs show <run-id>
xrtm runs compare <run-id-a> <run-id-b>
xrtm runs export <run-id> --output export.json
xrtm perf run --scenario provider-free-smoke --iterations 3 --limit 1
xrtm artifacts inspect runs/<run-id>
xrtm report html runs/<run-id>
xrtm monitor start --provider mock --limit 2
xrtm monitor run-once runs/<run-id>
xrtm tui --runs-dir runs
xrtm web --runs-dir runs

The product shell writes canonical run directories under runs/:

runs/<run-id>/
  run.json
  questions.jsonl
  forecasts.jsonl
  eval.json
  train.json
  provider.json
  events.jsonl
  run_summary.json
  monitor.json
  report.html
  logs/

events.jsonl is a versioned event stream (xrtm.events.v1) and run_summary.json is a compact metrics contract for CLI/TUI/WebUI consumers.

Use --provider local-llm with a local OpenAI-compatible endpoint such as llama.cpp when you want a real local model path.

For installation, local LLM setup, artifact inspection, monitor lifecycle, and troubleshooting, see docs/operator-runbook.md.


Ecosystem

Component Badge Description
xrtm-forecast PyPI The Inference Engine
xrtm-data PyPI The Snapshot Vault
xrtm-eval PyPI The Judge
xrtm-train PyPI The Training Pipeline

Documentation

Full documentation is available at xrtm.org.


License

Apache 2.0 — see LICENSE for details.

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-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-0.3.0-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xrtm-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-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5035ef9a88637c02bc69845fe3f6bc607dffae010c2ee6c1715506ac61135173
MD5 eed0635aee962e672da77a6a973d746b
BLAKE2b-256 40e2a65b35f0023b70ea28c7bd128426dc2526c102f4187f836c3799e45e669c

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on xrtm-org/xrtm

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-0.3.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for xrtm-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e88ea0effc6a41ab0f3045bd05231b86f81da9219130c434b18a0418dc58b4e8
MD5 cb145e8d7d5d9af5614510373bb0bbe4
BLAKE2b-256 b5d5ead6d178f072dc347a1bb17ffbc042f7923fc224ac3ca9cd5625648ea831

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on xrtm-org/xrtm

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