Skip to main content

Core library for Retro Speedlab: A high-performance RL toolkit for classic games.

Project description

datenwissenschaften: Retro Speedlab Core 🚀

License: GPL v3 Python 3.12+

datenwissenschaften is the core engine powering Retro Speedlab, a high-performance Reinforcement Learning (RL) toolkit for classic video games. Built on top of stable-baselines3 and stable-retro, it provides the underlying infrastructure for training, monitoring, and recording RL agents.

⚠️ Important Note

This package is intended as the internal library for the Retro Speedlab project. For the full experience—including automated runners, training scripts, and comprehensive documentation—please use the main repository:

👉 https://github.com/datenwissenschaften/retro-speedlab

✨ Features

  • 🎮 Command Center: A rich terminal dashboard for real-time training metrics.
  • 🏋️ Orchestrated Training: Simplified RL workflows and session management.
  • ⚡ GPU acceleration: CUDA tuning for PPO plus batched GPU inference for NEAT, with CPU fallback.
  • 📊 Smart Callbacks: Automatic checkpointing and replay recording (.bk2).
  • 🛠️ Robust Infrastructure: Streamlined environment and ROM management.

🚀 Installation

pip install datenwissenschaften

Configuration

Copy config.example.yaml to config.yaml and adjust its values. Application settings are read from YAML rather than environment variables. APIs that load configuration also accept an explicit config_path when the file is stored elsewhere. Relative paths in the file are resolved relative to the configuration file.

Set training.num_envs to auto to select parallel environment workers from CPU affinity, population size, and the systemd/cgroup memory limit. An explicit positive integer continues to override automatic selection.

Set ui.enable: true to run the local Vue training dashboard at http://127.0.0.1:18080. It charts episode fitness and step counts, shows termination outcomes, and reports environment, PPO, and NEAT configuration details. The ui mapping accepts enable, host, port, and max_episodes values. Dashboard history is restored from and atomically persisted to models/<game>/<savestate>/history.json (relative to the configured models directory).

📜 License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.


Developed with ❤️ by datenwissenschaften.

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

datenwissenschaften-1.7.2.tar.gz (102.8 kB view details)

Uploaded Source

Built Distribution

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

datenwissenschaften-1.7.2-py3-none-any.whl (120.4 kB view details)

Uploaded Python 3

File details

Details for the file datenwissenschaften-1.7.2.tar.gz.

File metadata

  • Download URL: datenwissenschaften-1.7.2.tar.gz
  • Upload date:
  • Size: 102.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.13 Linux/6.17.0-1018-azure

File hashes

Hashes for datenwissenschaften-1.7.2.tar.gz
Algorithm Hash digest
SHA256 b6e9e96325fc24f9f3746871aceb8a5faf4d0b800c019829331669a9f3e369a4
MD5 0f6842ec104d0d989cca71a2da6ab7d0
BLAKE2b-256 42dbf20c2e87585a1468f60a7af344ab99b1c735436c32ed6cd3c1072da01e79

See more details on using hashes here.

File details

Details for the file datenwissenschaften-1.7.2-py3-none-any.whl.

File metadata

  • Download URL: datenwissenschaften-1.7.2-py3-none-any.whl
  • Upload date:
  • Size: 120.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.13 Linux/6.17.0-1018-azure

File hashes

Hashes for datenwissenschaften-1.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 72a8e8b79beba93c87f57eb18a951f09c917830f3eb6d7b24cd2564c0294f890
MD5 3fdfdbbb8111925520dc47523079239e
BLAKE2b-256 46459e0db34f554c949f0dfd8b3a2090e2f5b3e8b911cabd1ec04f5eccf35638

See more details on using hashes here.

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