# OpenEnv: Production RL Made Simple
PyTorch ## From "Hello World" to RL Training in 5 Minutes ✨ **What if RL environments were as easy to use as REST APIs?** That's OpenEnv. Type-safe. Isolated. Production-ready. šŸŽÆ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/OpenEnv_Tutorial.ipynb) [![GitHub](https://img.shields.io/badge/GitHub-meta--pytorch%2FOpenEnv-blue?logo=github)](https://github.com/meta-pytorch/OpenEnv) [![License](https://img.shields.io/badge/License-BSD%203--Clause-green.svg)](https://opensource.org/licenses/BSD-3-Clause) [![PyTorch](https://img.shields.io/badge/PyTorch-EE4C2C?logo=pytorch&logoColor=white)](https://pytorch.org/) Author: [Sanyam Bhutani](http://twitter.com/bhutanisanyam1/)
## Why OpenEnv? Let's take a trip down memory lane: It's 2016, RL is popular. You read some papers, it looks promising. But in real world: Cartpole is the best you can run on a gaming GPU. What do you do beyond Cartpole? Fast-forward to 2025, GRPO is awesome and this time it's not JUST in theory, it works well in practise and is really here! The problem still remains, how do you take these RL algorithms and take them beyond Cartpole? A huge part of RL is giving your algorithms environment access to learn. We are excited to introduce an Environment Spec for adding Open Environments for RL Training. This will allow you to focus on your experiments and allow everyone to bring their environments. Focus on experiments, use OpenEnvironments, and build agents that go beyond Cartpole on a single spec. --- ## šŸ“‹ What You'll Learn
**šŸŽÆ Part 1-2: The Fundamentals** - ⚔ RL in 60 seconds - šŸ¤” Why existing solutions fall short - šŸ’” The OpenEnv solution **šŸ—ļø Part 3-5: The Architecture** - šŸ”§ How OpenEnv works - šŸ” Exploring real code - šŸŽ® OpenSpiel integration example
**šŸŽ® Part 6-8: Hands-On Demo** - šŸ”Œ Use existing OpenSpiel environment - šŸ¤– Test 4 different policies - šŸ‘€ Watch learning happen live **šŸ”§ Part 9-10: Going Further** - šŸŽ® Switch to other OpenSpiel games - ✨ Build your own integration - 🌐 Deploy to production
!!! tip "Pro Tip" This notebook is designed to run top-to-bottom in Google Colab with zero setup! ā±ļø **Time**: ~5 minutes | šŸ“Š **Difficulty**: Beginner-friendly | šŸŽÆ **Outcome**: Production-ready RL knowledge --- ## šŸ“‘ Table of Contents ### Foundation - [Part 1: RL in 60 Seconds ā±ļø](#part-1-rl-in-60-seconds) - [Part 2: The Problem with Traditional RL 😤](#part-2-the-problem-with-traditional-rl) - [Part 3: Setup šŸ› ļø](#part-3-setup) ### Architecture - [Part 4: The OpenEnv Pattern šŸ—ļø](#part-4-the-openenv-pattern) - [Part 5: Example Integration - OpenSpiel šŸŽ®](#part-5-example-integration---openspiel) ### Hands-On Demo - [Part 6: Interactive Demo šŸŽ®](#part-6-using-real-openspiel) - [Part 7: Four Policies šŸ¤–](#part-7-four-policies) - [Part 8: Policy Competition! šŸ†](#part-8-policy-competition) ### Advanced - [Part 9: Using Real OpenSpiel šŸŽ®](#part-9-switching-to-other-games) - [Part 10: Create Your Own Integration šŸ› ļø](#part-10-create-your-own-integration) ### Wrap Up - [Summary: Your Journey šŸŽ“](#summary-your-journey) - [Resources šŸ“š](#resources) --- (part-1-rl-in-60-seconds)= ## Part 1: RL in 60 Seconds ā±ļø **Reinforcement Learning is simpler than you think.** It's just a loop: ```python while not done: observation = environment.observe() action = policy.choose(observation) reward = environment.step(action) policy.learn(reward) ``` That's it. That's RL. Let's see it in action: ```python import random print("šŸŽ² " + "="*58 + " šŸŽ²") print(" Number Guessing Game - The Simplest RL Example") print("šŸŽ² " + "="*58 + " šŸŽ²") # Environment setup target = random.randint(1, 10) guesses_left = 3 print(f"\nšŸŽÆ I'm thinking of a number between 1 and 10...") print(f"šŸ’­ You have {guesses_left} guesses. Let's see how random guessing works!\n") # The RL Loop - Pure random policy (no learning!) while guesses_left > 0: # Policy: Random guessing (no learning yet!) guess = random.randint(1, 10) guesses_left -= 1 print(f"šŸ’­ Guess #{3-guesses_left}: {guess}", end=" → ") # Reward signal (but we're not using it!) if guess == target: print("šŸŽ‰ Correct! +10 points") break elif abs(guess - target) <= 2: print("šŸ”„ Warm! (close)") else: print("ā„ļø Cold! (far)") else: print(f"\nšŸ’” Out of guesses. The number was {target}.") print("\n" + "="*62) print("šŸ’” This is RL: Observe → Act → Reward → Repeat") print(" But this policy is terrible! It doesn't learn from rewards.") print("="*62 + "\n") ``` **Output:** ``` šŸŽ² ========================================================== šŸŽ² Number Guessing Game - The Simplest RL Example šŸŽ² ========================================================== šŸŽ² šŸŽÆ I'm thinking of a number between 1 and 10... šŸ’­ You have 3 guesses. Let's see how random guessing works! šŸ’­ Guess #1: 2 → ā„ļø Cold! (far) šŸ’­ Guess #2: 10 → šŸŽ‰ Correct! +10 points ============================================================== šŸ’” This is RL: Observe → Act → Reward → Repeat But this policy is terrible! It doesn't learn from rewards. ============================================================== ``` --- (part-2-the-problem-with-traditional-rl)= ## Part 2: The Problem with Traditional RL 😤 ### šŸ¤” Why Can't We Just Use OpenAI Gym? Good question! Gym is great for research, but production needs more... | Challenge | Traditional Approach | OpenEnv Solution | |-----------|---------------------|------------------| | **Type Safety** | āŒ `obs[0][3]` - what is this? | āœ… `obs.info_state` - IDE knows! | | **Isolation** | āŒ Same process (can crash your training) | āœ… Docker containers (fully isolated) | | **Deployment** | āŒ "Works on my machine" 🤷 | āœ… Same container everywhere 🐳 | | **Scaling** | āŒ Hard to distribute | āœ… Deploy to Kubernetes ā˜øļø | | **Language** | āŒ Python only | āœ… Any language (HTTP API) 🌐 | | **Debugging** | āŒ Cryptic numpy errors | āœ… Clear type errors šŸ› | ### šŸ’” The OpenEnv Philosophy **"RL environments should be like microservices"** Think of it like this: You don't run your database in the same process as your web server, right? Same principle! - šŸ”’ **Isolated**: Run in containers (security + stability) - 🌐 **Standard**: HTTP API, works everywhere - šŸ“¦ **Versioned**: Docker images (reproducibility!) - šŸš€ **Scalable**: Deploy to cloud with one command - šŸ›”ļø **Type-safe**: Catch bugs before they happen - šŸ”„ **Portable**: Works on Mac, Linux, Windows, Cloud ### The Architecture ``` ā”Œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā” │ YOUR TRAINING CODE │ │ │ │ env = OpenSpielEnv(...) ← Import the client │ │ result = env.reset() ← Type-safe! │ │ result = env.step(action) ← Type-safe! │ │ │ ā””ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”¬ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”˜ │ │ HTTP/JSON (Language-Agnostic) │ POST /reset, POST /step, GET /state │ ā”Œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā–¼ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā” │ DOCKER CONTAINER │ │ │ │ ā”Œā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā” │ │ │ FastAPI Server │ │ │ │ └─ Environment (reset, step, state) │ │ │ │ └─ Your Game/Simulation Logic │ │ │ ā””ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”˜ │ │ │ │ Isolated • Reproducible • Secure │ ā””ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”€ā”˜ ``` !!! info "Key Insight" You never see HTTP details - just clean Python methods! ```python env.reset() # Under the hood: HTTP POST to /reset env.step(...) # Under the hood: HTTP POST to /step env.state() # Under the hood: HTTP GET to /state ``` The magic? OpenEnv handles all the plumbing. You focus on RL! ✨ --- (part-3-setup)= ## Part 3: Setup šŸ› ļø **Running in Colab?** This cell will clone OpenEnv and install dependencies automatically. **Running locally?** Make sure you're in the OpenEnv directory. ```ipython3 # Detect environment try: import google.colab IN_COLAB = True print("🌐 Running in Google Colab - Perfect!") except ImportError: IN_COLAB = False print("šŸ’» Running locally - Nice!") if IN_COLAB: print("\nšŸ“¦ Cloning OpenEnv repository...") !git clone https://github.com/meta-pytorch/OpenEnv.git > /dev/null 2>&1 %cd OpenEnv print("šŸ“š Installing dependencies (this takes ~10 seconds)...") !pip install -q fastapi uvicorn requests import sys sys.path.insert(0, './src') print("\nāœ… Setup complete! Everything is ready to go! šŸŽ‰") else: import sys from pathlib import Path sys.path.insert(0, str(Path.cwd().parent / 'src')) print("āœ… Using local OpenEnv installation") print("\nšŸš€ Ready to explore OpenEnv and build amazing things!") print("šŸ’” Tip: Run cells top-to-bottom for the best experience.\n") ``` **Output:** ``` šŸ’» Running locally - Nice! āœ… Using local OpenEnv installation šŸš€ Ready to explore OpenEnv and build amazing things! šŸ’” Tip: Run cells top-to-bottom for the best experience. ``` --- (part-4-the-openenv-pattern)= ## Part 4: The OpenEnv Pattern šŸ—ļø ### Every OpenEnv Environment Has 3 Components: ``` src/envs/your_env/ ā”œā”€ā”€ šŸ“ models.py ← Type-safe contracts │ (Action, Observation, State) │ ā”œā”€ā”€ šŸ“± client.py ← What YOU import │ (HTTPEnvClient implementation) │ └── šŸ–„ļø server/ ā”œā”€ā”€ environment.py ← Game/simulation logic ā”œā”€ā”€ app.py ← FastAPI server └── Dockerfile ← Container definition ``` Let's explore the actual OpenEnv code to see how this works: ```python # Import OpenEnv's core abstractions from core.env_server import Environment, Action, Observation, State from core.http_env_client import HTTPEnvClient print("="*70) print(" 🧩 OPENENV CORE ABSTRACTIONS") print("="*70) print(""" šŸ–„ļø SERVER SIDE (runs in Docker): class Environment(ABC): '''Base class for all environment implementations''' @abstractmethod def reset(self) -> Observation: '''Start new episode''' @abstractmethod def step(self, action: Action) -> Observation: '''Execute action, return observation''' @property def state(self) -> State: '''Get episode metadata''' šŸ“± CLIENT SIDE (your training code): class HTTPEnvClient(ABC): '''Base class for HTTP clients''' def reset(self) -> StepResult: # HTTP POST /reset def step(self, action) -> StepResult: # HTTP POST /step def state(self) -> State: # HTTP GET /state """) print("="*70) print("\n✨ Same interface on both sides - communication via HTTP!") print("šŸŽÆ You focus on RL, OpenEnv handles the infrastructure.\n") ``` **Output:** ``` ====================================================================== 🧩 OPENENV CORE ABSTRACTIONS ====================================================================== šŸ–„ļø SERVER SIDE (runs in Docker): class Environment(ABC): '''Base class for all environment implementations''' @abstractmethod def reset(self) -> Observation: '''Start new episode''' @abstractmethod def step(self, action: Action) -> Observation: '''Execute action, return observation''' @property def state(self) -> State: '''Get episode metadata''' šŸ“± CLIENT SIDE (your training code): class HTTPEnvClient(ABC): '''Base class for HTTP clients''' def reset(self) -> StepResult: # HTTP POST /reset def step(self, action) -> StepResult: # HTTP POST /step def state(self) -> State: # HTTP GET /state ====================================================================== ✨ Same interface on both sides - communication via HTTP! šŸŽÆ You focus on RL, OpenEnv handles the infrastructure. ``` --- (part-5-example-integration---openspiel)= ## Part 5: Example Integration - OpenSpiel šŸŽ® ### What is OpenSpiel? **OpenSpiel** is a library from DeepMind with **70+ game environments** for RL research. ### OpenEnv's Integration We've wrapped **6 OpenSpiel games** following the OpenEnv pattern: | **šŸŽÆ Single-Player** | **šŸ‘„ Multi-Player** | |---------------------|---------------------| | 1. **Catch** - Catch falling ball | 5. **Tic-Tac-Toe** - Classic 3Ɨ3 | | 2. **Cliff Walking** - Navigate grid | 6. **Kuhn Poker** - Imperfect info poker | | 3. **2048** - Tile puzzle | | | 4. **Blackjack** - Card game | | This shows how OpenEnv can wrap **any** existing RL library! ```python from envs.openspiel_env.client import OpenSpielEnv print("="*70) print(" šŸ”Œ HOW OPENENV WRAPS OPENSPIEL") print("="*70) print(""" class OpenSpielEnv(HTTPEnvClient[OpenSpielAction, OpenSpielObservation]): def _step_payload(self, action: OpenSpielAction) -> dict: '''Convert typed action to JSON for HTTP''' return { "action_id": action.action_id, "game_name": action.game_name, } def _parse_result(self, payload: dict) -> StepResult: '''Parse HTTP JSON response into typed observation''' return StepResult( observation=OpenSpielObservation(...), reward=payload['reward'], done=payload['done'] ) """) print("─" * 70) print("\n✨ Usage (works for ALL OpenEnv environments):") print(""" env = OpenSpielEnv(base_url="http://localhost:8000") result = env.reset() # Returns StepResult[OpenSpielObservation] - Type safe! result = env.step(OpenSpielAction(action_id=2, game_name="catch")) # Type checker knows this is valid! state = env.state() # Returns OpenSpielState """) print("─" * 70) print("\nšŸŽÆ This pattern works for ANY environment you want to wrap!\n") ``` **Output:** ``` ====================================================================== šŸ”Œ HOW OPENENV WRAPS OPENSPIEL ====================================================================== class OpenSpielEnv(HTTPEnvClient[OpenSpielAction, OpenSpielObservation]): def _step_payload(self, action: OpenSpielAction) -> dict: '''Convert typed action to JSON for HTTP''' return { "action_id": action.action_id, "game_name": action.game_name, } def _parse_result(self, payload: dict) -> StepResult: '''Parse HTTP JSON response into typed observation''' return StepResult( observation=OpenSpielObservation(...), reward=payload['reward'], done=payload['done'] ) ────────────────────────────────────────────────────────────────────── ✨ Usage (works for ALL OpenEnv environments): env = OpenSpielEnv(base_url="http://localhost:8000") result = env.reset() # Returns StepResult[OpenSpielObservation] - Type safe! result = env.step(OpenSpielAction(action_id=2, game_name="catch")) # Type checker knows this is valid! state = env.state() # Returns OpenSpielState ────────────────────────────────────────────────────────────────────── šŸŽÆ This pattern works for ANY environment you want to wrap! ``` ### Type-Safe Models ```python # Import OpenSpiel integration models from envs.openspiel_env.models import ( OpenSpielAction, OpenSpielObservation, OpenSpielState ) from dataclasses import fields print("="*70) print(" šŸŽ® OPENSPIEL INTEGRATION - TYPE-SAFE MODELS") print("="*70) print("\nšŸ“¤ OpenSpielAction (what you send):") print(" " + "─" * 64) for field in fields(OpenSpielAction): print(f" • {field.name:20s} : {field.type}") print("\nšŸ“„ OpenSpielObservation (what you receive):") print(" " + "─" * 64) for field in fields(OpenSpielObservation): print(f" • {field.name:20s} : {field.type}") print("\nšŸ“Š OpenSpielState (episode metadata):") print(" " + "─" * 64) for field in fields(OpenSpielState): print(f" • {field.name:20s} : {field.type}") print("\n" + "="*70) print("\nšŸ’” Type safety means:") print(" āœ… Your IDE autocompletes these fields") print(" āœ… Typos are caught before running") print(" āœ… Refactoring is safe") print(" āœ… Self-documenting code\n") ``` **Output:** ``` ====================================================================== šŸŽ® OPENSPIEL INTEGRATION - TYPE-SAFE MODELS ====================================================================== šŸ“¤ OpenSpielAction (what you send): ──────────────────────────────────────────────────────────────── • metadata : typing.Dict[str, typing.Any] • action_id : int • game_name : str • game_params : Dict[str, Any] šŸ“„ OpenSpielObservation (what you receive): ──────────────────────────────────────────────────────────────── • done : • reward : typing.Union[bool, int, float, NoneType] • metadata : typing.Dict[str, typing.Any] • info_state : List[float] • legal_actions : List[int] • game_phase : str • current_player_id : int • opponent_last_action : Optional[int] šŸ“Š OpenSpielState (episode metadata): ──────────────────────────────────────────────────────────────── • episode_id : typing.Optional[str] • step_count : • game_name : str • agent_player : int • opponent_policy : str • game_params : Dict[str, Any] • num_players : int ====================================================================== šŸ’” Type safety means: āœ… Your IDE autocompletes these fields āœ… Typos are caught before running āœ… Refactoring is safe āœ… Self-documenting code ``` ### How the Client Works The client **inherits from HTTPEnvClient** and implements 3 methods: 1. `_step_payload()` - Convert action → JSON 2. `_parse_result()` - Parse JSON → typed observation 3. `_parse_state()` - Parse JSON → state That's it! The base class handles all HTTP communication. --- (part-6-using-real-openspiel)= ## Part 6: Using Real OpenSpiel šŸŽ®
### Now let's USE a production environment! We'll play **Catch** using OpenEnv's **OpenSpiel integration** šŸŽÆ This is a REAL environment running in production at companies! **Get ready for:** - šŸ”Œ Using existing environments (not building) - šŸ¤– Testing policies against real games - šŸ“Š Live gameplay visualization - šŸŽÆ Production-ready patterns
### The Game: Catch šŸ”“šŸ“ ``` ⬜ ⬜ šŸ”“ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ Ball ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ falls ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ down ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ ⬜ šŸ“ ⬜ ⬜ Paddle ``` **Rules:** - 10Ɨ5 grid - Ball falls from random column - Move paddle left/right to catch it **Actions:** - `0` = Move LEFT ā¬…ļø - `1` = STAY šŸ›‘ - `2` = Move RIGHT āž”ļø **Reward:** - `+1` if caught šŸŽ‰ - `0` if missed 😢 !!! note "Why Catch?" - Simple rules (easy to understand) - Fast episodes (~5 steps) - Clear success/failure - Part of OpenSpiel's 70+ games! **šŸ’” The Big Idea:** Instead of building this from scratch, we'll USE OpenEnv's existing OpenSpiel integration. Same interface, but production-ready! ```python from envs.openspiel_env import OpenSpielEnv from envs.openspiel_env.models import ( OpenSpielAction, OpenSpielObservation, OpenSpielState ) from dataclasses import fields print("šŸŽ® " + "="*64 + " šŸŽ®") print(" āœ… Importing Real OpenSpiel Environment!") print("šŸŽ® " + "="*64 + " šŸŽ®\n") print("šŸ“¦ What we just imported:") print(" • OpenSpielEnv - HTTP client for OpenSpiel games") print(" • OpenSpielAction - Type-safe actions") print(" • OpenSpielObservation - Type-safe observations") print(" • OpenSpielState - Episode metadata\n") print("šŸ“‹ OpenSpielObservation fields:") print(" " + "─" * 60) for field in fields(OpenSpielObservation): print(f" • {field.name:25s} : {field.type}") print("\n" + "="*70) print("\nšŸ’” This is REAL OpenEnv code - used in production!") print(" • Wraps 6 OpenSpiel games (Catch, Tic-Tac-Toe, Poker, etc.)") print(" • Type-safe actions and observations") print(" • Works via HTTP (we'll see that next!)\n") ``` **Output:** ``` šŸŽ® ================================================================ šŸŽ® āœ… Importing Real OpenSpiel Environment! šŸŽ® ================================================================ šŸŽ® šŸ“¦ What we just imported: • OpenSpielEnv - HTTP client for OpenSpiel games • OpenSpielAction - Type-safe actions • OpenSpielObservation - Type-safe observations • OpenSpielState - Episode metadata šŸ“‹ OpenSpielObservation fields: ──────────────────────────────────────────────────────────── • done : • reward : typing.Union[bool, int, float, NoneType] • metadata : typing.Dict[str, typing.Any] • info_state : List[float] • legal_actions : List[int] • game_phase : str • current_player_id : int • opponent_last_action : Optional[int] ====================================================================== šŸ’” This is REAL OpenEnv code - used in production! • Wraps 6 OpenSpiel games (Catch, Tic-Tac-Toe, Poker, etc.) • Type-safe actions and observations • Works via HTTP (we'll see that next!) ``` --- (part-7-four-policies)= ## Part 7: Four Policies šŸ¤– Let's test 4 different AI strategies: | Policy | Strategy | Expected Performance | |--------|----------|----------------------| | **šŸŽ² Random** | Pick random action every step | ~20% (pure luck) | | **šŸ›‘ Always Stay** | Never move, hope ball lands in center | ~20% (terrible!) | | **🧠 Smart** | Move paddle toward ball | 100% (optimal!) | | **šŸ“ˆ Learning** | Start random, learn smart strategy | ~85% (improves over time) | **šŸ’” These policies work with ANY OpenSpiel game!** ```python import random # ============================================================================ # POLICIES - Different AI strategies (adapted for OpenSpiel) # ============================================================================ class RandomPolicy: """Baseline: Pure random guessing.""" name = "šŸŽ² Random Guesser" def select_action(self, obs: OpenSpielObservation) -> int: return random.choice(obs.legal_actions) class AlwaysStayPolicy: """Bad strategy: Never moves.""" name = "šŸ›‘ Always Stay" def select_action(self, obs: OpenSpielObservation) -> int: return 1 # STAY class SmartPolicy: """Optimal: Move paddle toward ball.""" name = "🧠 Smart Heuristic" def select_action(self, obs: OpenSpielObservation) -> int: # Parse OpenSpiel observation # For Catch: info_state is a flattened 10x5 grid # Ball position and paddle position encoded in the vector info_state = obs.info_state # Find ball and paddle positions from info_state # Catch uses a 10x5 grid, so 50 values grid_size = 5 # Find positions (ball = 1.0 in the flattened grid, paddle = 1.0 in the last row of the flattened grid) ball_col = None paddle_col = None for idx, val in enumerate(info_state): if abs(val - 1.0) < 0.01: # Ball ball_col = idx % grid_size break last_row = info_state[-grid_size:] paddle_col = last_row.index(1.0) # Paddle if ball_col is not None and paddle_col is not None: if paddle_col < ball_col: return 2 # Move RIGHT elif paddle_col > ball_col: return 0 # Move LEFT return 1 # STAY (fallback) class LearningPolicy: """Simulated RL: Epsilon-greedy exploration.""" name = "šŸ“ˆ Learning Agent" def __init__(self): self.steps = 0 self.smart_policy = SmartPolicy() def select_action(self, obs: OpenSpielObservation) -> int: self.steps += 1 # Decay exploration rate over time epsilon = max(0.1, 1.0 - (self.steps / 100)) if random.random() < epsilon: # Explore: random action return random.choice(obs.legal_actions) else: # Exploit: use smart strategy return self.smart_policy.select_action(obs) print("šŸ¤– " + "="*64 + " šŸ¤–") print(" āœ… 4 Policies Created (Adapted for OpenSpiel)!") print("šŸ¤– " + "="*64 + " šŸ¤–\n") policies = [RandomPolicy(), AlwaysStayPolicy(), SmartPolicy(), LearningPolicy()] for i, policy in enumerate(policies, 1): print(f" {i}. {policy.name}") print("\nšŸ’” These policies work with OpenSpielObservation!") print(" • Read info_state (flattened grid)") print(" • Use legal_actions") print(" • Work with ANY OpenSpiel game that exposes these!\n") ``` **Output:** ``` šŸ¤– ================================================================ šŸ¤– āœ… 4 Policies Created (Adapted for OpenSpiel)! šŸ¤– ================================================================ šŸ¤– 1. šŸŽ² Random Guesser 2. šŸ›‘ Always Stay 3. 🧠 Smart Heuristic 4. šŸ“ˆ Learning Agent šŸ’” These policies work with OpenSpielObservation! • Read info_state (flattened grid) • Use legal_actions • Work with ANY OpenSpiel game that exposes these! ``` --- (part-8-policy-competition)= ## Part 8: Policy Competition! šŸ† Let's run **50 episodes** for each policy against **REAL OpenSpiel** and see who wins! This is production code - every action is an HTTP call to the OpenSpiel server! ```python def evaluate_policies(env, num_episodes=50): """Compare all policies over many episodes using real OpenSpiel.""" policies = [ RandomPolicy(), AlwaysStayPolicy(), SmartPolicy(), LearningPolicy(), ] print("\nšŸ† " + "="*66 + " šŸ†") print(f" POLICY SHOWDOWN - {num_episodes} Episodes Each") print(f" Playing against REAL OpenSpiel Catch!") print("šŸ† " + "="*66 + " šŸ†\n") results = [] for policy in policies: print(f"⚔ Testing {policy.name}...", end=" ") successes = sum(run_episode(env, policy, visualize=False) for _ in range(num_episodes)) success_rate = (successes / num_episodes) * 100 results.append((policy.name, success_rate, successes)) print(f"āœ“ Done!") print("\n" + "="*70) print(" šŸ“Š FINAL RESULTS") print("="*70 + "\n") # Sort by success rate (descending) results.sort(key=lambda x: x[1], reverse=True) # Award medals to top 3 medals = ["šŸ„‡", "🄈", "šŸ„‰", " "] for i, (name, rate, successes) in enumerate(results): medal = medals[i] bar = "ā–ˆ" * int(rate / 2) print(f"{medal} {name:25s} [{bar:<50}] {rate:5.1f}% ({successes}/{num_episodes})") print("\n" + "="*70) print("\n✨ Key Insights:") print(" • Random (~20%): Baseline - pure luck šŸŽ²") print(" • Always Stay (~20%): Bad strategy - stays center šŸ›‘") print(" • Smart (100%): Optimal - perfect play! 🧠") print(" • Learning (~85%): Improves over time šŸ“ˆ") print("\nšŸŽ“ This is Reinforcement Learning + OpenEnv in action:") print(" 1. We USED existing OpenSpiel environment (didn't build it)") print(" 2. Type-safe communication over HTTP") print(" 3. Same code works for ANY OpenSpiel game") print(" 4. Production-ready architecture\n") # Run the epic competition! print("šŸŽ® Starting the showdown against REAL OpenSpiel...\n") evaluate_policies(client, num_episodes=50) ``` --- (part-9-switching-to-other-games)= ## Part 9: Switching to Other Games šŸŽ® ### What We Just Used: Real OpenSpiel! šŸŽ‰ In Parts 6-8, we **USED** the existing OpenSpiel Catch environment: | What We Did | How It Works | |-------------|--------------| | **Imported** | OpenSpielEnv client (pre-built) | | **Started** | OpenSpiel server via uvicorn | | **Connected** | HTTP client to server | | **Played** | Real OpenSpiel Catch game | **šŸŽÆ This is production code!** Every action was an HTTP call to a real OpenSpiel environment. ### šŸŽ® 6 Games Available - Same Interface! The beauty of OpenEnv? **Same code, different games!** ```python # We just used Catch env = OpenSpielEnv(base_url="http://localhost:8000") # game_name="catch" was set via environment variable # Want Tic-Tac-Toe instead? Just change the game! # Start server with: OPENSPIEL_GAME=tic_tac_toe uvicorn ... # Same client code works! ``` **šŸŽ® All 6 Games:** 1. āœ… **`catch`** - What we just used! 2. **`tic_tac_toe`** - Classic 3Ɨ3 3. **`kuhn_poker`** - Imperfect information poker 4. **`cliff_walking`** - Grid navigation 5. **`2048`** - Tile puzzle 6. **`blackjack`** - Card game **All use the exact same OpenSpielEnv client!** ### Try Another Game (Optional): ```python # Stop the current server (kill the server_process) # Then start a new game: server_process = subprocess.Popen( [sys.executable, "-m", "uvicorn", "envs.openspiel_env.server.app:app", "--host", "0.0.0.0", "--port", "8000"], env={**os.environ, "PYTHONPATH": f"{work_dir}/src", "OPENSPIEL_GAME": "tic_tac_toe", # Changed! "OPENSPIEL_AGENT_PLAYER": "0", "OPENSPIEL_OPPONENT_POLICY": "random"}, # ... rest of config ) # Same client works! client = OpenSpielEnv(base_url="http://localhost:8000") result = client.reset() # Now playing Tic-Tac-Toe! ``` **šŸ’” Key Insight**: You don't rebuild anything - you just USE different games with the same client! --- (part-10-create-your-own-integration)= ## Part 10: Create Your Own Integration šŸ› ļø ### The 5-Step Pattern Want to wrap your own environment in OpenEnv? Here's how: ### Step 1: Define Types (`models.py`) ```python from dataclasses import dataclass from core.env_server import Action, Observation, State @dataclass class YourAction(Action): action_value: int # Add your action fields @dataclass class YourObservation(Observation): state_data: List[float] done: bool reward: float # Add your observation fields @dataclass class YourState(State): episode_id: str step_count: int # Add your state fields ``` ### Step 2: Implement Environment (`server/environment.py`) ```python from core.env_server import Environment class YourEnvironment(Environment): def reset(self) -> Observation: # Initialize your game/simulation return YourObservation(...) def step(self, action: Action) -> Observation: # Execute action, update state return YourObservation(...) @property def state(self) -> State: return self._state ``` ### Step 3: Create Client (`client.py`) ```python from core.http_env_client import HTTPEnvClient from core.types import StepResult class YourEnv(HTTPEnvClient[YourAction, YourObservation]): def _step_payload(self, action: YourAction) -> dict: """Convert action to JSON""" return {"action_value": action.action_value} def _parse_result(self, payload: dict) -> StepResult: """Parse JSON to observation""" return StepResult( observation=YourObservation(...), reward=payload['reward'], done=payload['done'] ) def _parse_state(self, payload: dict) -> YourState: return YourState(...) ``` ### Step 4: Create Server (`server/app.py`) ```python from core.env_server import create_fastapi_app from .your_environment import YourEnvironment env = YourEnvironment() app = create_fastapi_app(env) # That's it! OpenEnv creates all endpoints for you. ``` ### Step 5: Dockerize (`server/Dockerfile`) ```dockerfile FROM python:3.11-slim WORKDIR /app COPY requirements.txt . RUN pip install --no-cache-dir -r requirements.txt COPY . . CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8000"] ``` ### šŸŽ“ Examples to Study OpenEnv includes 3 complete examples: 1. **`src/envs/echo_env/`** - Simplest possible environment - Great for testing and learning 2. **`src/envs/openspiel_env/`** - Wraps external library (OpenSpiel) - Shows integration pattern - 6 games in one integration 3. **`src/envs/coding_env/`** - Python code execution environment - Shows complex use case - Security considerations **šŸ’” Study these to understand the patterns!** --- (summary-your-journey)= ## šŸŽ“ Summary: Your Journey ### What You Learned
### šŸ“š Concepts āœ… **RL Fundamentals** - The observe-act-reward loop - What makes good policies - Exploration vs exploitation āœ… **OpenEnv Architecture** - Client-server separation - Type-safe contracts - HTTP communication layer āœ… **Production Patterns** - Docker isolation - API design - Reproducible deployments ### šŸ› ļø Skills āœ… **Using Environments** - Import OpenEnv clients - Call reset/step/state - Work with typed observations āœ… **Building Environments** - Define type-safe models - Implement Environment class - Create HTTPEnvClient āœ… **Testing & Debugging** - Compare policies - Visualize episodes - Measure performance
### OpenEnv vs Traditional RL | Feature | Traditional (Gym) | OpenEnv | Winner | |---------|------------------|---------|--------| | **Type Safety** | āŒ Arrays, dicts | āœ… Dataclasses | šŸ† OpenEnv | | **Isolation** | āŒ Same process | āœ… Docker | šŸ† OpenEnv | | **Deployment** | āŒ Manual setup | āœ… K8s-ready | šŸ† OpenEnv | | **Language** | āŒ Python only | āœ… Any (HTTP) | šŸ† OpenEnv | | **Reproducibility** | āŒ "Works on my machine" | āœ… Same everywhere | šŸ† OpenEnv | | **Community** | āœ… Large ecosystem | 🟔 Growing | šŸ¤ Both! | !!! success "The Bottom Line" OpenEnv brings **production engineering** to RL: - Same environments work locally and in production - Type safety catches bugs early - Docker isolation prevents conflicts - HTTP API works with any language **It's RL for 2024 and beyond.** --- (resources)= ## šŸ“š Resources ### šŸ”— Essential Links - **šŸ  OpenEnv GitHub**: https://github.com/meta-pytorch/OpenEnv - **šŸŽ® OpenSpiel**: https://github.com/google-deepmind/open_spiel - **⚔ FastAPI Docs**: https://fastapi.tiangolo.com/ - **🐳 Docker Guide**: https://docs.docker.com/get-started/ - **šŸ”„ PyTorch**: https://pytorch.org/ ### šŸ“– Documentation Deep Dives - **Environment Creation Guide**: `src/envs/README.md` - **OpenSpiel Integration**: `src/envs/openspiel_env/README.md` - **Example Scripts**: `examples/` - **RFC 001**: [Baseline API Specs](https://github.com/meta-pytorch/OpenEnv/pull/26) ### šŸŽ“ Community & Support **Supported by amazing organizations:** - šŸ”„ Meta PyTorch - šŸ¤— Hugging Face - ⚔ Unsloth AI - 🌟 Reflection AI - šŸš€ And many more! **License**: BSD 3-Clause (very permissive!) **Contributions**: Always welcome! Check out the issues tab. --- ### 🌈 What's Next? 1. ⭐ **Star the repo** to show support and stay updated 2. šŸ”„ **Try modifying** the Catch game (make it harder? bigger grid?) 3. šŸŽ® **Explore** other OpenSpiel games 4. šŸ› ļø **Build** your own environment integration 5. šŸ’¬ **Share** what you build with the community!