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 to run the local Vue training dashboard at http://127.0.0.1:8765. It charts episode fitness and step counts, shows termination outcomes, and reports environment, PPO, and NEAT configuration details. Advanced configuration can set ui to a mapping with enabled, 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.0.tar.gz (95.7 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.0-py3-none-any.whl (113.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: datenwissenschaften-1.7.0.tar.gz
  • Upload date:
  • Size: 95.7 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.0.tar.gz
Algorithm Hash digest
SHA256 0d2eb728e66a020cd8d13c4d9d236724f3683c3ded93a6ac34e687eaa6f08816
MD5 83e9f417be797c997c9d6fefbf69a5f6
BLAKE2b-256 b5a693904ca7a9fa70d7186853dd673aa7146daf5789fa2131167dc933446ecc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: datenwissenschaften-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 113.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db34831f56759a832a56d5cb710b143c4997e041a8fed6c36c2eef01046a9c70
MD5 9d8f36ca1c95395de6b77b4077cf0c12
BLAKE2b-256 6822018913a03604557808622af5d2e9a22a3c79ba4f33fdf49d5708026c9c55

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