omnirl-framework 0.1.0__tar.gz

omnirl_framework-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

omnirl_framework-0.1.0/PKG-INFO

@@ -0,0 +1,371 @@
+Metadata-Version: 2.4
+Name: omnirl-framework
+Version: 0.1.0
+Summary: A distributed reinforcement learning framework.
+Author-email: Huang Chenbiao <a1057951125@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/MBer123/omnirl
+Project-URL: Repository, https://github.com/MBer123/omnirl
+Project-URL: Issues, https://github.com/MBer123/omnirl/issues
+Keywords: reinforcement-learning,distributed-computing,ray,pytorch
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.6,>=2.2
+Requires-Dist: PyYAML<7,>=6.0
+Requires-Dist: ray<2.57,>=2.54
+Requires-Dist: torch<2.14,>=2.10
+Dynamic: license-file
+
+# OmniRL
+
+English | [简体中文](README.zh-CN.md)
+
+OmniRL is a distributed reinforcement learning framework built on Python, Ray, and PyTorch. It provides a common runtime for asynchronous sampling, replay and rollout storage, distributed learning, versioned weight synchronization, evaluation, logging, and checkpoint recovery. The framework includes 13 value-based and actor-critic algorithms for discrete and continuous control.
+
+## Architecture
+
+```text
+Environment Collection ──► Samplers ──► Memory ──► Learners ──► WeightStore
+                               ▲                                     │
+                               └───────── Algorithm Policy ◄─────────┘
+
+Environment Evaluation ◄── Evaluators ◄── Algorithm Policy ◄── WeightStore
+```
+
+- `omnirl.runtime` orchestrates Ray actors for sampling, learning, evaluation, and versioned weight synchronization.
+- `omnirl.buffers` provides rollout, replay, and prioritized replay storage.
+- `omnirl.algorithms` contains algorithm-specific learners and inference policies.
+- `omnirl.networks` contains reusable network architectures for value-based and actor-critic algorithms.
+- `omnirl.envs` owns environment construction, specifications, collection and evaluation loops, and metric aggregation.
+
+Every algorithm package exposes the same `Learner`, `Policy`, and `Memory` interface. The runtime connects these components to the selected environment backend, keeping algorithm and environment implementations independent.
+
+## Implemented Algorithms
+
+| Algorithm | Family | Action space |
+| --- | --- | --- |
+| ✅ [Deep Q-Network (DQN)](https://arxiv.org/abs/1312.5602) | Value-based, off-policy | Discrete |
+| ✅ [Double Deep Q-Network (DDQN)](https://arxiv.org/abs/1509.06461) | Value-based, off-policy | Discrete |
+| ✅ [Dueling Double Deep Q-Network (Dueling DQN)](https://arxiv.org/abs/1511.06581) | Value-based, off-policy | Discrete |
+| ✅ [Prioritized Experience Replay Deep Q-Network (PER-DQN)](https://arxiv.org/abs/1511.05952) | Value-based, off-policy | Discrete |
+| ✅ [Categorical 51-Atom Deep Q-Network (C51)](https://arxiv.org/abs/1707.06887) | Distributional value-based, off-policy | Discrete |
+| ✅ [Quantile Regression Deep Q-Network (QR-DQN)](https://arxiv.org/abs/1710.10044) | Distributional value-based, off-policy | Discrete |
+| ✅ [Advantage Actor-Critic (A2C)](https://arxiv.org/abs/1602.01783) | Actor-critic, on-policy | Discrete / Continuous |
+| ✅ [Proximal Policy Optimization (PPO)](https://arxiv.org/abs/1707.06347) | Actor-critic, on-policy | Discrete / Continuous |
+| ✅ [Importance Weighted Actor-Learner Architectures (IMPALA)](https://arxiv.org/abs/1802.01561) | Actor-critic, off-policy | Discrete / Continuous |
+| ✅ [Deep Deterministic Policy Gradient (DDPG)](https://arxiv.org/abs/1509.02971) | Actor-critic, off-policy | Continuous |
+| ✅ [Twin Delayed Deep Deterministic Policy Gradient (TD3)](https://arxiv.org/abs/1802.09477) | Actor-critic, off-policy | Continuous |
+| ✅ [Soft Actor-Critic (SAC)](https://arxiv.org/abs/1801.01290) | Actor-critic, off-policy | Discrete / Continuous |
+| ✅ [Truncated Quantile Critics (TQC)](https://arxiv.org/abs/2005.04269) | Distributional actor-critic, off-policy | Continuous |
+
+## Installation
+
+OmniRL supports Python 3.10–3.12. Create a virtual environment:
+
+```bash
+python -m venv .venv
+```
+
+Activate it on Windows:
+
+```powershell
+.\.venv\Scripts\Activate.ps1
+```
+
+On Linux and macOS:
+
+```bash
+source .venv/bin/activate
+```
+
+Install OmniRL and its shared dependencies:
+
+```bash
+python -m pip install --upgrade pip
+pip install -e .
+```
+
+Install the required environment backend:
+
+```bash
+# Gymnasium
+pip install -r requirements/gymnasium.txt
+
+# RLCard
+pip install -r requirements/rlcard.txt
+
+# SUMO
+pip install -r requirements/sumo.txt
+
+# ViZDoom
+pip install -r requirements/vizdoom.txt
+```
+
+Each backend requirements file includes `base.txt` and can be installed directly in a fresh environment.
+
+For GPU training, install the PyTorch build that matches the operating system and CUDA runtime, then verify CUDA availability:
+
+```bash
+python -c "import torch; print(torch.cuda.is_available())"
+```
+
+## Getting Started
+
+An OmniRL run uses two YAML files:
+
+- The runner configuration defines the environment, Ray worker counts, device, seed, checkpoints, and logging.
+- The agent configuration defines the algorithm module and its learner, memory, policy, and network parameters.
+
+Start a single-machine PPO run on `LunarLander-v3`:
+
+```bash
+python run.py --mode train --runner-config experiments/algorithm_validation/lunar_lander/ppo-0/train.yaml --agent-config experiments/algorithm_validation/lunar_lander/ppo-0/ppo.yaml
+```
+
+`run.py` connects to an existing Ray cluster when available; otherwise, it starts a local Ray runtime. For multi-node execution, start the head node:
+
+```bash
+ray start --head --port=6379
+```
+
+Join each worker, then launch `run.py` from the head node:
+
+```bash
+ray start --address=<head-ip>:6379
+```
+
+When `runner.load_checkpoint` is `true`, restarting the same training command resumes from `checkpoint.ckpt` in `runner.ckpt_dir`.
+
+### Outputs
+
+Each run writes the following artifacts to `runner.ckpt_dir`:
+
+- `checkpoint.ckpt`: complete learner and optimizer state for resuming training.
+- `agent_<version>.pth`: exported policy weights.
+- `log.csv`: runtime, evaluation, and learner metrics.
+- `run_config.yaml`: merged runner and algorithm configuration used by the run.
+
+## Evaluation
+
+Set `runner.ckpt_dir` and `runner.eval_model` in the matching `test.yaml`, then run:
+
+```bash
+python run.py --mode test --runner-config experiments/algorithm_validation/lunar_lander/ppo-0/test.yaml --agent-config experiments/algorithm_validation/lunar_lander/ppo-0/ppo.yaml
+```
+
+The selected environment backend defines the evaluation metrics. The total number of evaluated episodes is `runner.num_evaluators * runner.num_episodes`.
+
+When a backend supports interactive rendering, set `env.render_mode` to `human` and `runner.num_evaluators` to `1` in the test configuration.
+
+## Adding an Algorithm
+
+Create a package under `omnirl/algorithms/<name>/` that exports the shared runtime interface:
+
+```python
+from .learner import Learner
+from .policy import Policy
+from omnirl.buffers import ReplayBuffer as Memory
+
+__all__ = ["Learner", "Memory", "Policy"]
+```
+
+The implementation should provide:
+
+- `Learner`: a Ray actor that implements learning, checkpointing, and versioned weight access. Existing learners can be used as interface examples.
+- `Policy`: a local inference class with deterministic `choose_action` and exploratory `sample_action` methods.
+- `Memory`: one of the buffers in `omnirl.buffers`, or a compatible new Ray actor.
+- Network definitions under `omnirl.networks` when the algorithm needs a new architecture.
+- An agent YAML whose `agent.module` points to `omnirl.algorithms.<name>` and whose `modules` section supplies the constructor parameters.
+
+The environment backend and distributed runtime do not need to be changed. Add module-interface and learner-update tests before adding the algorithm to the table above.
+
+## Adding an Environment Backend
+
+Create a package under `omnirl/envs/<name>/` that exports:
+
+```python
+EnvAdapter
+build_env
+get_env_spec
+CollectionLoop
+EvaluationLoop
+aggregate_evaluations
+```
+
+`get_env_spec` describes observation shape and dtype, action dimensions and bounds, and default evaluation metrics. `CollectionLoop` turns policy decisions into rollout data, while `EvaluationLoop` and `aggregate_evaluations` produce environment-specific metrics.
+
+Set the backend module in a runner configuration:
+
+```yaml
+env:
+  module: omnirl.envs.gymnasium
+  id: CartPole-v1
+  render_mode: null
+```
+
+`module` selects the backend; the remaining `env` mapping is passed through unchanged.
+
+Algorithms and runtime actors communicate only through this interface, so neither needs backend-specific imports or configuration fields.
+
+## Experiments
+
+The `experiments` directory contains four reproducible suites:
+
+| Suite | Purpose | Runs |
+| --- | --- | ---: |
+| Algorithm validation | Compare all 13 implemented algorithms across discrete and continuous control tasks. | 48 |
+| Sampler scaling | Compare 1, 2, 4, and 8 asynchronous samplers for IMPALA over three seeds. | 12 |
+| Evaluator scaling | Compare 1, 2, 4, and 8 evaluator actors on a fixed SUMO workload over three seeds. | 12 |
+| Environment integration | Validate three non-Gymnasium environment protocols with PPO. | 9 |
+| **Total** |  | **81** |
+
+Training runs use isolated directories under `results/` and enable checkpoint recovery.
+
+### Algorithm validation
+
+Every environment/algorithm combination uses seeds 0, 1, and 2:
+
+| Environment | Algorithms | Seeds |
+| --- | --- | --- |
+| `LunarLander-v3` | A2C, C51, DDQN, DQN, Dueling DQN, IMPALA, PER-DQN, PPO, QR-DQN | 0, 1, 2 |
+| `BipedalWalker-v3` | A2C, DDPG, IMPALA, PPO, SAC, TD3, TQC | 0, 1, 2 |
+
+Rollout-based algorithms use 10 samplers and train for 24,415 updates. Replay-based algorithms use one sampler and a replay ratio of 1; LunarLander runs use a batch size of 128, while BipedalWalker runs use a batch size of 256, and both train for 250,000 updates. Each evaluation aggregates 50 episodes from two evaluator workers.
+
+Train and evaluate one run:
+
+```bash
+python run.py --mode train --runner-config experiments/algorithm_validation/bipedal_walker/ppo-0/train.yaml --agent-config experiments/algorithm_validation/bipedal_walker/ppo-0/ppo.yaml
+python run.py --mode test --runner-config experiments/algorithm_validation/bipedal_walker/ppo-0/test.yaml --agent-config experiments/algorithm_validation/bipedal_walker/ppo-0/ppo.yaml
+```
+
+Checkpoints, logs, and merged run configurations are written under `results/algorithm_validation/<environment>/<algorithm>-<seed>`.
+
+<p align="center">
+  <img src="docs/images/lunar-lander-on-policy.png" alt="LunarLander-v3 on-policy algorithm validation" width="32%">
+  <img src="docs/images/lunar-lander-off-policy-1.png" alt="LunarLander-v3 off-policy-1 algorithm validation" width="32%">
+  <img src="docs/images/lunar-lander-off-policy-2.png" alt="LunarLander-v3 off-policy-2 algorithm validation" width="32%">
+</p>
+
+<p align="center"><em>LunarLander-v3: on-policy (left), off-policy-1 (center), and off-policy-2 (right) algorithm validation.</em></p>
+
+<p align="center">
+  <img src="docs/images/bipedal-walker-on-policy.png" alt="BipedalWalker-v3 on-policy algorithm validation" width="32%">
+  <img src="docs/images/bipedal-walker-off-policy.png" alt="BipedalWalker-v3 off-policy algorithm validation" width="32%">
+</p>
+
+<p align="center"><em>BipedalWalker-v3: on-policy (left) and off-policy (right) algorithm validation.</em></p>
+
+### Sampler scaling
+
+This suite varies only the number of asynchronous IMPALA samplers. The training batch, learner count, environment, and total sample count remain fixed. IMPALA uses V-trace to correct for policy lag between samplers and the learner.
+
+| Setting | Value |
+| --- | --- |
+| Algorithm | IMPALA |
+| Environment | `LunarLander-v3` |
+| Learners | 1 GPU learner |
+| Samplers | 1, 2, 4, 8 |
+| Seeds | 0, 1, 2 |
+| Samples per run | 5,120,000 |
+| Evaluation | 25 episodes |
+
+Run the `impala-s<samplers>-<seed>` configurations sequentially to avoid resource contention:
+
+```bash
+python run.py --mode train --runner-config experiments/sampler_scaling/lunar_lander/impala-s1-0/train.yaml --agent-config experiments/sampler_scaling/lunar_lander/impala-s1-0/impala.yaml
+```
+
+The figures report the three-seed mean and standard deviation of wall-clock time, speedup relative to one sampler, and return versus wall-clock time.
+
+<p align="center">
+  <img src="docs/images/impala-sampler-runtime.png" alt="IMPALA sampler runtime on LunarLander-v3" width="32%">
+  <img src="docs/images/impala-sampler-speedup.png" alt="IMPALA sampler speedup on LunarLander-v3" width="32%">
+  <img src="docs/images/impala-return-time.png" alt="IMPALA return versus wall-clock time on LunarLander-v3" width="32%">
+</p>
+
+<p align="center"><em>IMPALA wall-clock time (left), speedup relative to one sampler (center), and return versus wall-clock time (right).</em></p>
+
+### Evaluator scaling
+
+This suite varies only the number of evaluator actors while keeping the algorithm, trained checkpoint, environment, and total evaluation workload fixed.
+
+| Setting | Value |
+| --- | --- |
+| Algorithm | PPO |
+| Environment | SUMO single intersection |
+| Checkpoints | `agent_500.pth` from the matching environment-integration seed |
+| Evaluators | 1, 2, 4, 8 |
+| Seeds | 0, 1, 2 |
+| Episodes per run | 40 |
+| Episodes per evaluator | 40, 20, 10, 5 respectively |
+
+Run the `ppo-e<evaluators>-<seed>` configurations sequentially:
+
+```bash
+python run.py --mode test --runner-config experiments/evaluator_scaling/sumo/single_intersection/ppo-e1-0/test.yaml --agent-config experiments/evaluator_scaling/sumo/single_intersection/ppo-e1-0/ppo.yaml
+```
+
+The configurations reuse the trained checkpoints under `results/environment_integration/sumo/single_intersection/ppo-<seed>`. The figures report the three-seed mean and standard deviation of wall-clock time and speedup relative to one evaluator.
+
+<p align="center">
+  <img src="docs/images/ppo-evaluator-runtime.png" alt="PPO evaluator runtime on SUMO" width="32%">
+  <img src="docs/images/ppo-evaluator-speedup.png" alt="PPO evaluator speedup on SUMO" width="32%">
+</p>
+
+<p align="center"><em>SUMO evaluation wall-clock time (left) and paired speedup relative to one evaluator (right).</em></p>
+
+### Environment integration
+
+Environment backends encapsulate native interaction protocols, episode lifecycle, seeding, rendering, and domain-specific metrics. The runtime and algorithms depend only on the shared environment specification, collection loop, and evaluation interface, allowing the same PPO implementation to run unchanged across all three benchmarks.
+
+| Backend | Benchmark | Backend-owned integration | Evaluation metrics | Samples per seed |
+| --- | --- | --- | --- | ---: |
+| `omnirl.envs.sumo` | SUMO single intersection | SUMO-RL/TraCI lifecycle, traffic-signal observations and fixed-horizon trip data | Delay, trip time, waiting time, queue length | 1,024,000 |
+| `omnirl.envs.vizdoom` | ViZDoom Defend the Center | RGB frames, game tics and discrete button combinations | Kills, survival time, shots, shooting precision | 2,048,000 |
+| `omnirl.envs.rlcard` | RLCard Blackjack | Active-player state, legal actions and terminal payoff | Win, draw and loss rates | 1,024,000 |
+
+All three benchmarks use PPO with seeds 0, 1, and 2. Each backend reports domain-specific metrics rather than a mandatory generic `return_mean`.
+
+Configurations are under `experiments/environment_integration/<backend>/<task>/ppo-<seed>`. Each run writes checkpoints, the merged configuration, and a `log.csv` containing runtime statistics and backend metrics under `results/environment_integration`.
+
+The final training-time evaluations provide a compact snapshot of the recorded results:
+
+| Benchmark | Training signal shown | Final value across three seeds |
+| --- | --- | ---: |
+| SUMO single intersection | Average waiting time (lower is better) | 39.45 ± 1.13 s |
+| ViZDoom Defend the Center | Average kills per episode (higher is better) | 14.15 ± 1.34 |
+| RLCard Blackjack | Win rate (higher is better) | 42.54% ± 0.21 pp |
+
+Values are the mean ± sample standard deviation of the final logged evaluation for seeds 0, 1, and 2. In each plot, the solid line is the mean and the shaded region is one standard deviation.
+
+<p align="center">
+  <img src="docs/images/sumo.png" alt="PPO training on the SUMO single-intersection environment" width="32%">
+  <img src="docs/images/vizdoom.png" alt="PPO training on the ViZDoom Defend the Center environment" width="32%">
+  <img src="docs/images/rlcard.png" alt="PPO training on the RLCard Blackjack environment" width="32%">
+</p>
+
+<p align="center"><em>SUMO average waiting time (left), ViZDoom average kills (center), and RLCard win rate (right).</em></p>
+
+## Notes
+
+- When training on CPU, set `device.learner` to `cpu` and keep `runner.num_learners` at `1`.
+- Size `runner.num_samplers`, `runner.num_evaluators`, and `runner.num_learners` for the available hardware. As a starting point, keep their sum below 90% of the available CPU threads.
+- Run the test suite with `python -m unittest discover -s tests -v`.
+- OmniRL is a research framework. Multi-seed correctness reports and scaling results should be treated as experimental evidence rather than production guarantees.
+
+## License
+
+Copyright 2026 Huang Chenbiao (MBer123).
+
+OmniRL is licensed under the [Apache License 2.0](LICENSE).