burtenshaw HF Staff commited on
Commit
77e05f8
ยท
verified ยท
1 Parent(s): 41d5a38

Upload folder using huggingface_hub

Browse files
Files changed (35) hide show
  1. Dockerfile +31 -0
  2. README.md +37 -5
  3. src/core/core/README.md +180 -0
  4. src/core/core/__init__.py +19 -0
  5. src/core/core/client_types.py +22 -0
  6. src/core/core/containers/__init__.py +7 -0
  7. src/core/core/containers/images/Dockerfile +46 -0
  8. src/core/core/containers/images/README.md +92 -0
  9. src/core/core/containers/runtime/__init__.py +15 -0
  10. src/core/core/containers/runtime/providers.py +289 -0
  11. src/core/core/containers/test_local_docker_provider.py +258 -0
  12. src/core/core/env_server/__init__.py +35 -0
  13. src/core/core/env_server/base_transforms.py +29 -0
  14. src/core/core/env_server/http_server.py +233 -0
  15. src/core/core/env_server/interfaces.py +118 -0
  16. src/core/core/env_server/types.py +57 -0
  17. src/core/core/env_server/web_interface.py +1613 -0
  18. src/core/core/http_env_client.py +185 -0
  19. src/core/core/pyproject.toml +46 -0
  20. src/core/core/tools/__init__.py +16 -0
  21. src/core/core/tools/git_server_client.py +362 -0
  22. src/core/core/tools/local_python_executor.py +105 -0
  23. src/envs/openspiel_env/openspiel_env/README.md +335 -0
  24. src/envs/openspiel_env/openspiel_env/__init__.py +26 -0
  25. src/envs/openspiel_env/openspiel_env/client.py +117 -0
  26. src/envs/openspiel_env/openspiel_env/docker_issue.md +1 -0
  27. src/envs/openspiel_env/openspiel_env/models.py +76 -0
  28. src/envs/openspiel_env/openspiel_env/server/Dockerfile +39 -0
  29. src/envs/openspiel_env/openspiel_env/server/Dockerfile.openspiel-base +65 -0
  30. src/envs/openspiel_env/openspiel_env/server/__init__.py +7 -0
  31. src/envs/openspiel_env/openspiel_env/server/app.py +55 -0
  32. src/envs/openspiel_env/openspiel_env/server/build_docker.sh +69 -0
  33. src/envs/openspiel_env/openspiel_env/server/openspiel_environment.py +266 -0
  34. src/envs/openspiel_env/openspiel_env/server/opponent_policies.py +90 -0
  35. src/envs/openspiel_env/openspiel_env/test_docker_all_games.sh +152 -0
Dockerfile ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # OpenSpiel environment using pre-built OpenSpiel base image
2
+ ARG OPENSPIEL_BASE_IMAGE=ghcr.io/meta-pytorch/openenv-openspiel-base:sha-e622c7e
3
+ FROM ${OPENSPIEL_BASE_IMAGE}
4
+
5
+ # Copy OpenEnv core (base image already set WORKDIR=/app)
6
+ WORKDIR /app
7
+ COPY src/core/ /app/src/core/
8
+
9
+ # Copy OpenSpiel environment
10
+ COPY src/envs/openspiel_env/ /app/src/envs/openspiel_env/
11
+
12
+ # Copy README for web interface documentation
13
+ COPY src/envs/openspiel_env/README.md /app/README.md
14
+
15
+ # Extend Python path for OpenEnv (base image set PYTHONPATH=/app/src)
16
+ # We prepend OpenSpiel paths
17
+ ENV PYTHONPATH=/repo:/repo/build/python:/app/src
18
+
19
+ # OpenSpiel-specific environment variables (can be overridden at runtime)
20
+ ENV OPENSPIEL_GAME=catch
21
+ ENV OPENSPIEL_AGENT_PLAYER=0
22
+ ENV OPENSPIEL_OPPONENT_POLICY=random
23
+
24
+ # Health check (curl is provided by openenv-base)
25
+ HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 CMD curl -f http://localhost:8000/health || exit 1
26
+
27
+ # Note: EXPOSE 8000 already set by openenv-base
28
+
29
+ # Run the FastAPI server (uvicorn installed by openenv-base)
30
+ CMD ["uvicorn", "envs.openspiel_env.server.app:app", "--host", "0.0.0.0", "--port", "8000"]
31
+ ENV ENABLE_WEB_INTERFACE=true
README.md CHANGED
@@ -1,10 +1,42 @@
1
  ---
2
- title: Openspiel Env
3
- emoji: ๐ŸŒ–
4
- colorFrom: indigo
5
- colorTo: green
6
  sdk: docker
7
  pinned: false
 
 
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Openspiel_env Environment Server
3
+ emoji: ๐ŸŽฎ
4
+ colorFrom: purple
5
+ colorTo: indigo
6
  sdk: docker
7
  pinned: false
8
+ app_port: 8000
9
+ base_path: /web
10
  ---
11
 
12
+ # Openspiel_env Environment Server
13
+
14
+ FastAPI server for openspiel_env environment powered by Meta's OpenEnv.
15
+
16
+ ## About
17
+
18
+ This Space provides a containerized environment for openspiel_env interactions.
19
+ Built with FastAPI and OpenEnv framework.
20
+
21
+ ## Web Interface
22
+
23
+ This deployment includes an interactive web interface for exploring the environment:
24
+ - **HumanAgent Interface**: Interact with the environment using a web form
25
+ - **State Observer**: Real-time view of environment state and action history
26
+ - **Live Updates**: WebSocket-based real-time updates
27
+
28
+ Access the web interface at: `/web`
29
+
30
+ ## OpenSpiel Environment
31
+
32
+ Provides access to OpenSpiel games for multi-agent reinforcement learning.
33
+
34
+ ### Usage
35
+ Send a POST request to `/step` with:
36
+ ```json
37
+ {
38
+ "action": {
39
+ "action_id": 1
40
+ }
41
+ }
42
+ ```
src/core/core/README.md ADDED
@@ -0,0 +1,180 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # <img width="35" height="35" alt="image" src="https://github.com/user-attachments/assets/2700a971-e5d6-4036-b03f-2f89c9791609" /> OpenEnv: Agentic Execution Environments
2
+
3
+ An e2e framework for creating, deploying and using isolated execution environments for agentic RL training, built using Gymnasium style simple APIs. OpenEnv provides a standard for interacting with agentic execution environments via simple Gymnasium style APIs - step(), reset(), state(). Users of agentic execution environments can interact with the environment during RL training loops using these simple APIs.
4
+
5
+ In addition to making it easier for researchers and RL framework writers, we also provide tools for environment creators making it easier for them to create richer environments and make them available over familar protocols like HTTP and packaged using canonical technologies like docker. Environment creators can use the OpenEnv framework to create environments that are isolated, secure, and easy to deploy and use.
6
+
7
+
8
+ ## Overview
9
+ `openenv-core` provides the foundational building blocks for creating and interacting with containerized environments over HTTP. It enables you to build agent environments that can be deployed as Docker containers and accessed via a simple HTTP API.
10
+
11
+ > โš ๏ธ **Early Development Warning** OpenEnv is currently in an experimental
12
+ > stage. You should expect bugs, incomplete features, and APIs that may change
13
+ > in future versions. The project welcomes bugfixes, but to make sure things are
14
+ > well coordinated you should discuss any significant change before starting the
15
+ > work. It's recommended that you signal your intention to contribute in the
16
+ > issue tracker, either by filing a new issue or by claiming an existing one.
17
+
18
+
19
+ # OpenEnv Core
20
+
21
+ Core components for OpenEnv - a framework for building HTTP-based agentic environments.
22
+
23
+ ## Features
24
+
25
+ - **HTTPEnvClient**: Generic HTTP client for interacting with remote environments
26
+ - **HTTPEnvServer**: FastAPI-based server wrapper for exposing environments over HTTP
27
+ - **Container Providers**: Pluggable architecture for running containers (Docker, Kubernetes, etc.)
28
+ - **Type System**: Strongly-typed Action/Observation/State interfaces
29
+ - **Web Interface**: Optional web UI for interacting with environments
30
+
31
+ ## Installation
32
+
33
+ ```bash
34
+ pip install openenv-core
35
+ ```
36
+
37
+ For development:
38
+ ```bash
39
+ pip install openenv-core[dev]
40
+ ```
41
+
42
+ ## Quick Start
43
+
44
+ ### Creating an Environment Client
45
+
46
+ ```python
47
+ from openenv_core import HTTPEnvClient, StepResult
48
+ from dataclasses import dataclass
49
+
50
+ @dataclass
51
+ class MyAction:
52
+ text: str
53
+
54
+ @dataclass
55
+ class MyObservation:
56
+ response: str
57
+
58
+ class MyEnvClient(HTTPEnvClient[MyAction, MyObservation]):
59
+ def _step_payload(self, action: MyAction) -> dict:
60
+ return {"text": action.text}
61
+
62
+ def _parse_result(self, payload: dict) -> StepResult[MyObservation]:
63
+ obs_data = payload["observation"]
64
+ return StepResult(
65
+ observation=MyObservation(**obs_data),
66
+ reward=payload.get("reward"),
67
+ done=payload.get("done", False)
68
+ )
69
+
70
+ def _parse_state(self, payload: dict) -> Any:
71
+ return payload
72
+
73
+ # Use with Docker
74
+ env = MyEnvClient.from_docker_image("my-env:latest")
75
+ result = env.reset()
76
+ step_result = env.step(MyAction(text="hello"))
77
+ env.close()
78
+ ```
79
+
80
+ ### Creating an Environment Server
81
+
82
+ ```python
83
+ from openenv_core.env_server import Environment, HTTPEnvServer, create_app
84
+ from dataclasses import dataclass
85
+
86
+ @dataclass
87
+ class MyAction:
88
+ text: str
89
+
90
+ @dataclass
91
+ class MyObservation:
92
+ response: str
93
+ reward: float = 0.0
94
+ done: bool = False
95
+
96
+ class MyEnvironment(Environment):
97
+ def reset(self) -> MyObservation:
98
+ return MyObservation(response="Ready")
99
+
100
+ def step(self, action: MyAction) -> MyObservation:
101
+ return MyObservation(
102
+ response=f"Echo: {action.text}",
103
+ reward=1.0,
104
+ done=False
105
+ )
106
+
107
+ # Create FastAPI app
108
+ env = MyEnvironment()
109
+ app = create_app(env, MyAction, MyObservation)
110
+
111
+ # Run with: uvicorn module:app --host 0.0.0.0 --port 8000
112
+ ```
113
+
114
+ ## Container Providers
115
+
116
+ OpenEnv Core supports multiple container providers:
117
+
118
+ ### Local Docker Provider
119
+
120
+ ```python
121
+ from openenv_core.containers.runtime import LocalDockerProvider
122
+
123
+ provider = LocalDockerProvider()
124
+ base_url = provider.start_container("my-env:latest")
125
+ provider.wait_for_ready(base_url)
126
+ # Use environment...
127
+ provider.stop_container()
128
+ ```
129
+
130
+ ### Kubernetes Provider (Coming Soon)
131
+
132
+ ```python
133
+ from openenv_core.containers.runtime import KubernetesProvider
134
+
135
+ provider = KubernetesProvider(namespace="envs")
136
+ base_url = provider.start_container("my-env:latest")
137
+ # Use environment...
138
+ provider.stop_container()
139
+ ```
140
+
141
+
142
+ ## API Reference
143
+
144
+ ### HTTPEnvClient
145
+
146
+ Base class for environment clients with these abstract methods:
147
+
148
+ - `_step_payload(action)`: Convert action to JSON
149
+ - `_parse_result(payload)`: Parse response to StepResult
150
+ - `_parse_state(payload)`: Parse state response
151
+
152
+ ### HTTPEnvServer
153
+
154
+ Server wrapper with these methods:
155
+
156
+ - `register_routes(app)`: Register endpoints on FastAPI app
157
+ - `_deserialize_action(data)`: Convert JSON to Action
158
+ - `_serialize_observation(obs)`: Convert Observation to JSON
159
+
160
+ ### Environment Interface
161
+
162
+ Base interface for environment implementations:
163
+
164
+ - `reset()`: Reset environment and return initial observation
165
+ - `step(action)`: Execute action and return observation
166
+ - `state`: Property returning current environment state
167
+
168
+ ## License
169
+
170
+ This project is licensed under the BSD-3-Clause License - see the LICENSE file for details.
171
+
172
+ ## Contributing
173
+
174
+ Contributions are welcome! Please see the main OpenEnv repository for contribution guidelines.
175
+
176
+ ## Links
177
+
178
+ - **Homepage**: https://github.com/facebookresearch/OpenEnv
179
+ - **Documentation**: https://github.com/facebookresearch/OpenEnv/blob/main/README.md
180
+ - **Bug Tracker**: https://github.com/facebookresearch/OpenEnv/issues
src/core/core/__init__.py ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Core components for agentic environments."""
8
+
9
+ # Re-export main components from submodules for convenience
10
+ from .env_server import *
11
+ from .client_types import StepResult
12
+ from .http_env_client import HTTPEnvClient
13
+
14
+ # Note: MCP module doesn't export anything yet
15
+
16
+ __all__ = [
17
+ "HTTPEnvClient",
18
+ "StepResult",
19
+ ]
src/core/core/client_types.py ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Type definitions for EnvTorch
2
+ from dataclasses import dataclass
3
+ from typing import Any, Generic, Optional, TypeVar
4
+
5
+ # Generic type for observations
6
+ ObsT = TypeVar("ObsT") # TypeVar for typehinting in IDEs
7
+
8
+
9
+ @dataclass
10
+ class StepResult(Generic[ObsT]):
11
+ """
12
+ Represents the result of one environment step.
13
+
14
+ Attributes:
15
+ observation: The environment's observation after the action.
16
+ reward: Scalar reward for this step (optional).
17
+ done: Whether the episode is finished.
18
+ """
19
+
20
+ observation: ObsT
21
+ reward: Optional[float] = None
22
+ done: bool = False
src/core/core/containers/__init__.py ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Container management for environment servers."""
src/core/core/containers/images/Dockerfile ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ #
8
+ # OpenEnv Base Image
9
+ #
10
+ # This is the standard base image for all OpenEnv environment servers.
11
+ # It includes the minimal dependencies needed to run HTTP environment servers.
12
+ #
13
+ # Build: docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
14
+ # Tag: docker tag openenv-base:latest openenv-base:0.1.0
15
+ #
16
+
17
+ FROM python:3.11-slim
18
+
19
+ # Set metadata
20
+ LABEL maintainer="OpenEnv Team"
21
+ LABEL description="Base image for OpenEnv based environment servers"
22
+ LABEL version="0.1.0"
23
+
24
+ # Install system dependencies
25
+ RUN apt-get update && apt-get install -y --no-install-recommends \
26
+ curl \
27
+ && rm -rf /var/lib/apt/lists/*
28
+
29
+ # Install Python dependencies that all environments need
30
+ RUN pip install --no-cache-dir \
31
+ fastapi>=0.104.0 \
32
+ "uvicorn[standard]>=0.24.0" \
33
+ requests>=2.25.0 \
34
+ wsproto>=1.0.0
35
+
36
+ # Set working directory
37
+ WORKDIR /app
38
+
39
+ # Default environment variables
40
+ ENV PYTHONPATH=/app/src
41
+ ENV PYTHONUNBUFFERED=1
42
+
43
+ # Default expose port (can be overridden)
44
+ EXPOSE 8000
45
+
46
+ # Note: CMD should be specified in child Dockerfiles
src/core/core/containers/images/README.md ADDED
@@ -0,0 +1,92 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # OpenEnv Base Image
2
+
3
+ Standard base image for all OpenEnv environment servers.
4
+
5
+ ## What's Included
6
+
7
+ | Layer | Size | Contents |
8
+ |-------|------|----------|
9
+ | python:3.11-slim | 200 MB | Base Python runtime |
10
+ | + Dependencies | 100 MB | FastAPI, uvicorn, requests |
11
+ | **Total** | **~300 MB** | Ready for environment servers |
12
+
13
+ ## Image Sizes
14
+
15
+ ```
16
+ openenv-base:latest 300 MB (python + fastapi + uvicorn)
17
+ ```
18
+ echo-env:latest 500 MB (python + fastapi + uvicorn + app)
19
+ coding-env:latest 520 MB (python + fastapi + uvicorn + app + tools)
20
+ another-env:latest 510 MB (python + fastapi + uvicorn + app)
21
+ ---
22
+ Total: 1.5 GB (with lots of duplication)
23
+ ```
24
+
25
+ ### With Base Images (โœ… Solution)
26
+ ```
27
+ openenv-base:latest 300 MB (python + fastapi + uvicorn)
28
+ echo-env:latest 50 MB (app only, uses base)
29
+ coding-env:latest 70 MB (app + tools, uses base)
30
+ another-env:latest 45 MB (app only, uses base)
31
+ ---
32
+ Total: 465 MB (base shared, minimal duplication)
33
+ ```
34
+
35
+ ## Building the Base Image
36
+
37
+ ```bash
38
+ # From project root
39
+ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
40
+ ```
41
+
42
+ ## Usage in Environment Dockerfiles
43
+
44
+ Each environment Dockerfile should start with:
45
+
46
+ ```dockerfile
47
+ FROM openenv-base:latest
48
+
49
+ # Copy only environment-specific files
50
+ COPY src/core/ /app/src/core/
51
+ COPY src/envs/my_env/ /app/src/envs/my_env/
52
+
53
+ # Run the server
54
+ CMD ["uvicorn", "envs.my_env.server.app:app", "--host", "0.0.0.0", "--port", "8000"]
55
+ ```
56
+
57
+ ## Base Image Contents
58
+
59
+ - Python 3.11-slim
60
+ - FastAPI >= 0.104.0
61
+ - Uvicorn >= 0.24.0
62
+ - Requests >= 2.25.0
63
+ - curl (for health checks)
64
+
65
+ ## Example: Building Echo Environment
66
+
67
+ ```bash
68
+ # Step 1: Build base image (do this once)
69
+ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
70
+
71
+ # Step 2: Build echo environment (uses base)
72
+ docker build -t echo-env:latest -f src/envs/echo_env/server/Dockerfile .
73
+
74
+ # Step 3: Run echo environment
75
+ docker run -p 8000:8000 echo-env:latest
76
+ ```
77
+
78
+ ## Updating the Base
79
+
80
+ When dependencies need updating:
81
+
82
+ 1. Update `src/core/containers/images/Dockerfile`
83
+ 2. Rebuild base image
84
+ 3. Rebuild all environment images (they'll use new base)
85
+
86
+ ```bash
87
+ # Update base
88
+ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
89
+
90
+ # Rebuild environments (they automatically use new base)
91
+ docker build -t echo-env:latest -f src/envs/echo_env/server/Dockerfile .
92
+ ```
src/core/core/containers/runtime/__init__.py ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Container runtime providers."""
8
+
9
+ from .providers import ContainerProvider, KubernetesProvider, LocalDockerProvider
10
+
11
+ __all__ = [
12
+ "ContainerProvider",
13
+ "LocalDockerProvider",
14
+ "KubernetesProvider",
15
+ ]
src/core/core/containers/runtime/providers.py ADDED
@@ -0,0 +1,289 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ Container provider abstractions for running environment servers.
9
+
10
+ This module provides a pluggable architecture for different container providers
11
+ (local Docker, Kubernetes, cloud providers, etc.) to be used with HTTPEnvClient.
12
+ """
13
+
14
+ from __future__ import annotations
15
+
16
+ from abc import ABC, abstractmethod
17
+ from typing import Any, Dict, Optional
18
+
19
+
20
+ class ContainerProvider(ABC):
21
+ """
22
+ Abstract base class for container providers.
23
+
24
+ Providers implement this interface to support different container platforms:
25
+ - LocalDockerProvider: Runs containers on local Docker daemon
26
+ - KubernetesProvider: Runs containers in Kubernetes cluster
27
+ - FargateProvider: Runs containers on AWS Fargate
28
+ - CloudRunProvider: Runs containers on Google Cloud Run
29
+
30
+ The provider manages a single container lifecycle and provides the base URL
31
+ for connecting to it.
32
+
33
+ Example:
34
+ >>> provider = LocalDockerProvider()
35
+ >>> base_url = provider.start_container("echo-env:latest")
36
+ >>> print(base_url) # http://localhost:8000
37
+ >>> # Use the environment via base_url
38
+ >>> provider.stop_container()
39
+ """
40
+
41
+ @abstractmethod
42
+ def start_container(
43
+ self,
44
+ image: str,
45
+ port: Optional[int] = None,
46
+ env_vars: Optional[Dict[str, str]] = None,
47
+ **kwargs: Any,
48
+ ) -> str:
49
+ """
50
+ Start a container from the specified image.
51
+
52
+ Args:
53
+ image: Container image name (e.g., "echo-env:latest")
54
+ port: Port to expose (if None, provider chooses)
55
+ env_vars: Environment variables to pass to container
56
+ **kwargs: Provider-specific options
57
+
58
+ Returns:
59
+ Base URL to connect to the container (e.g., "http://localhost:8000")
60
+
61
+ Raises:
62
+ RuntimeError: If container fails to start
63
+ """
64
+ pass
65
+
66
+ @abstractmethod
67
+ def stop_container(self) -> None:
68
+ """
69
+ Stop and remove the running container.
70
+
71
+ This cleans up the container that was started by start_container().
72
+ """
73
+ pass
74
+
75
+ @abstractmethod
76
+ def wait_for_ready(self, base_url: str, timeout_s: float = 30.0) -> None:
77
+ """
78
+ Wait for the container to be ready to accept requests.
79
+
80
+ This typically polls the /health endpoint until it returns 200.
81
+
82
+ Args:
83
+ base_url: Base URL of the container
84
+ timeout_s: Maximum time to wait
85
+
86
+ Raises:
87
+ TimeoutError: If container doesn't become ready in time
88
+ """
89
+ pass
90
+
91
+
92
+ class LocalDockerProvider(ContainerProvider):
93
+ """
94
+ Container provider for local Docker daemon.
95
+
96
+ This provider runs containers on the local machine using Docker.
97
+ Useful for development and testing.
98
+
99
+ Example:
100
+ >>> provider = LocalDockerProvider()
101
+ >>> base_url = provider.start_container("echo-env:latest")
102
+ >>> # Container running on http://localhost:<random-port>
103
+ >>> provider.stop_container()
104
+ """
105
+
106
+ def __init__(self):
107
+ """Initialize the local Docker provider."""
108
+ self._container_id: Optional[str] = None
109
+ self._container_name: Optional[str] = None
110
+
111
+ # Check if Docker is available
112
+ import subprocess
113
+
114
+ try:
115
+ subprocess.run(
116
+ ["docker", "version"],
117
+ check=True,
118
+ capture_output=True,
119
+ timeout=5,
120
+ )
121
+ except (subprocess.CalledProcessError, FileNotFoundError, subprocess.TimeoutExpired):
122
+ raise RuntimeError(
123
+ "Docker is not available. Please install Docker Desktop or Docker Engine."
124
+ )
125
+
126
+ def start_container(
127
+ self,
128
+ image: str,
129
+ port: Optional[int] = None,
130
+ env_vars: Optional[Dict[str, str]] = None,
131
+ **kwargs: Any,
132
+ ) -> str:
133
+ """
134
+ Start a Docker container locally.
135
+
136
+ Args:
137
+ image: Docker image name
138
+ port: Port to expose (if None, finds available port)
139
+ env_vars: Environment variables for the container
140
+ **kwargs: Additional Docker run options
141
+
142
+ Returns:
143
+ Base URL to connect to the container
144
+ """
145
+ import subprocess
146
+ import time
147
+
148
+ # Find available port if not specified
149
+ if port is None:
150
+ port = self._find_available_port()
151
+
152
+ # Generate container name
153
+ self._container_name = self._generate_container_name(image)
154
+
155
+ # Build docker run command
156
+ cmd = [
157
+ "docker", "run",
158
+ "-d", # Detached
159
+ "--name", self._container_name,
160
+ "-p", f"{port}:8000", # Map port
161
+ ]
162
+
163
+ # Add environment variables
164
+ if env_vars:
165
+ for key, value in env_vars.items():
166
+ cmd.extend(["-e", f"{key}={value}"])
167
+
168
+ # Add image
169
+ cmd.append(image)
170
+
171
+ # Run container
172
+ result = subprocess.run(cmd, capture_output=True, text=True, check=True)
173
+ self._container_id = result.stdout.strip()
174
+
175
+ # Wait a moment for container to start
176
+ time.sleep(1)
177
+
178
+ base_url = f"http://localhost:{port}"
179
+ return base_url
180
+
181
+ def stop_container(self) -> None:
182
+ """
183
+ Stop and remove the Docker container.
184
+ """
185
+ if self._container_id is None:
186
+ return
187
+
188
+ import subprocess
189
+
190
+ try:
191
+ # Stop container
192
+ subprocess.run(
193
+ ["docker", "stop", self._container_id],
194
+ capture_output=True,
195
+ check=True,
196
+ timeout=10,
197
+ )
198
+
199
+ # Remove container
200
+ subprocess.run(
201
+ ["docker", "rm", self._container_id],
202
+ capture_output=True,
203
+ check=True,
204
+ timeout=10,
205
+ )
206
+ except subprocess.CalledProcessError:
207
+ # Container might already be stopped/removed
208
+ pass
209
+ finally:
210
+ self._container_id = None
211
+ self._container_name = None
212
+
213
+ def wait_for_ready(self, base_url: str, timeout_s: float = 30.0) -> None:
214
+ """
215
+ Wait for container to be ready by polling /health endpoint.
216
+
217
+ Args:
218
+ base_url: Base URL of the container
219
+ timeout_s: Maximum time to wait
220
+
221
+ Raises:
222
+ TimeoutError: If container doesn't become ready
223
+ """
224
+ import time
225
+ import requests
226
+
227
+ start_time = time.time()
228
+ health_url = f"{base_url}/health"
229
+
230
+ while time.time() - start_time < timeout_s:
231
+ try:
232
+ response = requests.get(health_url, timeout=2.0)
233
+ if response.status_code == 200:
234
+ return
235
+ except requests.RequestException:
236
+ pass
237
+
238
+ time.sleep(0.5)
239
+
240
+ raise TimeoutError(
241
+ f"Container at {base_url} did not become ready within {timeout_s}s"
242
+ )
243
+
244
+ def _find_available_port(self) -> int:
245
+ """
246
+ Find an available port on localhost.
247
+
248
+ Returns:
249
+ An available port number
250
+ """
251
+ import socket
252
+
253
+ with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
254
+ s.bind(("", 0))
255
+ s.listen(1)
256
+ port = s.getsockname()[1]
257
+ return port
258
+
259
+ def _generate_container_name(self, image: str) -> str:
260
+ """
261
+ Generate a unique container name based on image name and timestamp.
262
+
263
+ Args:
264
+ image: Docker image name
265
+
266
+ Returns:
267
+ A unique container name
268
+ """
269
+ import time
270
+
271
+ clean_image = image.split("/")[-1].split(":")[0]
272
+ timestamp = int(time.time() * 1000)
273
+ return f"{clean_image}-{timestamp}"
274
+
275
+
276
+ class KubernetesProvider(ContainerProvider):
277
+ """
278
+ Container provider for Kubernetes clusters.
279
+
280
+ This provider creates pods in a Kubernetes cluster and exposes them
281
+ via services or port-forwarding.
282
+
283
+ Example:
284
+ >>> provider = KubernetesProvider(namespace="envtorch-dev")
285
+ >>> base_url = provider.start_container("echo-env:latest")
286
+ >>> # Pod running in k8s, accessible via service or port-forward
287
+ >>> provider.stop_container()
288
+ """
289
+ pass
src/core/core/containers/test_local_docker_provider.py ADDED
@@ -0,0 +1,258 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/usr/bin/env python3
2
+ """
3
+ End-to-end test for LocalDockerProvider.
4
+
5
+ This script tests the complete flow:
6
+ 1. Start a container using LocalDockerProvider
7
+ 2. Wait for it to be ready
8
+ 3. Make HTTP requests to test the environment
9
+ 4. Clean up the container
10
+ """
11
+
12
+ import sys
13
+ from pathlib import Path
14
+
15
+ # Add src to path
16
+ sys.path.insert(0, str(Path(__file__).parent.parent.parent))
17
+
18
+ import requests
19
+
20
+ from core.containers.runtime import LocalDockerProvider
21
+
22
+ # TODO: Remove this test or make it a functional test sicne this will be tested in e2e test for echo env
23
+ def test_local_docker_provider():
24
+ """Test LocalDockerProvider end-to-end."""
25
+ print("=" * 60)
26
+ print("LocalDockerProvider End-to-End Test")
27
+ print("=" * 60)
28
+ print()
29
+
30
+ provider = None
31
+
32
+ try:
33
+ # Step 1: Create provider
34
+ print("Step 1: Creating LocalDockerProvider...")
35
+ provider = LocalDockerProvider()
36
+ print("โœ“ Provider created\n")
37
+
38
+ # Step 2: Start container
39
+ print("Step 2: Starting echo-env container...")
40
+ base_url = provider.start_container("echo-env:latest")
41
+ print(f"โœ“ Container started at: {base_url}")
42
+ if provider._container_id:
43
+ print(f" Container ID: {provider._container_id[:12]}...")
44
+ if provider._container_name:
45
+ print(f" Container name: {provider._container_name}\n")
46
+
47
+ # Step 3: Wait for ready
48
+ print("Step 3: Waiting for container to be ready...")
49
+ provider.wait_for_ready(base_url, timeout_s=30.0)
50
+ print("โœ“ Container is ready!\n")
51
+
52
+ # Step 4: Test health endpoint
53
+ print("Step 4: Testing /health endpoint...")
54
+ response = requests.get(f"{base_url}/health")
55
+ print(f" Status: {response.status_code}")
56
+ print(f" Response: {response.json()}")
57
+ assert response.status_code == 200
58
+ assert response.json()["status"] == "healthy"
59
+ print("โœ“ Health check passed\n")
60
+
61
+ # Step 5: Test reset endpoint
62
+ print("Step 5: Testing /reset endpoint...")
63
+ response = requests.post(
64
+ f"{base_url}/reset",
65
+ json={},
66
+ headers={"Content-Type": "application/json"},
67
+ )
68
+ print(f" Status: {response.status_code}")
69
+ data = response.json()
70
+ print(f" Message: {data['observation']['echoed_message']}")
71
+ print(f" Reward: {data['reward']}")
72
+ print(f" Done: {data['done']}")
73
+ assert response.status_code == 200
74
+ assert data["observation"]["echoed_message"] == "Echo environment ready!"
75
+ print("โœ“ Reset test passed\n")
76
+
77
+ # Step 6: Test step endpoint
78
+ print("Step 6: Testing /step endpoint...")
79
+ response = requests.post(
80
+ f"{base_url}/step",
81
+ json={"action": {"message": "Hello from LocalDockerProvider!"}},
82
+ headers={"Content-Type": "application/json"},
83
+ )
84
+ print(f" Status: {response.status_code}")
85
+ data = response.json()
86
+ print(f" Echoed: {data['observation']['echoed_message']}")
87
+ print(f" Length: {data['observation']['message_length']}")
88
+ print(f" Reward: {data['reward']}")
89
+ assert response.status_code == 200
90
+ assert data["observation"]["echoed_message"] == "Hello from LocalDockerProvider!"
91
+ assert data["observation"]["message_length"] == 31
92
+ print("โœ“ Step test passed\n")
93
+
94
+ # Step 7: Test state endpoint
95
+ print("Step 7: Testing /state endpoint...")
96
+ response = requests.get(f"{base_url}/state")
97
+ print(f" Status: {response.status_code}")
98
+ data = response.json()
99
+ print(f" Episode ID: {data['episode_id']}")
100
+ print(f" Step count: {data['step_count']}")
101
+ assert response.status_code == 200
102
+ assert data["step_count"] == 1 # One step from above
103
+ print("โœ“ State test passed\n")
104
+
105
+ # Step 8: Multiple steps
106
+ print("Step 8: Testing multiple steps...")
107
+ for i in range(3):
108
+ response = requests.post(
109
+ f"{base_url}/step",
110
+ json={"action": {"message": f"Message {i+1}"}},
111
+ headers={"Content-Type": "application/json"},
112
+ )
113
+ assert response.status_code == 200
114
+ print(f" Step {i+1}: โœ“")
115
+
116
+ # Check state updated
117
+ response = requests.get(f"{base_url}/state")
118
+ data = response.json()
119
+ assert data["step_count"] == 4 # 1 + 3 more steps
120
+ print(f" Final step count: {data['step_count']}")
121
+ print("โœ“ Multiple steps test passed\n")
122
+
123
+ print("=" * 60)
124
+ print("โœ“ All tests passed!")
125
+ print("=" * 60)
126
+ print()
127
+
128
+ return True
129
+
130
+ except Exception as e:
131
+ print(f"\nโŒ Test failed: {e}")
132
+ import traceback
133
+ traceback.print_exc()
134
+ return False
135
+
136
+ finally:
137
+ # Step 9: Cleanup
138
+ if provider is not None:
139
+ print("\nStep 9: Cleaning up container...")
140
+ try:
141
+ provider.stop_container()
142
+ print("โœ“ Container stopped and removed\n")
143
+ except Exception as e:
144
+ print(f"โš ๏ธ Cleanup warning: {e}\n")
145
+
146
+
147
+ def test_provider_with_custom_port():
148
+ """Test provider with custom port."""
149
+ print("=" * 60)
150
+ print("LocalDockerProvider with Custom Port Test")
151
+ print("=" * 60)
152
+ print()
153
+
154
+ provider = None
155
+
156
+ try:
157
+ provider = LocalDockerProvider()
158
+
159
+ print("Starting container on custom port 8123...")
160
+ base_url = provider.start_container("echo-env:latest", port=8123)
161
+ print(f"โœ“ Started at: {base_url}")
162
+ assert ":8123" in base_url
163
+
164
+ print("Waiting for ready...")
165
+ provider.wait_for_ready(base_url)
166
+ print("โœ“ Ready!")
167
+
168
+ print("Testing health...")
169
+ response = requests.get(f"{base_url}/health")
170
+ assert response.status_code == 200
171
+ print("โœ“ Health check passed")
172
+
173
+ print("\nโœ“ Custom port test passed!\n")
174
+ return True
175
+
176
+ except Exception as e:
177
+ print(f"\nโŒ Test failed: {e}")
178
+ return False
179
+
180
+ finally:
181
+ if provider is not None:
182
+ provider.stop_container()
183
+ print("โœ“ Cleaned up\n")
184
+
185
+
186
+ def test_provider_with_env_vars():
187
+ """Test provider with environment variables."""
188
+ print("=" * 60)
189
+ print("LocalDockerProvider with Environment Variables Test")
190
+ print("=" * 60)
191
+ print()
192
+
193
+ provider = None
194
+
195
+ try:
196
+ provider = LocalDockerProvider()
197
+
198
+ print("Starting container with environment variables...")
199
+ base_url = provider.start_container(
200
+ "echo-env:latest",
201
+ env_vars={"DEBUG": "true", "LOG_LEVEL": "info"}
202
+ )
203
+ print(f"โœ“ Started at: {base_url}")
204
+
205
+ print("Waiting for ready...")
206
+ provider.wait_for_ready(base_url)
207
+ print("โœ“ Ready!")
208
+
209
+ print("Testing health...")
210
+ response = requests.get(f"{base_url}/health")
211
+ assert response.status_code == 200
212
+ print("โœ“ Health check passed")
213
+
214
+ print("\nโœ“ Environment variables test passed!\n")
215
+ return True
216
+
217
+ except Exception as e:
218
+ print(f"\nโŒ Test failed: {e}")
219
+ return False
220
+
221
+ finally:
222
+ if provider is not None:
223
+ provider.stop_container()
224
+ print("โœ“ Cleaned up\n")
225
+
226
+
227
+ if __name__ == "__main__":
228
+ print()
229
+ print("๐Ÿณ LocalDockerProvider Test Suite")
230
+ print()
231
+
232
+ results = []
233
+
234
+ # Run basic test
235
+ results.append(("Basic End-to-End", test_local_docker_provider()))
236
+
237
+ # Run custom port test
238
+ results.append(("Custom Port", test_provider_with_custom_port()))
239
+
240
+ # Run environment variables test
241
+ results.append(("Environment Variables", test_provider_with_env_vars()))
242
+
243
+ # Summary
244
+ print("=" * 60)
245
+ print("Test Summary")
246
+ print("=" * 60)
247
+ for name, passed in results:
248
+ status = "โœ“ PASSED" if passed else "โœ— FAILED"
249
+ print(f"{name:25} {status}")
250
+ print("=" * 60)
251
+
252
+ all_passed = all(result for _, result in results)
253
+ if all_passed:
254
+ print("\n๐ŸŽ‰ All tests passed!")
255
+ exit(0)
256
+ else:
257
+ print("\nโŒ Some tests failed")
258
+ exit(1)
src/core/core/env_server/__init__.py ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Core environment interfaces and types."""
8
+
9
+ from .base_transforms import CompositeTransform, NullTransform
10
+ from .http_server import HTTPEnvServer, create_app, create_fastapi_app
11
+ from .interfaces import Environment, Message, ModelTokenizer, Transform
12
+ from .types import Action, Observation, State
13
+ from .web_interface import create_web_interface_app, WebInterfaceManager
14
+
15
+ __all__ = [
16
+ # Core interfaces
17
+ "Environment",
18
+ "Transform",
19
+ "Message",
20
+ "ModelTokenizer",
21
+ # Types
22
+ "Action",
23
+ "Observation",
24
+ "State",
25
+ # Base transforms
26
+ "CompositeTransform",
27
+ "NullTransform",
28
+ # HTTP Server
29
+ "HTTPEnvServer",
30
+ "create_app",
31
+ "create_fastapi_app",
32
+ # Web Interface
33
+ "create_web_interface_app",
34
+ "WebInterfaceManager",
35
+ ]
src/core/core/env_server/base_transforms.py ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Base transform implementations for composing environment-specific transforms."""
8
+
9
+ from .interfaces import Transform
10
+ from .types import Observation
11
+
12
+
13
+ class CompositeTransform(Transform):
14
+ """Combines multiple transforms into a single transform."""
15
+
16
+ def __init__(self, transforms: list[Transform]):
17
+ self.transforms = transforms
18
+
19
+ def __call__(self, observation: Observation) -> Observation:
20
+ for transform in self.transforms:
21
+ observation = transform(observation)
22
+ return observation
23
+
24
+
25
+ class NullTransform(Transform):
26
+ """Default transform that passes through unchanged."""
27
+
28
+ def __call__(self, observation: Observation) -> Observation:
29
+ return observation
src/core/core/env_server/http_server.py ADDED
@@ -0,0 +1,233 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ HTTP server wrapper for Environment instances.
9
+
10
+ This module provides utilities to wrap any Environment subclass and expose it
11
+ over HTTP endpoints that HTTPEnvClient can consume.
12
+ """
13
+
14
+ from __future__ import annotations
15
+
16
+ import os
17
+ from dataclasses import asdict
18
+ from typing import Any, Dict, Type
19
+
20
+ from .interfaces import Environment
21
+ from .types import Action, Observation
22
+ from fastapi import Body, FastAPI
23
+
24
+ class HTTPEnvServer:
25
+ """
26
+ HTTP server wrapper for Environment instances.
27
+
28
+ This class wraps an Environment and exposes its reset(), step(), and state
29
+ methods as HTTP endpoints compatible with HTTPEnvClient.
30
+
31
+ The server expects:
32
+ - Action deserialization: Converts JSON dict to Action subclass
33
+ - Observation serialization: Converts Observation subclass to JSON dict
34
+
35
+ Example:
36
+ >>> from core.env_server import HTTPEnvServer
37
+ >>> from envs.coding_env.server import CodeExecutionEnvironment
38
+ >>>
39
+ >>> env = CodeExecutionEnvironment()
40
+ >>> server = HTTPEnvServer(env)
41
+ >>>
42
+ >>> # Register routes with FastAPI
43
+ >>> from fastapi import FastAPI
44
+ >>> app = FastAPI()
45
+ >>> server.register_routes(app)
46
+ """
47
+
48
+ def __init__(
49
+ self,
50
+ env: Environment,
51
+ action_cls: Type[Action],
52
+ observation_cls: Type[Observation],
53
+ ):
54
+ """
55
+ Initialize HTTP server wrapper.
56
+
57
+ Args:
58
+ env: The Environment instance to wrap
59
+ action_cls: The Action subclass this environment expects
60
+ observation_cls: The Observation subclass this environment returns
61
+ """
62
+ self.env = env
63
+ self.action_cls = action_cls
64
+ self.observation_cls = observation_cls
65
+
66
+ def register_routes(self, app: Any) -> None:
67
+ """
68
+ Register HTTP routes on a FastAPI application.
69
+
70
+ Args:
71
+ app: FastAPI application instance
72
+ """
73
+
74
+ if not isinstance(app, FastAPI):
75
+ raise TypeError("app must be a FastAPI instance")
76
+
77
+ @app.post("/reset")
78
+ async def reset(request: Dict[str, Any] = Body(default={})) -> Dict[str, Any]:
79
+ """Reset endpoint - returns initial observation."""
80
+ # TODO: Handle seed, episode_id from request if provided
81
+ observation = self.env.reset()
82
+ return self._serialize_observation(observation)
83
+
84
+ @app.post("/step")
85
+ async def step(request: Dict[str, Any]) -> Dict[str, Any]:
86
+ """Step endpoint - executes action and returns observation."""
87
+ action_data = request.get("action", {})
88
+ # TODO: Handle timeout_s, request_id, episode_id from request if provided
89
+
90
+ # Deserialize action
91
+ action = self._deserialize_action(action_data)
92
+
93
+ # Execute step
94
+ observation = self.env.step(action)
95
+
96
+ # Return serialized observation
97
+ return self._serialize_observation(observation)
98
+
99
+ @app.get("/state")
100
+ async def get_state() -> Dict[str, Any]:
101
+ """State endpoint - returns current environment state."""
102
+ state = self.env.state
103
+ return asdict(state)
104
+
105
+ @app.get("/health")
106
+ async def health() -> Dict[str, str]:
107
+ """Health check endpoint."""
108
+ return {"status": "healthy"}
109
+
110
+
111
+ def _deserialize_action(self, action_data: Dict[str, Any]) -> Action:
112
+ """
113
+ Convert JSON dict to Action instance.
114
+
115
+ Args:
116
+ action_data: Dictionary containing action data
117
+
118
+ Returns:
119
+ Action instance
120
+
121
+ Note:
122
+ This is a simple implementation. Subclasses may need to override
123
+ for more complex deserialization logic.
124
+ """
125
+ # Remove metadata if present (it will be set via kw_only field)
126
+ metadata = action_data.pop("metadata", {})
127
+ action = self.action_cls(**action_data)
128
+ action.metadata = metadata
129
+ return action
130
+
131
+ def _serialize_observation(self, observation: Observation) -> Dict[str, Any]:
132
+ """
133
+ Convert Observation instance to JSON-compatible dict.
134
+
135
+ Args:
136
+ observation: Observation instance
137
+
138
+ Returns:
139
+ Dictionary compatible with HTTPEnvClient._parse_result()
140
+
141
+ The format matches what HTTPEnvClient expects:
142
+ {
143
+ "observation": {...}, # Observation fields
144
+ "reward": float | None,
145
+ "done": bool,
146
+ }
147
+ """
148
+ obs_dict = asdict(observation)
149
+
150
+ # Extract reward and done (these are part of StepResult on client side)
151
+ reward = obs_dict.pop("reward", None)
152
+ done = obs_dict.pop("done", False)
153
+ obs_dict.pop("metadata", None) # Remove metadata from observation
154
+
155
+ # Return in HTTPEnvClient expected format
156
+ return {
157
+ "observation": obs_dict,
158
+ "reward": reward,
159
+ "done": done,
160
+ }
161
+
162
+ def create_app(
163
+ env: Environment,
164
+ action_cls: Type[Action],
165
+ observation_cls: Type[Observation],
166
+ env_name: Optional[str] = None,
167
+ ) -> Any:
168
+ """
169
+ Create a FastAPI application with or without web interface.
170
+
171
+ This function creates a FastAPI app with the web interface enabled by default,
172
+ including README integration for better user experience.
173
+
174
+ Args:
175
+ env: The Environment instance to serve
176
+ action_cls: The Action subclass this environment expects
177
+ observation_cls: The Observation subclass this environment returns
178
+ env_name: Optional environment name for README loading
179
+
180
+ Returns:
181
+ FastAPI application instance with or without web interface and README integration
182
+ """
183
+ # Check if web interface should be enabled
184
+ # This can be controlled via environment variable or build argument
185
+ enable_web = (
186
+ os.getenv("ENABLE_WEB_INTERFACE", "false").lower() in ("true", "1", "yes")
187
+ )
188
+
189
+ if enable_web:
190
+ # Import web interface only when needed
191
+ from .web_interface import create_web_interface_app
192
+ return create_web_interface_app(env, action_cls, observation_cls, env_name)
193
+ else:
194
+ # Use standard FastAPI app without web interface
195
+ return create_fastapi_app(env, action_cls, observation_cls)
196
+
197
+
198
+ def create_fastapi_app(
199
+ env: Environment,
200
+ action_cls: Type[Action],
201
+ observation_cls: Type[Observation],
202
+ ) -> Any:
203
+ """
204
+ Create a FastAPI application with routes for the given environment.
205
+
206
+ Args:
207
+ env: The Environment instance to serve
208
+ action_cls: The Action subclass this environment expects
209
+ observation_cls: The Observation subclass this environment returns
210
+
211
+ Returns:
212
+ FastAPI application instance with routes registered
213
+
214
+ Example:
215
+ >>> from envs.coding_env.server import CodeExecutionEnvironment
216
+ >>> from envs.coding_env.models import CodeAction, CodeObservation
217
+ >>>
218
+ >>> env = CodeExecutionEnvironment()
219
+ >>> app = create_fastapi_app(env, CodeAction, CodeObservation)
220
+ >>>
221
+ >>> # Run with: uvicorn module:app --host 0.0.0.0 --port 8000
222
+ """
223
+ try:
224
+ from fastapi import FastAPI
225
+ except ImportError:
226
+ raise ImportError(
227
+ "FastAPI is required. Install with: pip install fastapi uvicorn"
228
+ )
229
+
230
+ app = FastAPI(title="Environment HTTP Server")
231
+ server = HTTPEnvServer(env, action_cls, observation_cls)
232
+ server.register_routes(app)
233
+ return app
src/core/core/env_server/interfaces.py ADDED
@@ -0,0 +1,118 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ from abc import ABC, abstractmethod
8
+ from typing import Any, Protocol, TypedDict
9
+
10
+ from .types import Action, Observation, State
11
+
12
+
13
+ class Message(TypedDict):
14
+ """A message in a conversation.
15
+
16
+ Compatible with Huggingface chat template format.
17
+ """
18
+
19
+ role: str
20
+ content: str
21
+
22
+
23
+ class ModelTokenizer(Protocol):
24
+ """Protocol for tokenizers that support chat templates.
25
+
26
+ This protocol defines the interface that tokenizers must implement
27
+ to work with chat-based environments. It's compatible with
28
+ Huggingface transformers tokenizers.
29
+ """
30
+
31
+ def apply_chat_template(
32
+ self,
33
+ conversation: list[Message],
34
+ tokenize: bool = True,
35
+ return_tensors: str | None = None,
36
+ **kwargs: Any,
37
+ ) -> Any:
38
+ """Apply a chat template to format and optionally tokenize a conversation.
39
+
40
+ Args:
41
+ conversation: List of message dictionaries with 'role' and 'content'
42
+ tokenize: Whether to tokenize the output
43
+ return_tensors: Format for returned tensors ('pt' for PyTorch)
44
+ **kwargs: Additional arguments
45
+
46
+ Returns:
47
+ Formatted and optionally tokenized conversation
48
+ """
49
+ ...
50
+
51
+ def decode(
52
+ self, token_ids: Any, skip_special_tokens: bool = False, **kwargs: Any
53
+ ) -> str:
54
+ """Decode token IDs back to text.
55
+
56
+ Args:
57
+ token_ids: Token IDs to decode
58
+ skip_special_tokens: Whether to skip special tokens in output
59
+ **kwargs: Additional arguments
60
+
61
+ Returns:
62
+ Decoded text string
63
+ """
64
+ ...
65
+
66
+
67
+ class Transform(ABC):
68
+ """Transform observations to add rewards, metrics, or other modifications.
69
+
70
+ Transforms follow the TorchRL pattern where they take an observation
71
+ and return a (potentially modified) observation. This allows for
72
+ flexible reward computation and observation augmentation.
73
+ """
74
+
75
+ @abstractmethod
76
+ def __call__(self, observation: Observation) -> Observation:
77
+ """Transform an observation.
78
+
79
+ Args:
80
+ observation: The input observation
81
+
82
+ Returns:
83
+ The transformed observation
84
+ """
85
+ pass
86
+
87
+
88
+ class Environment(ABC):
89
+ """Base class for all environment servers following Gym/Gymnasium API.
90
+
91
+ Args:
92
+ transform: Optional transform to apply to observations
93
+ """
94
+
95
+ def __init__(self, transform: Transform | None = None):
96
+ self.transform = transform
97
+
98
+ @abstractmethod
99
+ def reset(self) -> Observation:
100
+ """Reset the environment and return initial observation."""
101
+ pass
102
+
103
+ @abstractmethod
104
+ def step(self, action: Action) -> Observation:
105
+ """Take a step in the environment."""
106
+ pass
107
+
108
+ @property
109
+ @abstractmethod
110
+ def state(self) -> State:
111
+ """Get the current environment state."""
112
+ pass
113
+
114
+ def _apply_transform(self, observation: Observation) -> Observation:
115
+ """Apply transform if one is provided."""
116
+ if self.transform is not None:
117
+ return self.transform(observation)
118
+ return observation
src/core/core/env_server/types.py ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ from dataclasses import dataclass, field
8
+ from typing import Any, Dict, List, Optional, Union
9
+
10
+
11
+ # Type aliases
12
+ Scalar = Union[int, float, bool]
13
+
14
+
15
+ @dataclass(kw_only=True)
16
+ class Action:
17
+ """Base class for all environment actions."""
18
+
19
+ metadata: Dict[str, Any] = field(default_factory=dict)
20
+
21
+
22
+ @dataclass(kw_only=True)
23
+ class Observation:
24
+ """Base class for all environment observations."""
25
+
26
+ done: bool = False
27
+ reward: Union[bool, int, float, None] = None
28
+ metadata: Dict[str, Any] = field(default_factory=dict)
29
+
30
+
31
+ @dataclass
32
+ class State:
33
+ """Base class for environment state."""
34
+
35
+ episode_id: Optional[str] = None
36
+ step_count: int = 0
37
+
38
+
39
+ @dataclass
40
+ class CodeExecResult:
41
+ """Result of code execution containing stdout, stderr, and exit code."""
42
+
43
+ stdout: str
44
+ stderr: str
45
+ exit_code: int
46
+
47
+
48
+ @dataclass
49
+ class EnvironmentMetadata:
50
+ """Metadata about an environment for documentation and UI purposes."""
51
+
52
+ name: str
53
+ description: str
54
+ readme_content: Optional[str] = None
55
+ version: Optional[str] = None
56
+ author: Optional[str] = None
57
+ documentation_url: Optional[str] = None
src/core/core/env_server/web_interface.py ADDED
@@ -0,0 +1,1613 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ Web interface for OpenEnv environments.
9
+
10
+ This module provides a web-based interface for interacting with OpenEnv environments,
11
+ including a two-pane layout for HumanAgent interaction and state observation.
12
+ """
13
+
14
+ from __future__ import annotations
15
+
16
+ import json
17
+ import time
18
+ from dataclasses import asdict, dataclass
19
+ from typing import Any, Dict, List, Optional, Type
20
+ from datetime import datetime
21
+
22
+ from fastapi import FastAPI, WebSocket, WebSocketDisconnect, Request
23
+ from fastapi.responses import HTMLResponse, FileResponse
24
+ from fastapi.staticfiles import StaticFiles
25
+ from pydantic import BaseModel
26
+
27
+ from .interfaces import Environment
28
+ from .types import Action, Observation, State, EnvironmentMetadata
29
+
30
+
31
+ def load_environment_metadata(env: Environment, env_name: Optional[str] = None) -> EnvironmentMetadata:
32
+ """
33
+ Load environment metadata including README content.
34
+
35
+ Args:
36
+ env: The environment instance
37
+ env_name: Optional environment name for README file lookup
38
+
39
+ Returns:
40
+ EnvironmentMetadata with loaded information
41
+ """
42
+ # Try to get metadata from environment if it has a method for it
43
+ if hasattr(env, 'get_metadata'):
44
+ return env.get_metadata()
45
+
46
+ # Default metadata
47
+ metadata = EnvironmentMetadata(
48
+ name=env_name or env.__class__.__name__,
49
+ description=f"{env.__class__.__name__} environment",
50
+ version="1.0.0"
51
+ )
52
+
53
+ # Try to load README from file system
54
+ readme_content = _load_readme_from_filesystem(env_name)
55
+ if readme_content:
56
+ metadata.readme_content = readme_content
57
+
58
+ return metadata
59
+
60
+
61
+ def _load_readme_from_filesystem(env_name: Optional[str]) -> Optional[str]:
62
+ """
63
+ Load README content from the filesystem.
64
+
65
+ Tries multiple locations:
66
+ 1. Container filesystem: /app/README.md
67
+ 2. Local development: src/envs/{env_name}/README.md
68
+ 3. Environment variable: ENV_README_PATH
69
+ """
70
+ import os
71
+ from pathlib import Path
72
+
73
+ # Try container filesystem first
74
+ container_readme = Path("/app/README.md")
75
+ if container_readme.exists():
76
+ try:
77
+ return container_readme.read_text(encoding='utf-8')
78
+ except Exception:
79
+ pass
80
+
81
+ # Try environment variable path
82
+ custom_path = os.environ.get("ENV_README_PATH")
83
+ if custom_path and Path(custom_path).exists():
84
+ try:
85
+ return Path(custom_path).read_text(encoding='utf-8')
86
+ except Exception:
87
+ pass
88
+
89
+ # Try local development path
90
+ if env_name:
91
+ local_readme = Path(f"src/envs/{env_name}/README.md")
92
+ if local_readme.exists():
93
+ try:
94
+ return local_readme.read_text(encoding='utf-8')
95
+ except Exception:
96
+ pass
97
+
98
+ return None
99
+
100
+
101
+ @dataclass
102
+ class ActionLog:
103
+ """Log entry for an action taken."""
104
+ timestamp: str
105
+ action: Dict[str, Any]
106
+ observation: Dict[str, Any]
107
+ reward: Optional[float]
108
+ done: bool
109
+ step_count: int
110
+
111
+
112
+ @dataclass
113
+ class EpisodeState:
114
+ """Current episode state for the web interface."""
115
+ episode_id: Optional[str]
116
+ step_count: int
117
+ current_observation: Optional[Dict[str, Any]]
118
+ action_logs: List[ActionLog]
119
+ is_reset: bool = True
120
+
121
+
122
+ class WebInterfaceManager:
123
+ """Manages the web interface for an environment."""
124
+
125
+ def __init__(
126
+ self,
127
+ env: Environment,
128
+ action_cls: Type[Action],
129
+ observation_cls: Type[Observation],
130
+ metadata: Optional[EnvironmentMetadata] = None,
131
+ ):
132
+ self.env = env
133
+ self.action_cls = action_cls
134
+ self.observation_cls = observation_cls
135
+ self.metadata = metadata or EnvironmentMetadata(
136
+ name=env.__class__.__name__,
137
+ description=f"{env.__class__.__name__} environment"
138
+ )
139
+ self.episode_state = EpisodeState(
140
+ episode_id=None,
141
+ step_count=0,
142
+ current_observation=None,
143
+ action_logs=[]
144
+ )
145
+ self.connected_clients: List[WebSocket] = []
146
+
147
+ async def connect_websocket(self, websocket: WebSocket):
148
+ """Connect a new WebSocket client."""
149
+ await websocket.accept()
150
+ self.connected_clients.append(websocket)
151
+
152
+ # Send current state to the new client
153
+ await self._send_state_update()
154
+
155
+ async def disconnect_websocket(self, websocket: WebSocket):
156
+ """Disconnect a WebSocket client."""
157
+ if websocket in self.connected_clients:
158
+ self.connected_clients.remove(websocket)
159
+
160
+ async def _send_state_update(self):
161
+ """Send current state to all connected clients."""
162
+ if not self.connected_clients:
163
+ return
164
+
165
+ state_data = {
166
+ "type": "state_update",
167
+ "episode_state": asdict(self.episode_state)
168
+ }
169
+
170
+ # Send to all connected clients
171
+ disconnected_clients = []
172
+ for client in self.connected_clients:
173
+ try:
174
+ await client.send_text(json.dumps(state_data))
175
+ except:
176
+ disconnected_clients.append(client)
177
+
178
+ # Remove disconnected clients
179
+ for client in disconnected_clients:
180
+ self.connected_clients.remove(client)
181
+
182
+ async def reset_environment(self) -> Dict[str, Any]:
183
+ """Reset the environment and update state."""
184
+ observation = self.env.reset()
185
+ state = self.env.state
186
+
187
+ # Update episode state
188
+ self.episode_state.episode_id = state.episode_id
189
+ self.episode_state.step_count = 0
190
+ self.episode_state.current_observation = asdict(observation)
191
+ self.episode_state.action_logs = []
192
+ self.episode_state.is_reset = True
193
+
194
+ # Send state update
195
+ await self._send_state_update()
196
+
197
+ return {
198
+ "observation": asdict(observation),
199
+ "reward": observation.reward,
200
+ "done": observation.done,
201
+ }
202
+
203
+ async def step_environment(self, action_data: Dict[str, Any]) -> Dict[str, Any]:
204
+ """Execute a step in the environment and update state."""
205
+ # Deserialize action
206
+ action = self._deserialize_action(action_data)
207
+
208
+ # Execute step
209
+ observation = self.env.step(action)
210
+ state = self.env.state
211
+
212
+ # Create action log
213
+ action_log = ActionLog(
214
+ timestamp=datetime.now().isoformat(),
215
+ action=asdict(action),
216
+ observation=asdict(observation),
217
+ reward=observation.reward,
218
+ done=observation.done,
219
+ step_count=state.step_count
220
+ )
221
+
222
+ # Update episode state
223
+ self.episode_state.episode_id = state.episode_id
224
+ self.episode_state.step_count = state.step_count
225
+ self.episode_state.current_observation = asdict(observation)
226
+ self.episode_state.action_logs.append(action_log)
227
+ self.episode_state.is_reset = False
228
+
229
+ # Send state update
230
+ await self._send_state_update()
231
+
232
+ return {
233
+ "observation": asdict(observation),
234
+ "reward": observation.reward,
235
+ "done": observation.done,
236
+ }
237
+
238
+ def get_state(self) -> Dict[str, Any]:
239
+ """Get current environment state."""
240
+ state = self.env.state
241
+ return asdict(state)
242
+
243
+ def _deserialize_action(self, action_data: Dict[str, Any]) -> Action:
244
+ """Convert JSON dict to Action instance."""
245
+ metadata = action_data.pop("metadata", {})
246
+
247
+ # Handle tensor fields that come from JSON as lists
248
+ processed_data = {}
249
+ for key, value in action_data.items():
250
+ if key == "tokens" and isinstance(value, (list, str)):
251
+ # Convert list or string to tensor
252
+ if isinstance(value, str):
253
+ # If it's a string, try to parse it as a list of numbers
254
+ try:
255
+ import json
256
+ value = json.loads(value)
257
+ except:
258
+ # If parsing fails, treat as empty list
259
+ value = []
260
+ if isinstance(value, list):
261
+ import torch
262
+ processed_data[key] = torch.tensor(value, dtype=torch.long)
263
+ else:
264
+ processed_data[key] = value
265
+ elif key == "action_id" and isinstance(value, str):
266
+ # Convert action_id from string to int
267
+ try:
268
+ processed_data[key] = int(value)
269
+ except ValueError:
270
+ # If conversion fails, keep original value
271
+ processed_data[key] = value
272
+ else:
273
+ processed_data[key] = value
274
+
275
+ action = self.action_cls(**processed_data)
276
+ action.metadata = metadata
277
+ return action
278
+
279
+
280
+ def create_web_interface_app(
281
+ env: Environment,
282
+ action_cls: Type[Action],
283
+ observation_cls: Type[Observation],
284
+ env_name: Optional[str] = None,
285
+ ) -> FastAPI:
286
+ """
287
+ Create a FastAPI application with web interface for the given environment.
288
+
289
+ Args:
290
+ env: The Environment instance to serve
291
+ action_cls: The Action subclass this environment expects
292
+ observation_cls: The Observation subclass this environment returns
293
+ env_name: Optional environment name for README loading
294
+
295
+ Returns:
296
+ FastAPI application instance with web interface
297
+ """
298
+ from .http_server import create_fastapi_app
299
+
300
+ # Create the base environment app
301
+ app = create_fastapi_app(env, action_cls, observation_cls)
302
+
303
+ # Load environment metadata
304
+ metadata = load_environment_metadata(env, env_name)
305
+
306
+ # Create web interface manager
307
+ web_manager = WebInterfaceManager(env, action_cls, observation_cls, metadata)
308
+
309
+ # Add web interface routes
310
+ @app.get("/web", response_class=HTMLResponse)
311
+ async def web_interface():
312
+ """Serve the web interface."""
313
+ return get_web_interface_html(action_cls, web_manager.metadata)
314
+
315
+ @app.get("/web/metadata")
316
+ async def web_metadata():
317
+ """Get environment metadata."""
318
+ return asdict(web_manager.metadata)
319
+
320
+ @app.websocket("/ws")
321
+ async def websocket_endpoint(websocket: WebSocket):
322
+ """WebSocket endpoint for real-time updates."""
323
+ await web_manager.connect_websocket(websocket)
324
+ try:
325
+ while True:
326
+ # Keep connection alive
327
+ await websocket.receive_text()
328
+ except WebSocketDisconnect:
329
+ await web_manager.disconnect_websocket(websocket)
330
+
331
+ @app.post("/web/reset")
332
+ async def web_reset():
333
+ """Reset endpoint for web interface."""
334
+ return await web_manager.reset_environment()
335
+
336
+ @app.post("/web/step")
337
+ async def web_step(request: Dict[str, Any]):
338
+ """Step endpoint for web interface."""
339
+ # Check if this is a message-based request (chat environment)
340
+ if "message" in request:
341
+ message = request["message"]
342
+ # Convert message to action using the environment's message_to_action method
343
+ action = web_manager.env.message_to_action(message)
344
+ action_data = {"tokens": action.tokens.tolist()}
345
+ else:
346
+ action_data = request.get("action", {})
347
+
348
+ return await web_manager.step_environment(action_data)
349
+
350
+ @app.get("/web/state")
351
+ async def web_state():
352
+ """State endpoint for web interface."""
353
+ return web_manager.get_state()
354
+
355
+ return app
356
+
357
+
358
+ def get_web_interface_html(action_cls: Type[Action], metadata: Optional[EnvironmentMetadata] = None) -> str:
359
+ """Generate the HTML for the web interface."""
360
+
361
+ # Check if this is a chat environment by looking for tokens field
362
+ is_chat_env = False
363
+ if hasattr(action_cls, '__dataclass_fields__'):
364
+ for field_name, field_info in action_cls.__dataclass_fields__.items():
365
+ if field_name == 'tokens' and hasattr(field_info.type, '__name__') and 'Tensor' in field_info.type.__name__:
366
+ is_chat_env = True
367
+ break
368
+
369
+ # Get action fields for dynamic form generation with enhanced metadata
370
+ action_fields = _extract_action_fields(action_cls)
371
+
372
+ return f"""
373
+ <!DOCTYPE html>
374
+ <html lang="en">
375
+ <head>
376
+ <meta charset="UTF-8">
377
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
378
+ <title>OpenEnv Web Interface</title>
379
+ <style>
380
+ * {{
381
+ margin: 0;
382
+ padding: 0;
383
+ box-sizing: border-box;
384
+ }}
385
+
386
+ body {{
387
+ font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
388
+ background-color: #f5f5f5;
389
+ height: 100vh;
390
+ overflow: hidden;
391
+ }}
392
+
393
+ .container {{
394
+ display: flex;
395
+ height: 100vh;
396
+ }}
397
+
398
+ .left-pane {{
399
+ width: 50%;
400
+ background: white;
401
+ border-right: 1px solid #e0e0e0;
402
+ display: flex;
403
+ flex-direction: column;
404
+ }}
405
+
406
+ .right-pane {{
407
+ width: 50%;
408
+ background: #fafafa;
409
+ display: flex;
410
+ flex-direction: column;
411
+ }}
412
+
413
+ .pane-header {{
414
+ padding: 20px;
415
+ border-bottom: 1px solid #e0e0e0;
416
+ background: #f8f9fa;
417
+ font-weight: 600;
418
+ font-size: 16px;
419
+ }}
420
+
421
+ .pane-content {{
422
+ flex: 1;
423
+ padding: 20px;
424
+ overflow-y: auto;
425
+ }}
426
+
427
+ .action-form {{
428
+ background: white;
429
+ border: 1px solid #e0e0e0;
430
+ border-radius: 8px;
431
+ padding: 20px;
432
+ margin-bottom: 20px;
433
+ }}
434
+
435
+ .form-group {{
436
+ margin-bottom: 15px;
437
+ }}
438
+
439
+ .form-group label {{
440
+ display: block;
441
+ margin-bottom: 5px;
442
+ font-weight: 500;
443
+ color: #333;
444
+ }}
445
+
446
+ .form-group input, .form-group textarea {{
447
+ width: 100%;
448
+ padding: 8px 12px;
449
+ border: 1px solid #ddd;
450
+ border-radius: 4px;
451
+ font-size: 14px;
452
+ }}
453
+
454
+ .form-group input:focus, .form-group textarea:focus {{
455
+ outline: none;
456
+ border-color: #007bff;
457
+ box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
458
+ }}
459
+
460
+ .btn {{
461
+ background: #007bff;
462
+ color: white;
463
+ border: none;
464
+ padding: 10px 20px;
465
+ border-radius: 4px;
466
+ cursor: pointer;
467
+ font-size: 14px;
468
+ margin-right: 10px;
469
+ margin-bottom: 10px;
470
+ }}
471
+
472
+ .btn:hover {{
473
+ background: #0056b3;
474
+ }}
475
+
476
+ .btn:disabled {{
477
+ background: #6c757d;
478
+ cursor: not-allowed;
479
+ }}
480
+
481
+ .btn-secondary {{
482
+ background: #6c757d;
483
+ }}
484
+
485
+ .btn-secondary:hover {{
486
+ background: #545b62;
487
+ }}
488
+
489
+ .state-display {{
490
+ background: white;
491
+ border: 1px solid #e0e0e0;
492
+ border-radius: 8px;
493
+ padding: 15px;
494
+ margin-bottom: 20px;
495
+ }}
496
+
497
+ .state-item {{
498
+ margin-bottom: 8px;
499
+ }}
500
+
501
+ .state-label {{
502
+ font-weight: 500;
503
+ color: #666;
504
+ }}
505
+
506
+ .state-value {{
507
+ color: #333;
508
+ font-family: monospace;
509
+ }}
510
+
511
+ .logs-container {{
512
+ background: white;
513
+ border: 1px solid #e0e0e0;
514
+ border-radius: 8px;
515
+ padding: 15px;
516
+ max-height: 400px;
517
+ overflow-y: auto;
518
+ }}
519
+
520
+ .log-entry {{
521
+ border-bottom: 1px solid #f0f0f0;
522
+ padding: 10px 0;
523
+ }}
524
+
525
+ .log-entry:last-child {{
526
+ border-bottom: none;
527
+ }}
528
+
529
+ .log-timestamp {{
530
+ font-size: 12px;
531
+ color: #666;
532
+ margin-bottom: 5px;
533
+ }}
534
+
535
+ .log-action {{
536
+ background: #e3f2fd;
537
+ padding: 8px;
538
+ border-radius: 4px;
539
+ margin-bottom: 5px;
540
+ font-family: monospace;
541
+ font-size: 12px;
542
+ }}
543
+
544
+ .log-observation {{
545
+ background: #f3e5f5;
546
+ padding: 8px;
547
+ border-radius: 4px;
548
+ font-family: monospace;
549
+ font-size: 12px;
550
+ }}
551
+
552
+ .log-reward {{
553
+ font-weight: 600;
554
+ color: #28a745;
555
+ }}
556
+
557
+ .log-done {{
558
+ font-weight: 600;
559
+ color: #dc3545;
560
+ }}
561
+
562
+ .status-indicator {{
563
+ display: inline-block;
564
+ width: 8px;
565
+ height: 8px;
566
+ border-radius: 50%;
567
+ margin-right: 8px;
568
+ }}
569
+
570
+ .status-connected {{
571
+ background: #28a745;
572
+ }}
573
+
574
+ .status-disconnected {{
575
+ background: #dc3545;
576
+ }}
577
+
578
+ .json-display {{
579
+ background: #f8f9fa;
580
+ border: 1px solid #e9ecef;
581
+ border-radius: 4px;
582
+ padding: 10px;
583
+ font-family: monospace;
584
+ font-size: 12px;
585
+ white-space: pre-wrap;
586
+ max-height: 200px;
587
+ overflow-y: auto;
588
+ }}
589
+
590
+ /* Chat Interface Styles */
591
+ .chat-interface {{
592
+ background: white;
593
+ border: 1px solid #e0e0e0;
594
+ border-radius: 8px;
595
+ padding: 20px;
596
+ margin-bottom: 20px;
597
+ }}
598
+
599
+ .chat-messages {{
600
+ background: #f8f9fa;
601
+ border: 1px solid #e0e0e0;
602
+ border-radius: 8px;
603
+ padding: 15px;
604
+ margin-bottom: 15px;
605
+ max-height: 400px;
606
+ overflow-y: auto;
607
+ }}
608
+
609
+ .chat-message {{
610
+ margin-bottom: 15px;
611
+ padding: 10px;
612
+ border-radius: 8px;
613
+ }}
614
+
615
+ .chat-message:last-child {{
616
+ margin-bottom: 0;
617
+ }}
618
+
619
+ .chat-message.user {{
620
+ background: #e3f2fd;
621
+ margin-left: 20px;
622
+ }}
623
+
624
+ .chat-message.assistant {{
625
+ background: #f3e5f5;
626
+ margin-right: 20px;
627
+ }}
628
+
629
+ .chat-message.system {{
630
+ background: #e8f5e8;
631
+ font-style: italic;
632
+ }}
633
+
634
+ .message-role {{
635
+ font-weight: 600;
636
+ font-size: 12px;
637
+ color: #666;
638
+ margin-bottom: 5px;
639
+ }}
640
+
641
+ .message-content {{
642
+ font-size: 14px;
643
+ line-height: 1.4;
644
+ }}
645
+
646
+ .chat-input-container {{
647
+ border-top: 1px solid #e0e0e0;
648
+ padding-top: 15px;
649
+ }}
650
+
651
+ .role-selector {{
652
+ margin-bottom: 10px;
653
+ }}
654
+
655
+ .role-selector label {{
656
+ font-weight: 500;
657
+ margin-right: 10px;
658
+ }}
659
+
660
+ .role-selector select {{
661
+ padding: 5px 10px;
662
+ border: 1px solid #ddd;
663
+ border-radius: 4px;
664
+ }}
665
+
666
+ .message-input {{
667
+ display: flex;
668
+ gap: 10px;
669
+ align-items: flex-end;
670
+ }}
671
+
672
+ .message-input textarea {{
673
+ flex: 1;
674
+ padding: 10px;
675
+ border: 1px solid #ddd;
676
+ border-radius: 4px;
677
+ resize: vertical;
678
+ font-family: inherit;
679
+ }}
680
+
681
+ .message-input textarea:focus {{
682
+ outline: none;
683
+ border-color: #007bff;
684
+ box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
685
+ }}
686
+
687
+ /* Instructions Section Styles */
688
+ .instructions-section {{
689
+ background: white;
690
+ border: 1px solid #e0e0e0;
691
+ border-radius: 8px;
692
+ padding: 20px;
693
+ margin-bottom: 20px;
694
+ }}
695
+
696
+ .instructions-header {{
697
+ display: flex;
698
+ justify-content: space-between;
699
+ align-items: center;
700
+ margin-bottom: 15px;
701
+ }}
702
+
703
+ .instructions-title {{
704
+ font-size: 18px;
705
+ font-weight: 600;
706
+ color: #333;
707
+ margin: 0;
708
+ }}
709
+
710
+ .instructions-toggle {{
711
+ background: #f8f9fa;
712
+ border: 1px solid #dee2e6;
713
+ border-radius: 4px;
714
+ padding: 5px 10px;
715
+ cursor: pointer;
716
+ font-size: 12px;
717
+ color: #6c757d;
718
+ }}
719
+
720
+ .instructions-toggle:hover {{
721
+ background: #e9ecef;
722
+ }}
723
+
724
+ .instructions-content {{
725
+ display: none;
726
+ max-height: 400px;
727
+ overflow-y: auto;
728
+ border-top: 1px solid #e0e0e0;
729
+ padding-top: 15px;
730
+ }}
731
+
732
+ .instructions-content.expanded {{
733
+ display: block;
734
+ }}
735
+
736
+ .instructions-content h1,
737
+ .instructions-content h2,
738
+ .instructions-content h3 {{
739
+ color: #333;
740
+ margin-top: 20px;
741
+ margin-bottom: 10px;
742
+ }}
743
+
744
+ .instructions-content h1 {{
745
+ font-size: 24px;
746
+ border-bottom: 2px solid #007bff;
747
+ padding-bottom: 10px;
748
+ }}
749
+
750
+ .instructions-content h2 {{
751
+ font-size: 20px;
752
+ }}
753
+
754
+ .instructions-content h3 {{
755
+ font-size: 16px;
756
+ }}
757
+
758
+ .instructions-content p {{
759
+ margin-bottom: 10px;
760
+ line-height: 1.6;
761
+ }}
762
+
763
+ .instructions-content code {{
764
+ background: #f8f9fa;
765
+ padding: 2px 4px;
766
+ border-radius: 3px;
767
+ font-family: monospace;
768
+ font-size: 14px;
769
+ }}
770
+
771
+ .instructions-content pre {{
772
+ background: #f8f9fa;
773
+ border: 1px solid #e9ecef;
774
+ border-radius: 4px;
775
+ padding: 15px;
776
+ overflow-x: auto;
777
+ margin: 10px 0;
778
+ }}
779
+
780
+ .instructions-content pre code {{
781
+ background: none;
782
+ padding: 0;
783
+ }}
784
+
785
+ .instructions-content ul,
786
+ .instructions-content ol {{
787
+ margin: 10px 0;
788
+ padding-left: 20px;
789
+ }}
790
+
791
+ .instructions-content li {{
792
+ margin-bottom: 5px;
793
+ }}
794
+
795
+ .instructions-content table {{
796
+ border-collapse: collapse;
797
+ width: 100%;
798
+ margin: 15px 0;
799
+ }}
800
+
801
+ .instructions-content th,
802
+ .instructions-content td {{
803
+ border: 1px solid #dee2e6;
804
+ padding: 8px 12px;
805
+ text-align: left;
806
+ }}
807
+
808
+ .instructions-content th {{
809
+ background: #f8f9fa;
810
+ font-weight: 600;
811
+ }}
812
+
813
+ /* Enhanced Form Styles */
814
+ .help-text {{
815
+ display: block;
816
+ margin-top: 5px;
817
+ font-size: 12px;
818
+ color: #6c757d;
819
+ font-style: italic;
820
+ }}
821
+
822
+ .form-group label {{
823
+ font-weight: 500;
824
+ color: #333;
825
+ margin-bottom: 5px;
826
+ }}
827
+
828
+ .form-group select {{
829
+ width: 100%;
830
+ padding: 8px 12px;
831
+ border: 1px solid #ddd;
832
+ border-radius: 4px;
833
+ font-size: 14px;
834
+ background-color: white;
835
+ }}
836
+
837
+ .form-group select:focus {{
838
+ outline: none;
839
+ border-color: #007bff;
840
+ box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
841
+ }}
842
+
843
+ .form-group textarea {{
844
+ width: 100%;
845
+ padding: 8px 12px;
846
+ border: 1px solid #ddd;
847
+ border-radius: 4px;
848
+ font-size: 14px;
849
+ font-family: inherit;
850
+ resize: vertical;
851
+ }}
852
+
853
+ .form-group textarea:focus {{
854
+ outline: none;
855
+ border-color: #007bff;
856
+ box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
857
+ }}
858
+
859
+ .form-group input[type="number"] {{
860
+ width: 100%;
861
+ padding: 8px 12px;
862
+ border: 1px solid #ddd;
863
+ border-radius: 4px;
864
+ font-size: 14px;
865
+ }}
866
+
867
+ .form-group input[type="number"]:focus {{
868
+ outline: none;
869
+ border-color: #007bff;
870
+ box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
871
+ }}
872
+
873
+ .form-group input[type="text"]:focus {{
874
+ outline: none;
875
+ border-color: #007bff;
876
+ box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
877
+ }}
878
+
879
+ .required-indicator {{
880
+ color: #dc3545;
881
+ font-weight: bold;
882
+ }}
883
+
884
+ .form-group .field-description {{
885
+ font-size: 11px;
886
+ color: #666;
887
+ margin-top: 2px;
888
+ font-style: italic;
889
+ }}
890
+ </style>
891
+ </head>
892
+ <body>
893
+ <div class="container">
894
+ <!-- Left Pane: HumanAgent Interface -->
895
+ <div class="left-pane">
896
+ <div class="pane-header">
897
+ <span class="status-indicator status-disconnected" id="connection-status"></span>
898
+ HumanAgent Interface
899
+ </div>
900
+ <div class="pane-content">
901
+ <!-- Instructions Section -->
902
+ {_generate_instructions_section(metadata)}
903
+
904
+ <!-- Action Form or Chat Interface -->
905
+ {_generate_action_interface(action_fields, is_chat_env)}
906
+
907
+ <!-- Control Buttons -->
908
+ <div style="margin-bottom: 20px;">
909
+ <button class="btn btn-secondary" id="reset-btn">Reset Environment</button>
910
+ <button class="btn btn-secondary" id="state-btn">Get State</button>
911
+ </div>
912
+
913
+ <!-- Current State Display -->
914
+ <div class="state-display">
915
+ <h3>Current State</h3>
916
+ <div id="current-state">
917
+ <div class="state-item">
918
+ <span class="state-label">Status:</span>
919
+ <span class="state-value" id="env-status">Not initialized</span>
920
+ </div>
921
+ <div class="state-item">
922
+ <span class="state-label">Episode ID:</span>
923
+ <span class="state-value" id="episode-id">-</span>
924
+ </div>
925
+ <div class="state-item">
926
+ <span class="state-label">Step Count:</span>
927
+ <span class="state-value" id="step-count">0</span>
928
+ </div>
929
+ </div>
930
+ </div>
931
+ </div>
932
+ </div>
933
+
934
+ <!-- Right Pane: State Observer -->
935
+ <div class="right-pane">
936
+ <div class="pane-header">
937
+ State Observer
938
+ </div>
939
+ <div class="pane-content">
940
+ <!-- Current Observation -->
941
+ <div class="state-display">
942
+ <h3>Current Observation</h3>
943
+ <div id="current-observation" class="json-display">
944
+ No observation yet
945
+ </div>
946
+ </div>
947
+
948
+ <!-- Action Logs -->
949
+ <div class="logs-container">
950
+ <h3>Action History</h3>
951
+ <div id="action-logs">
952
+ No actions taken yet
953
+ </div>
954
+ </div>
955
+ </div>
956
+ </div>
957
+ </div>
958
+
959
+ <script>
960
+ class OpenEnvWebInterface {{
961
+ constructor() {{
962
+ this.ws = null;
963
+ this.isConnected = false;
964
+ this.init();
965
+ }}
966
+
967
+ init() {{
968
+ this.connectWebSocket();
969
+ this.setupEventListeners();
970
+ }}
971
+
972
+ connectWebSocket() {{
973
+ const protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
974
+ const wsUrl = `${{protocol}}//${{window.location.host}}/ws`;
975
+
976
+ this.ws = new WebSocket(wsUrl);
977
+
978
+ this.ws.onopen = () => {{
979
+ this.isConnected = true;
980
+ this.updateConnectionStatus(true);
981
+ console.log('WebSocket connected');
982
+ }};
983
+
984
+ this.ws.onmessage = (event) => {{
985
+ const data = JSON.parse(event.data);
986
+ if (data.type === 'state_update') {{
987
+ this.updateUI(data.episode_state);
988
+ }}
989
+ }};
990
+
991
+ this.ws.onclose = () => {{
992
+ this.isConnected = false;
993
+ this.updateConnectionStatus(false);
994
+ console.log('WebSocket disconnected');
995
+ // Attempt to reconnect after 3 seconds
996
+ setTimeout(() => this.connectWebSocket(), 3000);
997
+ }};
998
+
999
+ this.ws.onerror = (error) => {{
1000
+ console.error('WebSocket error:', error);
1001
+ }};
1002
+ }}
1003
+
1004
+ setupEventListeners() {{
1005
+ // Instructions toggle
1006
+ const instructionsToggle = document.getElementById('instructions-toggle');
1007
+ const instructionsContent = document.getElementById('instructions-content');
1008
+ if (instructionsToggle && instructionsContent) {{
1009
+ instructionsToggle.addEventListener('click', () => {{
1010
+ instructionsContent.classList.toggle('expanded');
1011
+ instructionsToggle.textContent = instructionsContent.classList.contains('expanded')
1012
+ ? 'Hide Instructions' : 'Show Instructions';
1013
+ }});
1014
+ }}
1015
+
1016
+ // Check if this is a chat environment
1017
+ const isChatEnv = document.getElementById('chat-messages') !== null;
1018
+
1019
+ if (isChatEnv) {{
1020
+ // Chat environment event listeners
1021
+ document.getElementById('send-message-btn').addEventListener('click', () => {{
1022
+ this.sendMessage();
1023
+ }});
1024
+
1025
+ // Send message on Enter (but allow Shift+Enter for new lines)
1026
+ document.getElementById('message-input').addEventListener('keydown', (e) => {{
1027
+ if (e.key === 'Enter' && !e.shiftKey) {{
1028
+ e.preventDefault();
1029
+ this.sendMessage();
1030
+ }}
1031
+ }});
1032
+ }} else {{
1033
+ // Traditional action form submission
1034
+ const actionForm = document.getElementById('action-form');
1035
+ if (actionForm) {{
1036
+ actionForm.addEventListener('submit', (e) => {{
1037
+ e.preventDefault();
1038
+ this.submitAction();
1039
+ }});
1040
+ }}
1041
+ }}
1042
+
1043
+ // Reset button
1044
+ document.getElementById('reset-btn').addEventListener('click', () => {{
1045
+ this.resetEnvironment();
1046
+ }});
1047
+
1048
+ // State button
1049
+ document.getElementById('state-btn').addEventListener('click', () => {{
1050
+ this.getState();
1051
+ }});
1052
+ }}
1053
+
1054
+ async sendMessage() {{
1055
+ const messageInput = document.getElementById('message-input');
1056
+ const roleSelect = document.getElementById('message-role');
1057
+ const message = messageInput.value.trim();
1058
+ const role = roleSelect.value;
1059
+
1060
+ if (!message) {{
1061
+ return;
1062
+ }}
1063
+
1064
+ // Add message to chat display immediately
1065
+ this.addMessageToChat(role, message);
1066
+
1067
+ // Clear input
1068
+ messageInput.value = '';
1069
+
1070
+ try {{
1071
+ // Send message to server to convert to action and step
1072
+ const response = await fetch('/web/step', {{
1073
+ method: 'POST',
1074
+ headers: {{ 'Content-Type': 'application/json' }},
1075
+ body: JSON.stringify({{
1076
+ message: {{
1077
+ role: role,
1078
+ content: message
1079
+ }}
1080
+ }})
1081
+ }});
1082
+
1083
+ if (!response.ok) {{
1084
+ throw new Error(`HTTP error! status: ${{response.status}}`);
1085
+ }}
1086
+
1087
+ const result = await response.json();
1088
+ console.log('Message sent:', result);
1089
+ }} catch (error) {{
1090
+ console.error('Error sending message:', error);
1091
+ alert('Error sending message: ' + error.message);
1092
+ }}
1093
+ }}
1094
+
1095
+ addMessageToChat(role, content) {{
1096
+ const chatMessages = document.getElementById('chat-messages');
1097
+ const messageDiv = document.createElement('div');
1098
+ messageDiv.className = `chat-message ${{role}}`;
1099
+
1100
+ messageDiv.innerHTML = `
1101
+ <div class="message-role">${{role.charAt(0).toUpperCase() + role.slice(1)}}</div>
1102
+ <div class="message-content">${{content}}</div>
1103
+ `;
1104
+
1105
+ chatMessages.appendChild(messageDiv);
1106
+ chatMessages.scrollTop = chatMessages.scrollHeight;
1107
+ }}
1108
+
1109
+ async submitAction() {{
1110
+ const formData = new FormData(document.getElementById('action-form'));
1111
+ const action = {{}};
1112
+
1113
+ // Collect form data
1114
+ for (const [key, value] of formData.entries()) {{
1115
+ if (value !== '') {{
1116
+ // Handle tensor fields (tokens) - convert comma-separated string to array
1117
+ if (key === 'tokens') {{
1118
+ try {{
1119
+ action[key] = value.split(',').map(x => parseInt(x.trim())).filter(x => !isNaN(x));
1120
+ }} catch (e) {{
1121
+ console.error('Error parsing tokens:', e);
1122
+ action[key] = [];
1123
+ }}
1124
+ }} else {{
1125
+ action[key] = value;
1126
+ }}
1127
+ }}
1128
+ }}
1129
+
1130
+ try {{
1131
+ const response = await fetch('/web/step', {{
1132
+ method: 'POST',
1133
+ headers: {{ 'Content-Type': 'application/json' }},
1134
+ body: JSON.stringify({{ action }})
1135
+ }});
1136
+
1137
+ if (!response.ok) {{
1138
+ throw new Error(`HTTP error! status: ${{response.status}}`);
1139
+ }}
1140
+
1141
+ const result = await response.json();
1142
+ console.log('Step result:', result);
1143
+ }} catch (error) {{
1144
+ console.error('Error submitting action:', error);
1145
+ alert('Error submitting action: ' + error.message);
1146
+ }}
1147
+ }}
1148
+
1149
+ async resetEnvironment() {{
1150
+ try {{
1151
+ const response = await fetch('/web/reset', {{
1152
+ method: 'POST',
1153
+ headers: {{ 'Content-Type': 'application/json' }}
1154
+ }});
1155
+
1156
+ if (!response.ok) {{
1157
+ throw new Error(`HTTP error! status: ${{response.status}}`);
1158
+ }}
1159
+
1160
+ const result = await response.json();
1161
+ console.log('Reset result:', result);
1162
+ }} catch (error) {{
1163
+ console.error('Error resetting environment:', error);
1164
+ alert('Error resetting environment: ' + error.message);
1165
+ }}
1166
+ }}
1167
+
1168
+ async getState() {{
1169
+ try {{
1170
+ const response = await fetch('/web/state');
1171
+ const state = await response.json();
1172
+ console.log('Current state:', state);
1173
+ alert('Current state: ' + JSON.stringify(state, null, 2));
1174
+ }} catch (error) {{
1175
+ console.error('Error getting state:', error);
1176
+ alert('Error getting state: ' + error.message);
1177
+ }}
1178
+ }}
1179
+
1180
+ updateConnectionStatus(connected) {{
1181
+ const indicator = document.getElementById('connection-status');
1182
+ if (connected) {{
1183
+ indicator.className = 'status-indicator status-connected';
1184
+ }} else {{
1185
+ indicator.className = 'status-indicator status-disconnected';
1186
+ }}
1187
+ }}
1188
+
1189
+ updateUI(episodeState) {{
1190
+ // Check if this is a chat environment
1191
+ const isChatEnv = document.getElementById('chat-messages') !== null;
1192
+
1193
+ // Update current state
1194
+ document.getElementById('env-status').textContent =
1195
+ episodeState.is_reset ? 'Reset' : 'Running';
1196
+ document.getElementById('episode-id').textContent =
1197
+ episodeState.episode_id || '-';
1198
+ document.getElementById('step-count').textContent =
1199
+ episodeState.step_count.toString();
1200
+
1201
+ if (isChatEnv) {{
1202
+ // Update chat interface
1203
+ this.updateChatInterface(episodeState);
1204
+ }} else {{
1205
+ // Update traditional observation display
1206
+ const observationDiv = document.getElementById('current-observation');
1207
+ if (episodeState.current_observation) {{
1208
+ observationDiv.textContent = JSON.stringify(
1209
+ episodeState.current_observation, null, 2
1210
+ );
1211
+ }} else {{
1212
+ observationDiv.textContent = 'No observation yet';
1213
+ }}
1214
+ }}
1215
+
1216
+ // Update action logs
1217
+ const logsDiv = document.getElementById('action-logs');
1218
+ if (episodeState.action_logs.length === 0) {{
1219
+ logsDiv.innerHTML = 'No actions taken yet';
1220
+ }} else {{
1221
+ logsDiv.innerHTML = episodeState.action_logs.map(log => `
1222
+ <div class="log-entry">
1223
+ <div class="log-timestamp">${{log.timestamp}} (Step ${{log.step_count}})</div>
1224
+ <div class="log-action">Action: ${{JSON.stringify(log.action, null, 2)}}</div>
1225
+ <div class="log-observation">Observation: ${{JSON.stringify(log.observation, null, 2)}}</div>
1226
+ <div>
1227
+ <span class="log-reward">Reward: ${{log.reward !== null ? log.reward : 'None'}}</span>
1228
+ ${{log.done ? '<span class="log-done">DONE</span>' : ''}}
1229
+ </div>
1230
+ </div>
1231
+ `).join('');
1232
+ }}
1233
+ }}
1234
+
1235
+ updateChatInterface(episodeState) {{
1236
+ const chatMessages = document.getElementById('chat-messages');
1237
+ if (!chatMessages) return;
1238
+
1239
+ // Clear existing messages (except system message)
1240
+ const systemMessage = chatMessages.querySelector('.chat-message.system');
1241
+ chatMessages.innerHTML = '';
1242
+ if (systemMessage) {{
1243
+ chatMessages.appendChild(systemMessage);
1244
+ }}
1245
+
1246
+ // Add messages from current observation
1247
+ if (episodeState.current_observation && episodeState.current_observation.messages) {{
1248
+ episodeState.current_observation.messages.forEach(msg => {{
1249
+ this.addMessageToChat(msg.role, msg.content);
1250
+ }});
1251
+ }}
1252
+ }}
1253
+ }}
1254
+
1255
+ // Initialize the web interface when the page loads
1256
+ document.addEventListener('DOMContentLoaded', () => {{
1257
+ new OpenEnvWebInterface();
1258
+ }});
1259
+ </script>
1260
+ </body>
1261
+ </html>
1262
+ """.replace('{_generate_action_form_fields(action_fields)}', _generate_action_form_fields(action_fields))
1263
+
1264
+
1265
+ def _generate_instructions_section(metadata: Optional[EnvironmentMetadata]) -> str:
1266
+ """Generate the instructions section with environment documentation."""
1267
+ if not metadata or not metadata.readme_content:
1268
+ return ''
1269
+
1270
+ # Convert markdown to HTML (basic conversion)
1271
+ import re
1272
+ html_content = _markdown_to_html(metadata.readme_content)
1273
+
1274
+ return f'''
1275
+ <!-- Instructions Section -->
1276
+ <div class="instructions-section">
1277
+ <div class="instructions-header">
1278
+ <h3 class="instructions-title">{metadata.name}</h3>
1279
+ <button class="instructions-toggle" id="instructions-toggle">Show Instructions</button>
1280
+ </div>
1281
+ <div class="instructions-content" id="instructions-content">
1282
+ <div class="instructions-readme">
1283
+ {html_content}
1284
+ </div>
1285
+ </div>
1286
+ </div>
1287
+ '''
1288
+
1289
+
1290
+ def _extract_action_fields(action_cls: Type[Action]) -> List[Dict[str, Any]]:
1291
+ """Extract enhanced field metadata from Action class for form generation."""
1292
+ import typing
1293
+ from typing import get_origin, get_args
1294
+
1295
+ action_fields = []
1296
+ if not hasattr(action_cls, '__dataclass_fields__'):
1297
+ return action_fields
1298
+
1299
+ for field_name, field_info in action_cls.__dataclass_fields__.items():
1300
+ if field_name == 'metadata':
1301
+ continue
1302
+
1303
+ field_type = field_info.type
1304
+ field_metadata = _extract_field_metadata(field_name, field_info)
1305
+
1306
+ # Determine input type based on field type
1307
+ input_type = _determine_input_type(field_type)
1308
+
1309
+ # Check if field is required
1310
+ is_required = field_info.default is field_info.default_factory
1311
+
1312
+ action_fields.append({
1313
+ 'name': field_name,
1314
+ 'type': input_type,
1315
+ 'required': is_required,
1316
+ 'description': field_metadata.get('description', ''),
1317
+ 'default_value': field_metadata.get('default_value'),
1318
+ 'choices': field_metadata.get('choices', []),
1319
+ 'min_value': field_metadata.get('min_value'),
1320
+ 'max_value': field_metadata.get('max_value'),
1321
+ 'placeholder': field_metadata.get('placeholder', ''),
1322
+ 'help_text': field_metadata.get('help_text', ''),
1323
+ })
1324
+
1325
+ return action_fields
1326
+
1327
+
1328
+ def _extract_field_metadata(field_name: str, field_info) -> Dict[str, Any]:
1329
+ """Extract metadata from dataclass field including docstring and type hints."""
1330
+ import typing
1331
+ from typing import get_origin, get_args, Literal, Union, Optional
1332
+
1333
+ metadata = {}
1334
+
1335
+ # Extract description from field docstring or annotation
1336
+ if hasattr(field_info, 'metadata') and field_info.metadata:
1337
+ # Check for custom metadata
1338
+ for meta in field_info.metadata:
1339
+ if isinstance(meta, dict):
1340
+ metadata.update(meta)
1341
+
1342
+ # Extract type information
1343
+ field_type = field_info.type
1344
+ origin = get_origin(field_type)
1345
+
1346
+ # Handle Literal types for dropdown choices
1347
+ if origin is Literal:
1348
+ args = get_args(field_type)
1349
+ metadata['choices'] = list(args)
1350
+
1351
+ # Handle Optional types
1352
+ if origin is Union:
1353
+ args = get_args(field_type)
1354
+ if len(args) == 2 and type(None) in args:
1355
+ # This is Optional[SomeType]
1356
+ non_none_type = args[0] if args[1] is type(None) else args[1]
1357
+ metadata['optional'] = True
1358
+ # Recursively check the non-None type for choices
1359
+ if get_origin(non_none_type) is Literal:
1360
+ metadata['choices'] = list(get_args(non_none_type))
1361
+ else:
1362
+ # Regular Union type
1363
+ metadata['choices'] = [str(arg) for arg in args if arg is not type(None)]
1364
+
1365
+ # Handle numeric constraints
1366
+ if field_type in (int, float):
1367
+ # Check for common constraint patterns in field name
1368
+ if 'count' in field_name.lower() or 'num' in field_name.lower():
1369
+ metadata['min_value'] = 0
1370
+ if 'id' in field_name.lower():
1371
+ metadata['min_value'] = 0
1372
+
1373
+ # Generate placeholder text
1374
+ if 'message' in field_name.lower():
1375
+ metadata['placeholder'] = f'Enter {field_name.replace("_", " ")}...'
1376
+ elif 'code' in field_name.lower():
1377
+ metadata['placeholder'] = 'Enter Python code here...'
1378
+ elif 'tokens' in field_name.lower():
1379
+ metadata['placeholder'] = 'Enter comma-separated token IDs (e.g., 1,2,3,4,5)'
1380
+ else:
1381
+ metadata['placeholder'] = f'Enter {field_name.replace("_", " ")}...'
1382
+
1383
+ # Generate help text based on field name and type
1384
+ if 'action_id' in field_name.lower():
1385
+ metadata['help_text'] = 'The action ID to execute in the environment'
1386
+ elif 'game_name' in field_name.lower():
1387
+ metadata['help_text'] = 'Name of the game or environment'
1388
+ elif 'tokens' in field_name.lower():
1389
+ metadata['help_text'] = 'Token IDs as a comma-separated list of integers'
1390
+ elif 'code' in field_name.lower():
1391
+ metadata['help_text'] = 'Python code to execute in the environment'
1392
+ elif 'message' in field_name.lower():
1393
+ metadata['help_text'] = 'Text message to send'
1394
+
1395
+ return metadata
1396
+
1397
+
1398
+ def _determine_input_type(field_type) -> str:
1399
+ """Determine the appropriate HTML input type for a field type."""
1400
+ import typing
1401
+ from typing import get_origin, get_args, Literal, Union
1402
+
1403
+ # Handle direct types
1404
+ if field_type == str:
1405
+ return "text"
1406
+ elif field_type == int:
1407
+ return "number"
1408
+ elif field_type == float:
1409
+ return "number"
1410
+ elif field_type == bool:
1411
+ return "checkbox"
1412
+
1413
+ # Handle complex types
1414
+ origin = get_origin(field_type)
1415
+
1416
+ if origin is Literal:
1417
+ return "select"
1418
+ elif origin is Union:
1419
+ args = get_args(field_type)
1420
+ if len(args) == 2 and type(None) in args:
1421
+ # Optional type - use the non-None type
1422
+ non_none_type = args[0] if args[1] is type(None) else args[1]
1423
+ return _determine_input_type(non_none_type)
1424
+ elif all(isinstance(arg, str) for arg in args if arg is not type(None)):
1425
+ return "select"
1426
+ else:
1427
+ return "text"
1428
+ elif hasattr(field_type, '__name__') and 'Tensor' in field_type.__name__:
1429
+ return "tensor"
1430
+ else:
1431
+ return "text"
1432
+
1433
+
1434
+ def _markdown_to_html(markdown: str) -> str:
1435
+ """Convert basic markdown to HTML for README display."""
1436
+ import html
1437
+ import re
1438
+
1439
+ # Escape HTML first
1440
+ html_content = html.escape(markdown)
1441
+
1442
+ # Convert headers
1443
+ html_content = re.sub(r'^# (.*?)$', r'<h1>\1</h1>', html_content, flags=re.MULTILINE)
1444
+ html_content = re.sub(r'^## (.*?)$', r'<h2>\1</h2>', html_content, flags=re.MULTILINE)
1445
+ html_content = re.sub(r'^### (.*?)$', r'<h3>\1</h3>', html_content, flags=re.MULTILINE)
1446
+
1447
+ # Convert code blocks
1448
+ html_content = re.sub(r'```(.*?)\n(.*?)\n```', r'<pre><code>\2</code></pre>', html_content, flags=re.DOTALL)
1449
+ html_content = re.sub(r'`([^`]+)`', r'<code>\1</code>', html_content)
1450
+
1451
+ # Convert bold and italic
1452
+ html_content = re.sub(r'\*\*(.*?)\*\*', r'<strong>\1</strong>', html_content)
1453
+ html_content = re.sub(r'\*(.*?)\*', r'<em>\1</em>', html_content)
1454
+
1455
+ # Convert lists
1456
+ html_content = re.sub(r'^- (.*?)$', r'<li>\1</li>', html_content, flags=re.MULTILINE)
1457
+ html_content = re.sub(r'(<li>.*</li>)', r'<ul>\1</ul>', html_content, flags=re.DOTALL)
1458
+
1459
+ # Convert line breaks
1460
+ html_content = html_content.replace('\n', '<br>')
1461
+
1462
+ return html_content
1463
+
1464
+
1465
+ def _generate_action_interface(action_fields: List[Dict[str, Any]], is_chat_env: bool) -> str:
1466
+ """Generate either a chat interface or action form based on environment type."""
1467
+ if is_chat_env:
1468
+ return _generate_chat_interface()
1469
+ else:
1470
+ return _generate_action_form(action_fields)
1471
+
1472
+ def _generate_chat_interface() -> str:
1473
+ """Generate a chat-style interface for chat environments."""
1474
+ return '''
1475
+ <!-- Chat Interface -->
1476
+ <div class="chat-interface">
1477
+ <h3>Chat Interface</h3>
1478
+ <div class="chat-messages" id="chat-messages">
1479
+ <div class="chat-message system">
1480
+ <div class="message-role">System</div>
1481
+ <div class="message-content">Chat environment ready. Send a message to start the conversation.</div>
1482
+ </div>
1483
+ </div>
1484
+ <div class="chat-input-container">
1485
+ <div class="role-selector">
1486
+ <label for="message-role">Role:</label>
1487
+ <select id="message-role">
1488
+ <option value="user">User</option>
1489
+ <option value="assistant">Assistant</option>
1490
+ </select>
1491
+ </div>
1492
+ <div class="message-input">
1493
+ <textarea id="message-input" placeholder="Type your message here..." rows="3"></textarea>
1494
+ <button class="btn" id="send-message-btn">Send Message</button>
1495
+ </div>
1496
+ </div>
1497
+ </div>
1498
+ '''
1499
+
1500
+ def _generate_action_form(action_fields: List[Dict[str, Any]]) -> str:
1501
+ """Generate a traditional action form for non-chat environments."""
1502
+ return f'''
1503
+ <!-- Action Form -->
1504
+ <div class="action-form">
1505
+ <h3>Take Action</h3>
1506
+ <form id="action-form">
1507
+ {_generate_action_form_fields(action_fields)}
1508
+ <button type="submit" class="btn" id="step-btn">Step</button>
1509
+ </form>
1510
+ </div>
1511
+ '''
1512
+
1513
+ def _generate_action_form_fields(action_fields: List[Dict[str, Any]]) -> str:
1514
+ """Generate HTML form fields for action input with enhanced metadata."""
1515
+ if not action_fields:
1516
+ return '<p>No action fields available</p>'
1517
+
1518
+ fields_html = []
1519
+ for field in action_fields:
1520
+ field_html = _generate_single_field(field)
1521
+ fields_html.append(field_html)
1522
+
1523
+ return '\n'.join(fields_html)
1524
+
1525
+
1526
+ def _generate_single_field(field: Dict[str, Any]) -> str:
1527
+ """Generate HTML for a single form field with enhanced metadata."""
1528
+ field_name = field['name']
1529
+ field_type = field['type']
1530
+ required = field['required']
1531
+ placeholder = field.get('placeholder', '')
1532
+ help_text = field.get('help_text', '')
1533
+ choices = field.get('choices', [])
1534
+ min_value = field.get('min_value')
1535
+ max_value = field.get('max_value')
1536
+ default_value = field.get('default_value')
1537
+
1538
+ # Build label with required indicator
1539
+ label_text = field_name.replace('_', ' ').title()
1540
+ if required:
1541
+ label_text += ' <span style="color: red;">*</span>'
1542
+
1543
+ # Build input attributes
1544
+ input_attrs = []
1545
+ if required:
1546
+ input_attrs.append('required')
1547
+ if placeholder:
1548
+ input_attrs.append(f'placeholder="{placeholder}"')
1549
+ if min_value is not None:
1550
+ input_attrs.append(f'min="{min_value}"')
1551
+ if max_value is not None:
1552
+ input_attrs.append(f'max="{max_value}"')
1553
+ if default_value is not None:
1554
+ input_attrs.append(f'value="{default_value}"')
1555
+
1556
+ attrs_str = ' '.join(input_attrs)
1557
+
1558
+ if field_type == 'checkbox':
1559
+ return f'''
1560
+ <div class="form-group">
1561
+ <label>
1562
+ <input type="checkbox" name="{field_name}" value="true" {attrs_str}>
1563
+ {label_text}
1564
+ </label>
1565
+ {f'<small class="help-text">{help_text}</small>' if help_text else ''}
1566
+ </div>
1567
+ '''
1568
+
1569
+ elif field_type == 'select':
1570
+ options_html = []
1571
+ if not required:
1572
+ options_html.append(f'<option value="">-- Select {label_text} --</option>')
1573
+
1574
+ for choice in choices:
1575
+ selected = 'selected' if str(choice) == str(default_value) else ''
1576
+ options_html.append(f'<option value="{choice}" {selected}>{choice}</option>')
1577
+
1578
+ return f'''
1579
+ <div class="form-group">
1580
+ <label for="{field_name}">{label_text}:</label>
1581
+ <select name="{field_name}" id="{field_name}" {attrs_str}>
1582
+ {''.join(options_html)}
1583
+ </select>
1584
+ {f'<small class="help-text">{help_text}</small>' if help_text else ''}
1585
+ </div>
1586
+ '''
1587
+
1588
+ elif field_type == 'tensor':
1589
+ return f'''
1590
+ <div class="form-group">
1591
+ <label for="{field_name}">{label_text} (comma-separated integers):</label>
1592
+ <input type="text" name="{field_name}" id="{field_name}" {attrs_str}>
1593
+ <small class="help-text">{help_text or 'Enter token IDs as comma-separated integers (e.g., 1,2,3,4,5)'}</small>
1594
+ </div>
1595
+ '''
1596
+
1597
+ elif field_type == 'text' and ('message' in field_name.lower() or 'code' in field_name.lower()):
1598
+ return f'''
1599
+ <div class="form-group">
1600
+ <label for="{field_name}">{label_text}:</label>
1601
+ <textarea name="{field_name}" id="{field_name}" rows="3" {attrs_str}></textarea>
1602
+ {f'<small class="help-text">{help_text}</small>' if help_text else ''}
1603
+ </div>
1604
+ '''
1605
+
1606
+ else:
1607
+ return f'''
1608
+ <div class="form-group">
1609
+ <label for="{field_name}">{label_text}:</label>
1610
+ <input type="{field_type}" name="{field_name}" id="{field_name}" {attrs_str}>
1611
+ {f'<small class="help-text">{help_text}</small>' if help_text else ''}
1612
+ </div>
1613
+ '''
src/core/core/http_env_client.py ADDED
@@ -0,0 +1,185 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ """
2
+ core/runner_env.py
3
+ Minimal HTTP-based environment client.
4
+ - Talks to a single env worker exposing: POST /reset, POST /step
5
+
6
+ Future hooks (commented below) for:
7
+ - episode_id, seed on reset
8
+ - request_id on step
9
+ - custom headers (auth/trace)
10
+ """
11
+
12
+ from __future__ import annotations
13
+
14
+ from abc import ABC, abstractmethod
15
+ from typing import Any, Dict, Generic, Optional, Type, TYPE_CHECKING, TypeVar
16
+
17
+ import requests
18
+
19
+ from .client_types import StepResult
20
+ from .containers.runtime import LocalDockerProvider
21
+
22
+ if TYPE_CHECKING:
23
+ from .containers.runtime import ContainerProvider
24
+
25
+ ActT = TypeVar("ActT")
26
+ ObsT = TypeVar("ObsT")
27
+ EnvClientT = TypeVar("EnvClientT", bound="HTTPEnvClient")
28
+
29
+
30
+ class HTTPEnvClient(ABC, Generic[ActT, ObsT]):
31
+ def __init__(
32
+ self,
33
+ base_url: str,
34
+ request_timeout_s: float = 15.0,
35
+ default_headers: Optional[Dict[str, str]] = None,
36
+ provider: Optional["ContainerProvider"] = None,
37
+ ):
38
+ self._base = base_url.rstrip("/")
39
+ self._timeout = float(request_timeout_s)
40
+ self._http = requests.Session()
41
+ self._headers = default_headers or {}
42
+ self._provider = provider
43
+
44
+ @classmethod
45
+ def from_docker_image(
46
+ cls: Type[EnvClientT],
47
+ image: str,
48
+ provider: Optional["ContainerProvider"] = None,
49
+ **kwargs: Any,
50
+ ) -> EnvClientT:
51
+ """
52
+ Create an environment client by spinning up a Docker container locally.
53
+
54
+ This is a development utility that:
55
+ 1. Starts a Docker container from the specified image
56
+ 2. Waits for the server to be ready
57
+ 3. Creates and returns a client instance connected to the container
58
+
59
+ Note: The container lifecycle management is left to the user or higher-level
60
+ orchestration. The container will keep running until manually stopped.
61
+
62
+ Args:
63
+ image: Docker image name to run (e.g., "echo-env:latest")
64
+ provider: Container provider to use (defaults to LocalDockerProvider)
65
+ **kwargs: Additional arguments to pass to provider.start_container()
66
+ (e.g., env_vars, port)
67
+
68
+ Returns:
69
+ An instance of the client class connected to the running container
70
+
71
+ Example:
72
+ >>> from envs.coding_env.client import CodingEnv
73
+ >>> from envs.coding_env.models import CodeAction
74
+ >>>
75
+ >>> # Create environment from image
76
+ >>> env = CodingEnv.from_docker_image("coding-env:latest")
77
+ >>>
78
+ >>> # Create environment with custom env vars
79
+ >>> env = CodingEnv.from_docker_image(
80
+ ... "coding-env:latest",
81
+ ... env_vars={"MY_VAR": "value"}
82
+ ... )
83
+ >>>
84
+ >>> # Use the environment
85
+ >>> result = env.reset()
86
+ >>> print(result.observation)
87
+ >>>
88
+ >>> step_result = env.step(CodeAction(code="print('hello')"))
89
+ >>> print(step_result.observation.stdout)
90
+ >>>
91
+ >>> # Cleanup (optional)
92
+ >>> env.close()
93
+ """
94
+
95
+ # Use default provider if none provided
96
+ if provider is None:
97
+ provider = LocalDockerProvider()
98
+
99
+ # 1. Start container with optional kwargs (e.g., env_vars, port)
100
+ base_url = provider.start_container(image, **kwargs)
101
+
102
+ # 2. Wait for server to be ready
103
+ provider.wait_for_ready(base_url)
104
+
105
+ # 3. Create and return client instance with provider reference
106
+ return cls(base_url=base_url, provider=provider)
107
+
108
+ @abstractmethod
109
+ def _step_payload(self, action: ActT) -> dict:
110
+ """Convert an Action object to the JSON body expected by the env server."""
111
+ raise NotImplementedError
112
+
113
+ @abstractmethod
114
+ def _parse_result(self, payload: dict) -> StepResult[ObsT]:
115
+ """Convert a JSON response from the env server to StepResult[ObsT]."""
116
+ raise NotImplementedError
117
+
118
+ @abstractmethod
119
+ def _parse_state(self, payload: dict) -> Any:
120
+ """Convert a JSON response from the state endpoint to a State object."""
121
+ raise NotImplementedError
122
+
123
+ # ---------- Environment Server Interface Methods ----------
124
+ def reset(self) -> StepResult[ObsT]:
125
+ body: Dict[str, Any] = {}
126
+ # TODO: later:
127
+ # body["seed"] = seed
128
+ # body["episode_id"] = episode_id
129
+ r = self._http.post(
130
+ f"{self._base}/reset",
131
+ json=body,
132
+ headers=self._headers,
133
+ timeout=self._timeout,
134
+ )
135
+ r.raise_for_status()
136
+ return self._parse_result(r.json())
137
+
138
+ def step(self, action: ActT) -> StepResult[ObsT]:
139
+ body: Dict[str, Any] = {
140
+ "action": self._step_payload(action),
141
+ "timeout_s": int(self._timeout),
142
+ }
143
+ # TODO: later:
144
+ # body["request_id"] = str(uuid.uuid4())
145
+ # body["episode_id"] = current_episode_id
146
+ r = self._http.post(
147
+ f"{self._base}/step",
148
+ json=body,
149
+ headers=self._headers,
150
+ timeout=self._timeout,
151
+ )
152
+ r.raise_for_status()
153
+ return self._parse_result(r.json())
154
+
155
+ def state(self) -> Any:
156
+ """
157
+ Get the current environment state from the server.
158
+
159
+ Returns:
160
+ State object with environment state information (e.g., episode_id, step_count)
161
+
162
+ Example:
163
+ >>> client = EchoEnv.from_docker_image("echo-env:latest")
164
+ >>> result = client.reset()
165
+ >>> state = client.state()
166
+ >>> print(state.episode_id)
167
+ >>> print(state.step_count)
168
+ """
169
+ r = self._http.get(
170
+ f"{self._base}/state",
171
+ headers=self._headers,
172
+ timeout=self._timeout,
173
+ )
174
+ r.raise_for_status()
175
+ return self._parse_state(r.json())
176
+
177
+ def close(self) -> None:
178
+ """
179
+ Close the environment and clean up resources.
180
+
181
+ If this client was created via from_docker_image(), this will stop
182
+ and remove the associated container.
183
+ """
184
+ if self._provider is not None:
185
+ self._provider.stop_container()
src/core/core/pyproject.toml ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [build-system]
2
+ requires = ["setuptools>=45", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "openenv-core"
7
+ version = "0.1.0"
8
+ description = "Core components for OpenEnv - HTTP-based agentic environments"
9
+ readme = "README.md"
10
+ requires-python = ">=3.8"
11
+ license = {text = "BSD-3-Clause"}
12
+ authors = [
13
+ {name = "Meta Platforms, Inc.", email = "opensource@meta.com"}
14
+ ]
15
+ keywords = ["environment", "agent", "http", "docker", "fastapi"]
16
+
17
+ dependencies = [
18
+ "requests>=2.25.0",
19
+ "fastapi>=0.104.0",
20
+ "uvicorn>=0.24.0",
21
+ ]
22
+
23
+ [project.optional-dependencies]
24
+ dev = [
25
+ "pytest>=7.0.0",
26
+ "black>=23.0.0",
27
+ "ruff>=0.1.0",
28
+ "mypy>=1.0.0",
29
+ ]
30
+
31
+ [project.urls]
32
+ Homepage = "https://github.com/facebookresearch/OpenEnv"
33
+ Repository = "https://github.com/facebookresearch/OpenEnv"
34
+ Documentation = "https://github.com/facebookresearch/OpenEnv/blob/main/README.md"
35
+ "Bug Tracker" = "https://github.com/facebookresearch/OpenEnv/issues"
36
+
37
+ [tool.setuptools]
38
+ py-modules = ["openenv_core.__init__", "openenv_core.http_env_client", "openenv_core.client_types"]
39
+ packages = [
40
+ "openenv_core",
41
+ "openenv_core.containers",
42
+ "openenv_core.containers.runtime",
43
+ "openenv_core.env_server",
44
+ "openenv_core.tools"
45
+ ]
46
+ package-dir = {"openenv_core" = "."}
src/core/core/tools/__init__.py ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Core tools for code execution and other utilities."""
8
+
9
+ from .git_server_client import GitServerClient, RepoInfo
10
+ from .local_python_executor import PyExecutor
11
+
12
+ __all__ = [
13
+ "PyExecutor",
14
+ "GitServerClient",
15
+ "RepoInfo",
16
+ ]
src/core/core/tools/git_server_client.py ADDED
@@ -0,0 +1,362 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/usr/bin/env python3
2
+ """
3
+ Git Server Client for connecting to external Gitea instance.
4
+
5
+ This module provides a lightweight client for interacting with a shared
6
+ Gitea service, optimized for task-based isolation where multiple environment
7
+ instances share the same Gitea server but have isolated workspaces.
8
+ """
9
+
10
+ import json
11
+ import os
12
+ import shutil
13
+ import subprocess
14
+ import time
15
+ from dataclasses import dataclass
16
+ from pathlib import Path
17
+ from urllib.parse import urlparse
18
+
19
+
20
+ @dataclass
21
+ class RepoInfo:
22
+ """Information about a repository."""
23
+
24
+ name: str
25
+ url: str
26
+ commit: str
27
+ clone_url: str
28
+
29
+
30
+ class GitServerClient:
31
+ """
32
+ Client for connecting to an external Gitea server.
33
+
34
+ This client is optimized for task-based isolation where:
35
+ - Multiple tasks share the same Gitea instance
36
+ - Each task has its own isolated workspace
37
+ - Fast reset() via git operations (no server restart)
38
+ - Repos are pre-migrated to Gitea once
39
+
40
+ Args:
41
+ gitea_url: URL of the Gitea server (e.g., "http://gitea:3000")
42
+ username: Gitea username for authentication
43
+ password: Gitea password for authentication
44
+ workspace_dir: Local workspace directory for cloning repos
45
+
46
+ Example:
47
+ >>> # Connect to shared Gitea (credentials from environment)
48
+ >>> import os
49
+ >>> client = GitServerClient(
50
+ ... gitea_url=os.getenv("GITEA_URL"),
51
+ ... username=os.getenv("GITEA_USERNAME"),
52
+ ... password=os.getenv("GITEA_PASSWORD")
53
+ ... )
54
+ >>> client.wait_for_ready()
55
+ >>> # Clone repo to workspace
56
+ >>> path = client.clone_to_workspace("my-repo", commit="abc123")
57
+ >>> # Fast reset to base state
58
+ >>> client.reset_workspace("my-repo", commit="abc123")
59
+ """
60
+
61
+ def __init__(
62
+ self,
63
+ gitea_url: str,
64
+ username: str,
65
+ password: str,
66
+ workspace_dir: str = "/workspace",
67
+ ):
68
+ """Initialize Git Server Client."""
69
+ self.gitea_url = gitea_url.rstrip("/")
70
+ self.username = username
71
+ self.password = password
72
+ self.workspace_dir = Path(workspace_dir)
73
+ self.is_ready = False
74
+
75
+ # Parse Gitea URL
76
+ parsed = urlparse(self.gitea_url)
77
+ self.domain = parsed.hostname or "localhost"
78
+ self.port = parsed.port or 3000
79
+
80
+ # Ensure workspace exists
81
+ os.makedirs(self.workspace_dir, exist_ok=True)
82
+
83
+ # Configure git credentials
84
+ self._configure_git()
85
+
86
+ def _configure_git(self):
87
+ """Configure git credentials for automatic authentication."""
88
+ home_dir = Path.home()
89
+
90
+ # Git config
91
+ git_config = f"""[user]
92
+ name = {self.username}
93
+ email = {self.username}@local.env
94
+ [init]
95
+ defaultBranch = main
96
+ [credential]
97
+ helper = store
98
+ """
99
+ gitconfig_path = home_dir / ".gitconfig"
100
+ gitconfig_path.write_text(git_config)
101
+
102
+ # Git credentials
103
+ git_credentials = f"http://{self.username}:{self.password}@{self.domain}:{self.port}\n"
104
+ gitcreds_path = home_dir / ".git-credentials"
105
+ gitcreds_path.write_text(git_credentials)
106
+ gitcreds_path.chmod(0o600)
107
+
108
+ def wait_for_ready(self, timeout: int = 30) -> bool:
109
+ """
110
+ Wait for Gitea server to be ready.
111
+
112
+ Args:
113
+ timeout: Maximum seconds to wait
114
+
115
+ Returns:
116
+ True if server is ready, False otherwise
117
+ """
118
+ start_time = time.time()
119
+ while time.time() - start_time < timeout:
120
+ try:
121
+ result = subprocess.run(
122
+ ["curl", "-sf", f"{self.gitea_url}/"],
123
+ capture_output=True,
124
+ timeout=5,
125
+ )
126
+ if result.returncode == 0:
127
+ self.is_ready = True
128
+ return True
129
+ except subprocess.TimeoutExpired:
130
+ pass
131
+ except Exception:
132
+ pass
133
+
134
+ time.sleep(1)
135
+
136
+ return False
137
+
138
+ def list_repositories(self) -> list[dict[str, str]]:
139
+ """
140
+ List all repositories in Gitea.
141
+
142
+ Returns:
143
+ List of repository information dictionaries
144
+ """
145
+ if not self.is_ready:
146
+ raise RuntimeError("Gitea server is not ready")
147
+
148
+ result = subprocess.run(
149
+ [
150
+ "curl",
151
+ "-s",
152
+ f"{self.gitea_url}/api/v1/user/repos",
153
+ "-u",
154
+ f"{self.username}:{self.password}",
155
+ ],
156
+ capture_output=True,
157
+ text=True,
158
+ )
159
+
160
+ if result.returncode != 0:
161
+ return []
162
+
163
+ try:
164
+ repos = json.loads(result.stdout)
165
+ return [
166
+ {
167
+ "name": repo["name"],
168
+ "full_name": repo["full_name"],
169
+ "clone_url": repo["clone_url"],
170
+ "description": repo.get("description", ""),
171
+ }
172
+ for repo in repos
173
+ ]
174
+ except (json.JSONDecodeError, KeyError):
175
+ return []
176
+
177
+ def clone_to_workspace(
178
+ self, repo_name: str, target_dir: str | None = None, commit: str = "main"
179
+ ) -> str:
180
+ """
181
+ Clone a repository to the workspace at a specific commit.
182
+
183
+ This creates a fresh clone optimized for task isolation.
184
+
185
+ Args:
186
+ repo_name: Name of repository to clone
187
+ target_dir: Target directory name (defaults to repo_name)
188
+ commit: Commit hash or branch to checkout
189
+
190
+ Returns:
191
+ Path to cloned repository
192
+
193
+ Raises:
194
+ RuntimeError: If clone fails
195
+ """
196
+ if not self.is_ready:
197
+ raise RuntimeError("Gitea server is not ready")
198
+
199
+ target_dir = target_dir or repo_name
200
+ target_path = self.workspace_dir / target_dir
201
+
202
+ # Remove existing directory if present
203
+ if target_path.exists():
204
+ shutil.rmtree(target_path)
205
+
206
+ clone_url = f"{self.gitea_url}/{self.username}/{repo_name}.git"
207
+
208
+ # Clone repository
209
+ result = subprocess.run(
210
+ ["git", "clone", clone_url, str(target_path)],
211
+ capture_output=True,
212
+ text=True,
213
+ )
214
+
215
+ if result.returncode != 0:
216
+ raise RuntimeError(f"Clone failed: {result.stderr}")
217
+
218
+ # Checkout specific commit
219
+ if commit != "main":
220
+ result = subprocess.run(
221
+ ["git", "checkout", commit],
222
+ cwd=str(target_path),
223
+ capture_output=True,
224
+ text=True,
225
+ )
226
+
227
+ if result.returncode != 0:
228
+ raise RuntimeError(f"Checkout failed: {result.stderr}")
229
+
230
+ return str(target_path)
231
+
232
+ def reset_workspace(self, repo_name: str, commit: str = "main") -> bool:
233
+ """
234
+ Fast reset of workspace to base state (optimized for task resets).
235
+
236
+ This is much faster than re-cloning. It:
237
+ 1. Checks out the target commit
238
+ 2. Resets to that commit (hard)
239
+ 3. Cleans untracked files
240
+
241
+ Args:
242
+ repo_name: Name of repository (directory in workspace)
243
+ commit: Commit hash or branch to reset to
244
+
245
+ Returns:
246
+ True if reset successful
247
+
248
+ Raises:
249
+ RuntimeError: If reset fails
250
+ """
251
+ repo_path = self.workspace_dir / repo_name
252
+
253
+ if not repo_path.exists():
254
+ raise RuntimeError(f"Repository not found in workspace: {repo_name}")
255
+
256
+ # Fetch latest (in case commit is new)
257
+ subprocess.run(
258
+ ["git", "fetch", "--all"],
259
+ cwd=str(repo_path),
260
+ capture_output=True,
261
+ )
262
+
263
+ # Checkout and hard reset to commit
264
+ result = subprocess.run(
265
+ ["git", "checkout", commit],
266
+ cwd=str(repo_path),
267
+ capture_output=True,
268
+ text=True,
269
+ )
270
+
271
+ if result.returncode != 0:
272
+ raise RuntimeError(f"Checkout failed: {result.stderr}")
273
+
274
+ result = subprocess.run(
275
+ ["git", "reset", "--hard", f"origin/{commit}" if commit != "main" else commit],
276
+ cwd=str(repo_path),
277
+ capture_output=True,
278
+ text=True,
279
+ )
280
+
281
+ if result.returncode != 0:
282
+ # Try without origin/ prefix
283
+ result = subprocess.run(
284
+ ["git", "reset", "--hard", commit],
285
+ cwd=str(repo_path),
286
+ capture_output=True,
287
+ text=True,
288
+ )
289
+ if result.returncode != 0:
290
+ raise RuntimeError(f"Reset failed: {result.stderr}")
291
+
292
+ # Clean untracked files and directories
293
+ subprocess.run(
294
+ ["git", "clean", "-fdx"],
295
+ cwd=str(repo_path),
296
+ capture_output=True,
297
+ )
298
+
299
+ return True
300
+
301
+ def execute_git_command(
302
+ self, command: str, working_dir: str = ""
303
+ ) -> tuple[int, str, str]:
304
+ """
305
+ Execute a git command in the workspace.
306
+
307
+ Args:
308
+ command: Git command to execute (without 'git' prefix)
309
+ working_dir: Working directory relative to workspace
310
+
311
+ Returns:
312
+ Tuple of (exit_code, stdout, stderr)
313
+ """
314
+ work_path = (
315
+ self.workspace_dir / working_dir if working_dir else self.workspace_dir
316
+ )
317
+
318
+ if not work_path.exists():
319
+ return (1, "", f"Working directory does not exist: {work_path}")
320
+
321
+ # Split command safely
322
+ cmd_parts = ["git"] + command.split()
323
+
324
+ result = subprocess.run(
325
+ cmd_parts,
326
+ cwd=str(work_path),
327
+ capture_output=True,
328
+ text=True,
329
+ )
330
+
331
+ return (result.returncode, result.stdout, result.stderr)
332
+
333
+ def get_current_commit(self, repo_name: str) -> str:
334
+ """
335
+ Get current commit hash of a workspace repository.
336
+
337
+ Args:
338
+ repo_name: Name of repository in workspace
339
+
340
+ Returns:
341
+ Commit hash
342
+ """
343
+ repo_path = self.workspace_dir / repo_name
344
+
345
+ if not repo_path.exists():
346
+ raise RuntimeError(f"Repository not found: {repo_name}")
347
+
348
+ result = subprocess.run(
349
+ ["git", "rev-parse", "HEAD"],
350
+ cwd=str(repo_path),
351
+ capture_output=True,
352
+ text=True,
353
+ )
354
+
355
+ if result.returncode != 0:
356
+ raise RuntimeError(f"Failed to get commit: {result.stderr}")
357
+
358
+ return result.stdout.strip()
359
+
360
+ def workspace_exists(self, repo_name: str) -> bool:
361
+ """Check if a repository exists in workspace."""
362
+ return (self.workspace_dir / repo_name).exists()
src/core/core/tools/local_python_executor.py ADDED
@@ -0,0 +1,105 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ Local Python Executor.
9
+
10
+ This module provides functionality for executing Python code locally by wrapping
11
+ the smolagents LocalPythonExecutor.
12
+ """
13
+
14
+ from smolagents import LocalPythonExecutor
15
+
16
+ from core.env_server.types import CodeExecResult
17
+
18
+
19
+ class PyExecutor:
20
+ """
21
+ Wrapper around smolagents LocalPythonExecutor for executing Python code.
22
+
23
+ This class provides a simple interface to execute Python code in a subprocess
24
+ and capture the results including stdout, stderr, and exit code.
25
+
26
+ Args:
27
+ additional_imports: List of additional module imports to authorize.
28
+ For example: ["numpy", "pandas", "matplotlib"]
29
+ These will be added to the base authorized imports.
30
+
31
+ Example:
32
+ >>> # Basic usage with default imports
33
+ >>> executor = PyExecutor()
34
+ >>> result = executor.run("print('Hello, World!')")
35
+ >>> print(result.stdout) # "Hello, World!\n"
36
+ >>> print(result.exit_code) # 0
37
+ >>>
38
+ >>> # Usage with additional imports
39
+ >>> executor = PyExecutor(additional_imports=["numpy", "pandas"])
40
+ >>> result = executor.run("import numpy as np\\nprint(np.array([1, 2, 3]))")
41
+ >>> print(result.stdout) # "[1 2 3]\n"
42
+ """
43
+
44
+ def __init__(self, additional_imports: list[str] | None = None):
45
+ """
46
+ Initialize the PyExecutor with a LocalPythonExecutor instance.
47
+
48
+ Args:
49
+ additional_imports: List of additional module names to authorize for import.
50
+ Defaults to an empty list if not provided.
51
+ """
52
+ if additional_imports is None:
53
+ additional_imports = []
54
+ self._executor = LocalPythonExecutor(
55
+ additional_authorized_imports=additional_imports
56
+ )
57
+ # Initialize tools to make BASE_PYTHON_TOOLS available (including print)
58
+ self._executor.send_tools({})
59
+
60
+ def run(self, code: str) -> CodeExecResult:
61
+ """
62
+ Execute Python code and return the result.
63
+
64
+ Args:
65
+ code: Python code string to execute
66
+
67
+ Returns:
68
+ CodeExecResult containing stdout, stderr, and exit_code
69
+
70
+ Example:
71
+ >>> executor = PyExecutor()
72
+ >>> result = executor.run("x = 5 + 3\\nprint(x)")
73
+ >>> print(result.stdout) # "8\n"
74
+ >>> print(result.exit_code) # 0
75
+ >>>
76
+ >>> # Error handling
77
+ >>> result = executor.run("1 / 0")
78
+ >>> print(result.exit_code) # 1
79
+ >>> print(result.stderr) # Contains error message
80
+ """
81
+ try:
82
+ # Execute the code using LocalPythonExecutor
83
+ # LocalPythonExecutor returns a CodeOutput object with output, logs, is_final_answer
84
+ exec_result = self._executor(code)
85
+
86
+ # Extract the logs (which contain print outputs) as stdout
87
+ # The output field contains the return value of the code
88
+ stdout = exec_result.logs
89
+ stderr = ""
90
+ exit_code = 0 # Success
91
+
92
+ return CodeExecResult(
93
+ stdout=stdout,
94
+ stderr=stderr,
95
+ exit_code=exit_code,
96
+ )
97
+
98
+ except Exception as e:
99
+ # LocalPythonExecutor raises InterpreterError for various issues
100
+ # (syntax errors, forbidden operations, runtime errors, etc.)
101
+ return CodeExecResult(
102
+ stdout="",
103
+ stderr=str(e),
104
+ exit_code=1, # Non-zero indicates error
105
+ )
src/envs/openspiel_env/openspiel_env/README.md ADDED
@@ -0,0 +1,335 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # OpenSpiel Environment
2
+
3
+ Integration of OpenSpiel games with the OpenEnv framework. OpenSpiel (https://github.com/google-deepmind/open_spiel) is DeepMind's collection of 70+ game environments for RL research.
4
+
5
+ ## Supported Games
6
+
7
+ This environment supports 6 games across different categories:
8
+
9
+ ### Single-Player Games (No Opponent)
10
+ 1. **Catch** - Move horizontally to catch a falling ball
11
+ 2. **Cliff Walking** - Navigate grid without falling off cliff (Sutton & Barto benchmark)
12
+ 3. **2048** - Classic tile-merging puzzle game
13
+ 4. **Blackjack** - Simplified blackjack (HIT/STAND only)
14
+
15
+ ### Multi-Player Games (with Bot Opponent)
16
+ 5. **Tic-Tac-Toe** - Classic 3x3 game
17
+ 6. **Kuhn Poker** - 2-player simplified poker (game theory benchmark)
18
+
19
+ ## Architecture
20
+
21
+ ```
22
+ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
23
+ โ”‚ RL Training Code (Client) โ”‚
24
+ โ”‚ OpenSpielEnv.step(action) โ”‚
25
+ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
26
+ โ”‚ HTTP
27
+ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
28
+ โ”‚ FastAPI Server (Docker) โ”‚
29
+ โ”‚ OpenSpielEnvironment โ”‚
30
+ โ”‚ โ”œโ”€ Wraps rl_environment.Env โ”‚
31
+ โ”‚ โ”œโ”€ Agent controls player 0 โ”‚
32
+ โ”‚ โ””โ”€ Opponent: Random/Fixed โ”‚
33
+ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
34
+ ```
35
+
36
+ ## Installation & Usage
37
+
38
+ ### Option 1: Local Development (without Docker)
39
+
40
+ **Requirements:**
41
+ - OpenSpiel must be installed (see https://github.com/google-deepmind/open_spiel)
42
+ - Python 3.11+
43
+
44
+ ```python
45
+ from envs.openspiel_env import OpenSpielEnv, OpenSpielAction
46
+
47
+ # Start local server manually
48
+ # python -m envs.openspiel_env.server.app
49
+
50
+ # Connect to local server
51
+ env = OpenSpielEnv(base_url="http://localhost:8000")
52
+
53
+ # Reset environment
54
+ result = env.reset()
55
+ print(f"Initial state: {result.observation.info_state}")
56
+ print(f"Legal actions: {result.observation.legal_actions}")
57
+
58
+ # Take actions
59
+ for _ in range(10):
60
+ action_id = result.observation.legal_actions[0] # Choose first legal action
61
+ result = env.step(OpenSpielAction(action_id=action_id))
62
+ print(f"Reward: {result.reward}, Done: {result.done}")
63
+ if result.done:
64
+ break
65
+
66
+ # Cleanup
67
+ env.close()
68
+ ```
69
+
70
+ ### Option 2: Docker (Recommended)
71
+
72
+ **Build Docker image:**
73
+
74
+ ```bash
75
+ cd OpenEnv
76
+ docker build -f src/envs/openspiel_env/server/Dockerfile -t openspiel-env:latest .
77
+ ```
78
+
79
+ **Run specific games:**
80
+
81
+ ```bash
82
+ # Catch (default)
83
+ docker run -p 8000:8000 openspiel-env:latest
84
+
85
+ # Tic-Tac-Toe with random opponent
86
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=tic_tac_toe openspiel-env:latest
87
+
88
+ # Kuhn Poker
89
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=kuhn_poker openspiel-env:latest
90
+
91
+ # 2048
92
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=2048 openspiel-env:latest
93
+ ```
94
+
95
+ **Use with from_docker_image():**
96
+
97
+ ```python
98
+ from envs.openspiel_env import OpenSpielEnv, OpenSpielAction
99
+
100
+ # Automatically starts container
101
+ env = OpenSpielEnv.from_docker_image("openspiel-env:latest")
102
+
103
+ result = env.reset()
104
+ result = env.step(OpenSpielAction(action_id=0))
105
+
106
+ env.close() # Stops container
107
+ ```
108
+
109
+ ## Game-Specific Information
110
+
111
+ ### 1. Catch
112
+ - **Type**: Single-player
113
+ - **Action Space**: 3 actions (left, stay, right)
114
+ - **Observation**: 5x5 grid flattened (25 dimensions)
115
+ - **Reward**: +1 for catching ball, 0 otherwise
116
+ - **Episode Length**: ~10 steps
117
+
118
+ ```python
119
+ env = OpenSpielEnv.from_docker_image("openspiel-env:latest")
120
+ # Or set OPENSPIEL_GAME=catch
121
+ ```
122
+
123
+ ### 2. Tic-Tac-Toe
124
+ - **Type**: 2-player turn-based, perfect information
125
+ - **Players**: Agent (X) vs Random Bot (O)
126
+ - **Action Space**: 9 positions
127
+ - **Observation**: 27 dimensions (3x3 board + game state)
128
+ - **Reward**: +1 win, -1 loss, 0 draw/mid-game
129
+
130
+ ```python
131
+ # Set environment variable or run directly
132
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=tic_tac_toe openspiel-env:latest
133
+ ```
134
+
135
+ ### 3. Kuhn Poker
136
+ - **Type**: 2-player turn-based, imperfect information
137
+ - **Players**: Agent vs Random Bot
138
+ - **Action Space**: 2 actions (pass/fold, bet/call)
139
+ - **Observation**: 6 dimensions (card + betting history)
140
+ - **Reward**: Pot winnings (typically -1, 0, +1, +2)
141
+ - **Notes**: THE benchmark for imperfect-information RL
142
+
143
+ ```python
144
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=kuhn_poker openspiel-env:latest
145
+ ```
146
+
147
+ ### 4. Cliff Walking
148
+ - **Type**: Single-player grid world
149
+ - **Action Space**: 4 actions (up, down, left, right)
150
+ - **Observation**: Position encoding
151
+ - **Reward**: -1 per step, -100 for falling off cliff
152
+ - **Notes**: Classic RL benchmark from Sutton & Barto
153
+
154
+ ```python
155
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=cliff_walking openspiel-env:latest
156
+ ```
157
+
158
+ ### 5. 2048
159
+ - **Type**: Single-player puzzle
160
+ - **Action Space**: 4 actions (up, down, left, right)
161
+ - **Observation**: 4x4 grid with tile values
162
+ - **Reward**: Points from merging tiles
163
+ - **Notes**: Stochastic tile spawning
164
+
165
+ ```python
166
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=2048 openspiel-env:latest
167
+ ```
168
+
169
+ ### 6. Blackjack
170
+ - **Type**: Single-player vs dealer
171
+ - **Action Space**: 2 actions (HIT, STAND)
172
+ - **Observation**: Player hand + dealer's visible card
173
+ - **Reward**: +1 win, -1 loss, 0 draw
174
+ - **Notes**: Simplified version, no double/split
175
+
176
+ ```python
177
+ docker run -p 8000:8000 -e OPENSPIEL_GAME=blackjack openspiel-env:latest
178
+ ```
179
+
180
+ ## Configuration
181
+
182
+ ### Environment Variables
183
+
184
+ - `OPENSPIEL_GAME`: Game name (default: "catch")
185
+ - `OPENSPIEL_AGENT_PLAYER`: Player ID for agent (default: 0)
186
+ - `OPENSPIEL_OPPONENT_POLICY`: Opponent policy for multi-player games
187
+ - `random`: Uniform random (default)
188
+ - `first`: Always picks first legal action
189
+ - `last`: Always picks last legal action
190
+
191
+ ### Example: Tic-Tac-Toe with Fixed Opponent
192
+
193
+ ```bash
194
+ docker run -p 8000:8000 \
195
+ -e OPENSPIEL_GAME=tic_tac_toe \
196
+ -e OPENSPIEL_OPPONENT_POLICY=first \
197
+ openspiel-env:latest
198
+ ```
199
+
200
+ ## API Reference
201
+
202
+ ### OpenSpielAction
203
+
204
+ ```python
205
+ @dataclass
206
+ class OpenSpielAction(Action):
207
+ action_id: int # Action to take
208
+ game_name: str = "catch" # Game name
209
+ game_params: Dict[str, Any] = {} # Optional game parameters
210
+ ```
211
+
212
+ ### OpenSpielObservation
213
+
214
+ ```python
215
+ @dataclass
216
+ class OpenSpielObservation(Observation):
217
+ info_state: List[float] # Agent's information state
218
+ legal_actions: List[int] # Legal action IDs
219
+ game_phase: str # "initial", "playing", "terminal"
220
+ current_player_id: int # Current player (-1 for simultaneous)
221
+ opponent_last_action: Optional[int] # Last opponent action (if available)
222
+ done: bool # Episode finished
223
+ reward: Optional[float] # Reward for last action
224
+ ```
225
+
226
+ ### OpenSpielState
227
+
228
+ ```python
229
+ @dataclass
230
+ class OpenSpielState(State):
231
+ episode_id: str # Unique episode ID
232
+ step_count: int # Number of steps
233
+ game_name: str # Game name
234
+ agent_player: int # Agent's player ID
235
+ opponent_policy: str # Opponent policy name
236
+ num_players: int # Total players
237
+ ```
238
+
239
+ ## Testing
240
+
241
+ ### Automated Testing (All 6 Games)
242
+
243
+ **Quick test of all games in Docker:**
244
+ ```bash
245
+ ./test_docker_all_games.sh
246
+ ```
247
+
248
+ This automated script will:
249
+ - Build and run Docker containers for each game
250
+ - Test reset, step, and state APIs
251
+ - Verify episode completion
252
+ - Report pass/fail for all 6 games
253
+
254
+ **Expected output:**
255
+ ```
256
+ ========================================
257
+ OpenSpiel Docker Integration Test
258
+ ========================================
259
+
260
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
261
+ Testing: catch
262
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
263
+ ๐Ÿณ Starting Docker container...
264
+ โณ Waiting for server to be ready...
265
+ โœ“ Server ready (2s)
266
+ ๐ŸŽฎ Running Python client test...
267
+ โœ“ PASSED - Episode completed successfully
268
+
269
+ [... tests all 6 games ...]
270
+
271
+ ========================================
272
+ Test Summary
273
+ ========================================
274
+
275
+ โœ“ catch
276
+ โœ“ tic_tac_toe
277
+ โœ“ kuhn_poker
278
+ โœ“ cliff_walking
279
+ โœ“ 2048
280
+ โœ“ blackjack
281
+
282
+ Total: 6 passed, 0 failed out of 6 games
283
+
284
+ ========================================
285
+ All tests PASSED! ๐ŸŽ‰
286
+ ========================================
287
+ ```
288
+
289
+ ### Manual Testing
290
+
291
+ ```bash
292
+ # Local (requires OpenSpiel installed)
293
+ python -m pytest src/envs/openspiel_env/
294
+
295
+ # Docker build
296
+ docker build -f src/envs/openspiel_env/server/Dockerfile -t openspiel-env:latest .
297
+
298
+ # Run specific game
299
+ docker run -p 8000:8000 openspiel-env:latest
300
+
301
+ # Test from another terminal
302
+ python3 examples/openspiel_simple.py
303
+ ```
304
+
305
+ ## Development
306
+
307
+ ### Adding New Games
308
+
309
+ To add support for more OpenSpiel games:
310
+
311
+ 1. Verify the game works with `rl_environment.Environment`
312
+ 2. Test with different opponent policies if multi-player
313
+ 3. Document game-specific configuration
314
+ 4. Add example script
315
+
316
+ ## Limitations
317
+
318
+ - **Simultaneous-move games**: Only agent_player=0 supported
319
+ - **Multi-agent training**: Single agent only (no self-play yet)
320
+ - **Opponent policies**: Random and fixed only (no MCTS yet)
321
+ - **Build time**: Docker image takes ~5-10 minutes to build (compiles C++)
322
+
323
+ ## Future Work
324
+
325
+ - MCTS opponent policies
326
+ - Self-play support (multiple agents)
327
+ - More games (Chess, Go, Poker Hold'em)
328
+ - Faster build with pre-built OpenSpiel base image
329
+ - Game-specific reward shaping options
330
+
331
+ ## References
332
+
333
+ - [OpenSpiel Paper (2019)](https://arxiv.org/abs/1908.09453)
334
+ - [OpenSpiel GitHub](https://github.com/google-deepmind/open_spiel)
335
+ - [OpenSpiel Documentation](https://openspiel.readthedocs.io/)
src/envs/openspiel_env/openspiel_env/__init__.py ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ OpenSpiel Environment Integration.
9
+
10
+ This module provides integration between OpenSpiel games and the OpenEnv framework.
11
+ OpenSpiel (https://github.com/google-deepmind/open_spiel) is DeepMind's collection
12
+ of environments and algorithms for research in RL in games.
13
+
14
+ Supported games:
15
+ - Catch (1P)
16
+ - Tic-Tac-Toe (2P)
17
+ - Kuhn Poker (2P, imperfect info)
18
+ - Cliff Walking (1P)
19
+ - 2048 (1P)
20
+ - Blackjack (1P)
21
+ """
22
+
23
+ from .client import OpenSpielEnv
24
+ from .models import OpenSpielAction, OpenSpielObservation, OpenSpielState
25
+
26
+ __all__ = ["OpenSpielEnv", "OpenSpielAction", "OpenSpielObservation", "OpenSpielState"]
src/envs/openspiel_env/openspiel_env/client.py ADDED
@@ -0,0 +1,117 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ OpenSpielEnv HTTP Client.
9
+
10
+ This module provides the client for connecting to an OpenSpiel Environment server
11
+ over HTTP.
12
+ """
13
+
14
+ from __future__ import annotations
15
+
16
+ from typing import Any, Dict, Optional, TYPE_CHECKING
17
+
18
+ from core.client_types import StepResult
19
+
20
+ from core.http_env_client import HTTPEnvClient
21
+
22
+ from .models import OpenSpielAction, OpenSpielObservation, OpenSpielState
23
+
24
+ if TYPE_CHECKING:
25
+ from core.containers.runtime import ContainerProvider
26
+
27
+
28
+ class OpenSpielEnv(HTTPEnvClient[OpenSpielAction, OpenSpielObservation]):
29
+ """
30
+ HTTP client for OpenSpiel Environment.
31
+
32
+ This client connects to an OpenSpielEnvironment HTTP server and provides
33
+ methods to interact with it: reset(), step(), and state access.
34
+
35
+ Example:
36
+ >>> # Connect to a running server
37
+ >>> client = OpenSpielEnv(base_url="http://localhost:8000")
38
+ >>> result = client.reset()
39
+ >>> print(result.observation.info_state)
40
+ >>>
41
+ >>> # Take an action
42
+ >>> result = client.step(OpenSpielAction(action_id=1, game_name="catch"))
43
+ >>> print(result.observation.reward)
44
+
45
+ Example with Docker:
46
+ >>> # Automatically start container and connect
47
+ >>> client = OpenSpielEnv.from_docker_image("openspiel-env:latest")
48
+ >>> result = client.reset()
49
+ >>> result = client.step(OpenSpielAction(action_id=0))
50
+ """
51
+
52
+ def _step_payload(self, action: OpenSpielAction) -> Dict[str, Any]:
53
+ """
54
+ Convert OpenSpielAction to JSON payload for step request.
55
+
56
+ Args:
57
+ action: OpenSpielAction instance.
58
+
59
+ Returns:
60
+ Dictionary representation suitable for JSON encoding.
61
+ """
62
+ return {
63
+ "action_id": action.action_id,
64
+ "game_name": action.game_name,
65
+ "game_params": action.game_params,
66
+ }
67
+
68
+ def _parse_result(
69
+ self, payload: Dict[str, Any]
70
+ ) -> StepResult[OpenSpielObservation]:
71
+ """
72
+ Parse server response into StepResult[OpenSpielObservation].
73
+
74
+ Args:
75
+ payload: JSON response from server.
76
+
77
+ Returns:
78
+ StepResult with OpenSpielObservation.
79
+ """
80
+ obs_data = payload.get("observation", {})
81
+
82
+ observation = OpenSpielObservation(
83
+ info_state=obs_data.get("info_state", []),
84
+ legal_actions=obs_data.get("legal_actions", []),
85
+ game_phase=obs_data.get("game_phase", "playing"),
86
+ current_player_id=obs_data.get("current_player_id", 0),
87
+ opponent_last_action=obs_data.get("opponent_last_action"),
88
+ done=payload.get("done", False),
89
+ reward=payload.get("reward"),
90
+ metadata=obs_data.get("metadata", {}),
91
+ )
92
+
93
+ return StepResult(
94
+ observation=observation,
95
+ reward=payload.get("reward"),
96
+ done=payload.get("done", False),
97
+ )
98
+
99
+ def _parse_state(self, payload: Dict[str, Any]) -> OpenSpielState:
100
+ """
101
+ Parse server response into OpenSpielState object.
102
+
103
+ Args:
104
+ payload: JSON response from /state endpoint.
105
+
106
+ Returns:
107
+ OpenSpielState object with environment state information.
108
+ """
109
+ return OpenSpielState(
110
+ episode_id=payload.get("episode_id"),
111
+ step_count=payload.get("step_count", 0),
112
+ game_name=payload.get("game_name", "unknown"),
113
+ agent_player=payload.get("agent_player", 0),
114
+ opponent_policy=payload.get("opponent_policy", "random"),
115
+ game_params=payload.get("game_params", {}),
116
+ num_players=payload.get("num_players", 1),
117
+ )
src/envs/openspiel_env/openspiel_env/docker_issue.md ADDED
@@ -0,0 +1 @@
 
 
1
+ # port issue? fix proxy?
src/envs/openspiel_env/openspiel_env/models.py ADDED
@@ -0,0 +1,76 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ Data models for OpenSpiel Environment.
9
+
10
+ This module defines the Action, Observation, and State types for OpenSpiel games.
11
+ """
12
+
13
+ from __future__ import annotations
14
+
15
+ from dataclasses import dataclass, field
16
+ from typing import Any, Dict, List, Optional
17
+
18
+ from core.env_server import Action, Observation, State
19
+
20
+
21
+ @dataclass
22
+ class OpenSpielAction(Action):
23
+ """
24
+ Action for OpenSpiel environments.
25
+
26
+ Attributes:
27
+ action_id: The integer action ID to take (from legal_actions).
28
+ game_name: Name of the OpenSpiel game (e.g., "catch", "tic_tac_toe").
29
+ game_params: Optional game-specific parameters (e.g., {"rows": 8, "columns": 6}).
30
+ """
31
+ action_id: int
32
+ game_name: str = "catch"
33
+ game_params: Dict[str, Any] = field(default_factory=dict)
34
+
35
+
36
+ @dataclass
37
+ class OpenSpielObservation(Observation):
38
+ """
39
+ Observation from OpenSpiel environment.
40
+
41
+ This represents what the agent sees after taking an action.
42
+ For single-player games, this is straightforward.
43
+ For multi-player games, this is from the perspective of the agent player.
44
+
45
+ Attributes:
46
+ info_state: Information state tensor (list of floats) for the agent.
47
+ This contains all information available to the agent.
48
+ legal_actions: List of legal action IDs the agent can take.
49
+ game_phase: String describing the current phase (e.g., "playing", "terminal").
50
+ current_player_id: ID of the current player (-1 for simultaneous, player ID otherwise).
51
+ opponent_last_action: Last action taken by opponent (if available, None otherwise).
52
+ """
53
+ info_state: List[float]
54
+ legal_actions: List[int]
55
+ game_phase: str = "playing"
56
+ current_player_id: int = 0
57
+ opponent_last_action: Optional[int] = None
58
+
59
+
60
+ @dataclass
61
+ class OpenSpielState(State):
62
+ """
63
+ State for OpenSpiel environment.
64
+
65
+ Attributes:
66
+ game_name: Name of the OpenSpiel game.
67
+ agent_player: Which player ID the agent controls (0 by default).
68
+ opponent_policy: Name of the opponent policy ("random", "fixed", etc.).
69
+ game_params: Game-specific parameters.
70
+ num_players: Total number of players in the game.
71
+ """
72
+ game_name: str = "catch"
73
+ agent_player: int = 0
74
+ opponent_policy: str = "random"
75
+ game_params: Dict[str, Any] = field(default_factory=dict)
76
+ num_players: int = 1
src/envs/openspiel_env/openspiel_env/server/Dockerfile ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ # Use the pre-built OpenSpiel base image
8
+ # Built from: docker build -t openspiel-base:latest -f src/envs/openspiel_env/server/Dockerfile.openspiel-base .
9
+ # In GitHub Actions, this is overridden to use the GHCR base image
10
+ ARG OPENSPIEL_BASE_IMAGE=openspiel-base:latest
11
+ FROM ${OPENSPIEL_BASE_IMAGE}
12
+
13
+ # Copy OpenEnv core (base image already set WORKDIR=/app)
14
+ WORKDIR /app
15
+ COPY src/core/ /app/src/core/
16
+
17
+ # Copy OpenSpiel environment
18
+ COPY src/envs/openspiel_env/ /app/src/envs/openspiel_env/
19
+
20
+ # Copy README for web interface documentation
21
+ COPY src/envs/openspiel_env/README.md /app/README.md
22
+
23
+ # Extend Python path for OpenEnv (base image set PYTHONPATH=/app/src)
24
+ # We prepend OpenSpiel paths
25
+ ENV PYTHONPATH=/repo:/repo/build/python:/app/src
26
+
27
+ # OpenSpiel-specific environment variables (can be overridden at runtime)
28
+ ENV OPENSPIEL_GAME=catch
29
+ ENV OPENSPIEL_AGENT_PLAYER=0
30
+ ENV OPENSPIEL_OPPONENT_POLICY=random
31
+
32
+ # Health check (curl is provided by openenv-base)
33
+ HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
34
+ CMD curl -f http://localhost:8000/health || exit 1
35
+
36
+ # Note: EXPOSE 8000 already set by openenv-base
37
+
38
+ # Run the FastAPI server (uvicorn installed by openenv-base)
39
+ CMD ["uvicorn", "envs.openspiel_env.server.app:app", "--host", "0.0.0.0", "--port", "8000"]
src/envs/openspiel_env/openspiel_env/server/Dockerfile.openspiel-base ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ # Pre-built OpenSpiel base image
8
+ # This image contains OpenSpiel compiled and ready to use
9
+ # Built from: docker build -t openspiel-base:latest -f src/envs/openspiel_env/server/Dockerfile.openspiel-base .
10
+ # In GitHub Actions, this is overridden to use the GHCR base image
11
+ ARG BASE_IMAGE=openenv-base:latest
12
+ FROM ${BASE_IMAGE}
13
+
14
+ # Avoid interactive prompts during build
15
+ ENV DEBIAN_FRONTEND=noninteractive
16
+ ENV TZ=UTC
17
+
18
+ # Install build dependencies (curl already installed by openenv-base)
19
+ RUN apt-get update && apt-get install -y --no-install-recommends \
20
+ build-essential \
21
+ clang \
22
+ cmake \
23
+ git \
24
+ sudo \
25
+ && rm -rf /var/lib/apt/lists/*
26
+
27
+ # Set up OpenSpiel build directory
28
+ RUN mkdir /repo
29
+ WORKDIR /repo
30
+
31
+ # Clone OpenSpiel
32
+ RUN git clone https://github.com/google-deepmind/open_spiel.git .
33
+
34
+ # Run OpenSpiel's installation script (downloads C++ dependencies)
35
+ RUN ./install.sh
36
+
37
+ # Install Python dependencies
38
+ RUN pip3 install --no-cache-dir --upgrade setuptools testresources importlib_metadata
39
+ RUN pip3 install --no-cache-dir --upgrade -r requirements.txt cmake
40
+
41
+ # Build OpenSpiel with Python 3.11
42
+ # Use the exact same Python executable as the base image
43
+ RUN mkdir -p build
44
+ WORKDIR /repo/build
45
+ RUN cmake -DPython3_EXECUTABLE=/usr/local/bin/python3 -DCMAKE_CXX_COMPILER=$(which clang++) ../open_spiel
46
+ RUN make -j$(nproc) pyspiel
47
+
48
+ # Install OpenSpiel Python requirements
49
+ WORKDIR /repo
50
+ RUN pip3 install --no-cache-dir --upgrade -r requirements.txt
51
+
52
+ # Set Python path for OpenSpiel
53
+ ENV PYTHONPATH=/repo:/repo/build/python:${PYTHONPATH}
54
+
55
+ # Test OpenSpiel import to verify ABI compatibility
56
+ RUN python3 -c "import pyspiel; print('OpenSpiel import successful')" || echo "OpenSpiel import failed"
57
+
58
+ # Clean up build dependencies to reduce image size
59
+ RUN apt-get remove -y build-essential clang cmake git sudo || true && \
60
+ apt-get autoremove -y && \
61
+ apt-get clean && \
62
+ rm -rf /var/lib/apt/lists/*
63
+
64
+ # Set working directory back to /app (standard for openenv-base)
65
+ WORKDIR /app
src/envs/openspiel_env/openspiel_env/server/__init__.py ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """Server-side implementation for OpenSpiel environments."""
src/envs/openspiel_env/openspiel_env/server/app.py ADDED
@@ -0,0 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ FastAPI application for the OpenSpiel Environment.
9
+
10
+ This module creates an HTTP server that exposes OpenSpiel games
11
+ over HTTP endpoints, making them compatible with HTTPEnvClient.
12
+
13
+ Usage:
14
+ # Development (with auto-reload):
15
+ uvicorn envs.openspiel_env.server.app:app --reload --host 0.0.0.0 --port 8000
16
+
17
+ # Production:
18
+ uvicorn envs.openspiel_env.server.app:app --host 0.0.0.0 --port 8000 --workers 4
19
+
20
+ # Or run directly:
21
+ python -m envs.openspiel_env.server.app
22
+
23
+ Environment variables:
24
+ OPENSPIEL_GAME: Game name to serve (default: "catch")
25
+ OPENSPIEL_AGENT_PLAYER: Agent player ID (default: 0)
26
+ OPENSPIEL_OPPONENT_POLICY: Opponent policy (default: "random")
27
+ """
28
+
29
+ import os
30
+
31
+ from core.env_server import create_app
32
+
33
+ from ..models import OpenSpielAction, OpenSpielObservation
34
+ from .openspiel_environment import OpenSpielEnvironment
35
+
36
+ # Get game configuration from environment variables
37
+ game_name = os.getenv("OPENSPIEL_GAME", "catch")
38
+ agent_player = int(os.getenv("OPENSPIEL_AGENT_PLAYER", "0"))
39
+ opponent_policy = os.getenv("OPENSPIEL_OPPONENT_POLICY", "random")
40
+
41
+ # Create the environment instance
42
+ env = OpenSpielEnvironment(
43
+ game_name=game_name,
44
+ agent_player=agent_player,
45
+ opponent_policy=opponent_policy,
46
+ )
47
+
48
+ # Create the FastAPI app with web interface and README integration
49
+ app = create_app(env, OpenSpielAction, OpenSpielObservation, env_name="openspiel_env")
50
+
51
+
52
+ if __name__ == "__main__":
53
+ import uvicorn
54
+
55
+ uvicorn.run(app, host="0.0.0.0", port=8000)
src/envs/openspiel_env/openspiel_env/server/build_docker.sh ADDED
@@ -0,0 +1,69 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/bin/bash
2
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
3
+ # All rights reserved.
4
+ #
5
+ # This source code is licensed under the BSD-style license found in the
6
+ # LICENSE file in the root directory of this source tree.
7
+
8
+ # Script to build the OpenSpiel environment Docker image
9
+ # Usage: ./build_docker.sh [tag]
10
+ #
11
+ # Note: Requires envtorch-base:latest to be built first.
12
+ # See: src/core/containers/images/README.md
13
+
14
+ set -e
15
+
16
+ TAG="${1:-latest}"
17
+ IMAGE_NAME="openspiel-env:${TAG}"
18
+
19
+ echo "๐Ÿณ Building OpenSpiel Environment Docker Image"
20
+ echo "================================================"
21
+ echo "Image: $IMAGE_NAME"
22
+ echo ""
23
+
24
+ # Get script directory
25
+ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
26
+
27
+ # Navigate to OpenEnv root (4 levels up from server/)
28
+ OPENENV_ROOT="$(cd "$SCRIPT_DIR/../../../.." && pwd)"
29
+
30
+ echo "๐Ÿ“ OpenEnv root: $OPENENV_ROOT"
31
+ echo ""
32
+
33
+ # Build OpenSpiel environment image
34
+ # Note: Docker will automatically pull ghcr.io/meta-pytorch/openenv-base:latest if needed
35
+ echo "โณ Building (this may take 5-10 minutes due to OpenSpiel compilation)..."
36
+ docker build \
37
+ -f "$SCRIPT_DIR/Dockerfile" \
38
+ -t "$IMAGE_NAME" \
39
+ "$OPENENV_ROOT"
40
+
41
+ if [ $? -eq 0 ]; then
42
+ echo ""
43
+ echo "โœ… Build successful!"
44
+ echo ""
45
+ echo "๐Ÿš€ Run with different games:"
46
+ echo ""
47
+ echo " # Catch (default)"
48
+ echo " docker run -p 8000:8000 $IMAGE_NAME"
49
+ echo ""
50
+ echo " # Tic-Tac-Toe"
51
+ echo " docker run -p 8000:8000 -e OPENSPIEL_GAME=tic_tac_toe $IMAGE_NAME"
52
+ echo ""
53
+ echo " # Kuhn Poker"
54
+ echo " docker run -p 8000:8000 -e OPENSPIEL_GAME=kuhn_poker $IMAGE_NAME"
55
+ echo ""
56
+ echo " # Cliff Walking"
57
+ echo " docker run -p 8000:8000 -e OPENSPIEL_GAME=cliff_walking $IMAGE_NAME"
58
+ echo ""
59
+ echo " # 2048"
60
+ echo " docker run -p 8000:8000 -e OPENSPIEL_GAME=2048 $IMAGE_NAME"
61
+ echo ""
62
+ echo " # Blackjack"
63
+ echo " docker run -p 8000:8000 -e OPENSPIEL_GAME=blackjack $IMAGE_NAME"
64
+ echo ""
65
+ else
66
+ echo ""
67
+ echo "โŒ Build failed!"
68
+ exit 1
69
+ fi
src/envs/openspiel_env/openspiel_env/server/openspiel_environment.py ADDED
@@ -0,0 +1,266 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ OpenSpiel Environment Server Implementation.
9
+
10
+ This module wraps OpenSpiel's rl_environment.Environment and exposes it
11
+ via the OpenEnv Environment interface.
12
+ """
13
+
14
+ import uuid
15
+ from typing import Any, Dict
16
+
17
+ from core.env_server import Action, Environment, Observation
18
+
19
+ from ..models import OpenSpielAction, OpenSpielObservation, OpenSpielState
20
+ from .opponent_policies import get_opponent_policy, OpponentPolicy
21
+
22
+ # Import OpenSpiel
23
+ try:
24
+ from open_spiel.python import rl_environment
25
+ import pyspiel
26
+ except ImportError as e:
27
+ raise ImportError(
28
+ "OpenSpiel is not installed. "
29
+ "Please install it following instructions at: "
30
+ "https://github.com/google-deepmind/open_spiel"
31
+ ) from e
32
+
33
+
34
+ class OpenSpielEnvironment(Environment):
35
+ """
36
+ OpenSpiel Environment wrapper for OpenEnv.
37
+
38
+ This environment wraps OpenSpiel games and provides a single-agent interface.
39
+ For multi-player games, the agent controls one player while opponent(s) use
40
+ a fixed policy (e.g., random).
41
+
42
+ Supported games:
43
+ - Single-player: catch, cliff_walking, 2048, blackjack
44
+ - Multi-player: tic_tac_toe, kuhn_poker
45
+
46
+ Args:
47
+ game_name: Name of the OpenSpiel game (e.g., "catch", "tic_tac_toe").
48
+ agent_player: Which player ID the agent controls (default 0).
49
+ opponent_policy: Policy for opponent players ("random", "first", etc.).
50
+ game_params: Optional game-specific parameters.
51
+
52
+ Example:
53
+ >>> env = OpenSpielEnvironment("catch")
54
+ >>> obs = env.reset()
55
+ >>> print(obs.info_state) # Agent's observation
56
+ >>> obs = env.step(OpenSpielAction(action_id=1))
57
+ >>> print(obs.reward)
58
+ """
59
+
60
+ def __init__(
61
+ self,
62
+ game_name: str = "catch",
63
+ agent_player: int = 0,
64
+ opponent_policy: str = "random",
65
+ game_params: Dict[str, Any] | None = None,
66
+ ):
67
+ """Initialize OpenSpiel environment."""
68
+ super().__init__()
69
+
70
+ self.game_name = game_name
71
+ self.agent_player = agent_player
72
+ self.game_params = game_params or {}
73
+
74
+ # Create OpenSpiel environment
75
+ try:
76
+ self._ospiel_env = rl_environment.Environment(
77
+ game_name, **self.game_params
78
+ )
79
+ except Exception as e:
80
+ raise ValueError(
81
+ f"Failed to create OpenSpiel game '{game_name}': {e}"
82
+ ) from e
83
+
84
+ self.num_players = self._ospiel_env.num_players
85
+ self.is_turn_based = self._ospiel_env.is_turn_based
86
+
87
+ # Validate agent_player
88
+ if agent_player >= self.num_players:
89
+ raise ValueError(
90
+ f"agent_player={agent_player} >= num_players={self.num_players}"
91
+ )
92
+
93
+ # Set up opponent policy for multi-player games
94
+ self.opponent_policy_fn: OpponentPolicy | None = None
95
+ if self.num_players > 1:
96
+ self.opponent_policy_fn = get_opponent_policy(opponent_policy)
97
+
98
+ # Initialize state
99
+ self._state = OpenSpielState(
100
+ game_name=game_name,
101
+ agent_player=agent_player,
102
+ opponent_policy=opponent_policy,
103
+ game_params=self.game_params,
104
+ num_players=self.num_players,
105
+ )
106
+
107
+ # Track last opponent action for learning
108
+ self._last_opponent_action: int | None = None
109
+
110
+ def reset(self) -> Observation:
111
+ """
112
+ Reset the environment and return initial observation.
113
+
114
+ For multi-player games, this will auto-play opponent turns until
115
+ it's the agent's turn (or terminal state).
116
+
117
+ Returns:
118
+ Initial observation for the agent.
119
+ """
120
+ # Reset OpenSpiel environment
121
+ time_step = self._ospiel_env.reset()
122
+
123
+ # Reset state tracking
124
+ self._state.episode_id = str(uuid.uuid4())
125
+ self._state.step_count = 0
126
+ self._last_opponent_action = None
127
+
128
+ # Auto-play opponent turns until agent's turn
129
+ time_step = self._auto_play_opponents(time_step)
130
+
131
+ # Convert to OpenEnv observation
132
+ return self._make_observation(time_step)
133
+
134
+ def step(self, action: Action) -> Observation:
135
+ """
136
+ Execute agent's action and return resulting observation.
137
+
138
+ For multi-player games, this will:
139
+ 1. Apply the agent's action
140
+ 2. Auto-play opponent turns until it's the agent's turn again
141
+ 3. Return the observation from the agent's perspective
142
+
143
+ Args:
144
+ action: OpenSpielAction containing the action_id to execute.
145
+
146
+ Returns:
147
+ Observation after action execution (and opponent turns if multi-player).
148
+
149
+ Raises:
150
+ ValueError: If action is not an OpenSpielAction.
151
+ """
152
+ if not isinstance(action, OpenSpielAction):
153
+ raise ValueError(f"Expected OpenSpielAction, got {type(action)}")
154
+
155
+ # Apply agent's action
156
+ if self.is_turn_based:
157
+ # Turn-based: single action
158
+ time_step = self._ospiel_env.step([action.action_id])
159
+ else:
160
+ # Simultaneous-move: need actions for all players
161
+ # For now, only support agent as player 0 in simultaneous games
162
+ if self.agent_player != 0:
163
+ raise NotImplementedError(
164
+ "Simultaneous-move games only support agent_player=0"
165
+ )
166
+ # Get opponent actions
167
+ opponent_actions = []
168
+ for player_id in range(self.num_players):
169
+ if player_id == self.agent_player:
170
+ opponent_actions.append(action.action_id)
171
+ else:
172
+ legal_actions = time_step.observations["legal_actions"][player_id]
173
+ opp_action = self.opponent_policy_fn.select_action(
174
+ legal_actions, time_step.observations
175
+ )
176
+ opponent_actions.append(opp_action)
177
+ time_step = self._ospiel_env.step(opponent_actions)
178
+
179
+ self._state.step_count += 1
180
+
181
+ # Auto-play opponent turns (for turn-based games)
182
+ if self.is_turn_based:
183
+ time_step = self._auto_play_opponents(time_step)
184
+
185
+ # Convert to OpenEnv observation
186
+ return self._make_observation(time_step)
187
+
188
+ @property
189
+ def state(self) -> OpenSpielState:
190
+ """Get current environment state."""
191
+ return self._state
192
+
193
+ def _auto_play_opponents(self, time_step) -> Any:
194
+ """
195
+ Auto-play opponent turns until it's the agent's turn or game is terminal.
196
+
197
+ Args:
198
+ time_step: Current TimeStep from OpenSpiel environment.
199
+
200
+ Returns:
201
+ Updated TimeStep after opponent moves.
202
+ """
203
+ # Single-player games: nothing to do
204
+ if self.num_players == 1:
205
+ return time_step
206
+
207
+ # Multi-player games: play opponent turns
208
+ while (
209
+ not time_step.last()
210
+ and time_step.observations["current_player"] != self.agent_player
211
+ ):
212
+ current_player = time_step.observations["current_player"]
213
+ legal_actions = time_step.observations["legal_actions"][current_player]
214
+
215
+ # Select opponent action
216
+ opp_action = self.opponent_policy_fn.select_action(
217
+ legal_actions, time_step.observations
218
+ )
219
+ self._last_opponent_action = opp_action
220
+
221
+ # Apply opponent action
222
+ time_step = self._ospiel_env.step([opp_action])
223
+ self._state.step_count += 1
224
+
225
+ return time_step
226
+
227
+ def _make_observation(self, time_step) -> OpenSpielObservation:
228
+ """
229
+ Convert OpenSpiel TimeStep to OpenEnv Observation.
230
+
231
+ Args:
232
+ time_step: OpenSpiel TimeStep object.
233
+
234
+ Returns:
235
+ OpenSpielObservation for the agent.
236
+ """
237
+ # Extract agent's information
238
+ info_state = time_step.observations["info_state"][self.agent_player]
239
+ legal_actions = time_step.observations["legal_actions"][self.agent_player]
240
+ current_player_id = time_step.observations["current_player"]
241
+
242
+ # Determine game phase
243
+ if time_step.last():
244
+ game_phase = "terminal"
245
+ elif time_step.first():
246
+ game_phase = "initial"
247
+ else:
248
+ game_phase = "playing"
249
+
250
+ # Get reward for agent
251
+ reward = None
252
+ if time_step.rewards is not None:
253
+ reward = float(time_step.rewards[self.agent_player])
254
+
255
+ # Create observation
256
+ obs = OpenSpielObservation(
257
+ info_state=info_state.tolist() if hasattr(info_state, "tolist") else list(info_state),
258
+ legal_actions=legal_actions,
259
+ game_phase=game_phase,
260
+ current_player_id=current_player_id,
261
+ opponent_last_action=self._last_opponent_action,
262
+ done=time_step.last(),
263
+ reward=reward,
264
+ )
265
+
266
+ return obs
src/envs/openspiel_env/openspiel_env/server/opponent_policies.py ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ # All rights reserved.
3
+ #
4
+ # This source code is licensed under the BSD-style license found in the
5
+ # LICENSE file in the root directory of this source tree.
6
+
7
+ """
8
+ Opponent policies for multi-player OpenSpiel games.
9
+
10
+ These policies are used to control non-agent players in multi-player games,
11
+ allowing single-agent RL training against fixed or adaptive opponents.
12
+ """
13
+
14
+ import random
15
+ from typing import Any, Protocol
16
+
17
+
18
+ class OpponentPolicy(Protocol):
19
+ """Protocol for opponent policies."""
20
+
21
+ def select_action(self, legal_actions: list[int], observations: dict[str, Any]) -> int:
22
+ """
23
+ Select an action for the opponent.
24
+
25
+ Args:
26
+ legal_actions: List of legal action IDs.
27
+ observations: Current observations from the environment.
28
+
29
+ Returns:
30
+ Selected action ID.
31
+ """
32
+ ...
33
+
34
+
35
+ class RandomOpponent:
36
+ """Random opponent that selects uniformly from legal actions."""
37
+
38
+ def select_action(self, legal_actions: list[int], observations: dict[str, Any]) -> int:
39
+ """Select a random legal action."""
40
+ if not legal_actions:
41
+ raise ValueError("No legal actions available")
42
+ return random.choice(legal_actions)
43
+
44
+
45
+ class FixedActionOpponent:
46
+ """Opponent that always selects the same action (e.g., first legal action)."""
47
+
48
+ def __init__(self, action_selector: str = "first"):
49
+ """
50
+ Initialize fixed action opponent.
51
+
52
+ Args:
53
+ action_selector: Which action to select ("first", "last", "middle").
54
+ """
55
+ self.action_selector = action_selector
56
+
57
+ def select_action(self, legal_actions: list[int], observations: dict[str, Any]) -> int:
58
+ """Select a fixed legal action based on selector."""
59
+ if not legal_actions:
60
+ raise ValueError("No legal actions available")
61
+
62
+ if self.action_selector == "first":
63
+ return legal_actions[0]
64
+ elif self.action_selector == "last":
65
+ return legal_actions[-1]
66
+ elif self.action_selector == "middle":
67
+ return legal_actions[len(legal_actions) // 2]
68
+ else:
69
+ return legal_actions[0]
70
+
71
+
72
+ def get_opponent_policy(policy_name: str) -> OpponentPolicy:
73
+ """
74
+ Get an opponent policy by name.
75
+
76
+ Args:
77
+ policy_name: Name of the policy ("random", "first", "last", "middle").
78
+
79
+ Returns:
80
+ OpponentPolicy instance.
81
+
82
+ Raises:
83
+ ValueError: If policy_name is not recognized.
84
+ """
85
+ if policy_name == "random":
86
+ return RandomOpponent()
87
+ elif policy_name in ("first", "last", "middle"):
88
+ return FixedActionOpponent(action_selector=policy_name)
89
+ else:
90
+ raise ValueError(f"Unknown opponent policy: {policy_name}")
src/envs/openspiel_env/openspiel_env/test_docker_all_games.sh ADDED
@@ -0,0 +1,152 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/bin/bash
2
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
3
+ # All rights reserved.
4
+ #
5
+ # This source code is licensed under the BSD-style license found in the
6
+ # LICENSE file in the root directory of this source tree.
7
+
8
+ # Automated test script for all OpenSpiel games in Docker
9
+ # Usage: ./test_docker_all_games.sh
10
+
11
+ set -e
12
+
13
+ # Colors for output
14
+ GREEN='\033[0;32m'
15
+ RED='\033[0;31m'
16
+ YELLOW='\033[1;33m'
17
+ BLUE='\033[0;34m'
18
+ NC='\033[0m' # No Color
19
+
20
+ # Configuration
21
+ IMAGE_NAME="openspiel-env:latest"
22
+ CONTAINER_NAME="openspiel-test"
23
+ PORT=8000
24
+ HEALTH_CHECK_URL="http://localhost:${PORT}/health"
25
+ MAX_WAIT=30
26
+
27
+ # Games to test
28
+ GAMES=("catch" "tic_tac_toe" "kuhn_poker" "cliff_walking" "2048" "blackjack")
29
+
30
+ # Results tracking
31
+ declare -a RESULTS
32
+ PASSED=0
33
+ FAILED=0
34
+
35
+ echo -e "${BLUE}========================================${NC}"
36
+ echo -e "${BLUE}OpenSpiel Docker Integration Test${NC}"
37
+ echo -e "${BLUE}========================================${NC}"
38
+ echo ""
39
+
40
+ # Function to cleanup containers
41
+ cleanup() {
42
+ echo -e "${YELLOW}Cleaning up containers...${NC}"
43
+ docker stop ${CONTAINER_NAME} 2>/dev/null || true
44
+ docker rm ${CONTAINER_NAME} 2>/dev/null || true
45
+ }
46
+
47
+ # Function to wait for server health
48
+ wait_for_health() {
49
+ local game=$1
50
+ echo -e " โณ Waiting for server to be ready..."
51
+
52
+ for i in $(seq 1 $MAX_WAIT); do
53
+ if curl -s -f ${HEALTH_CHECK_URL} > /dev/null 2>&1; then
54
+ echo -e " ${GREEN}โœ“${NC} Server ready (${i}s)"
55
+ return 0
56
+ fi
57
+ sleep 1
58
+ done
59
+
60
+ echo -e " ${RED}โœ—${NC} Server health check failed after ${MAX_WAIT}s"
61
+ return 1
62
+ }
63
+
64
+ # Function to test a game
65
+ test_game() {
66
+ local game=$1
67
+ echo -e "\n${BLUE}โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”${NC}"
68
+ echo -e "${BLUE}Testing: ${game}${NC}"
69
+ echo -e "${BLUE}โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”${NC}"
70
+
71
+ # Stop any existing container
72
+ cleanup
73
+
74
+ # Start container with game
75
+ echo -e " ๐Ÿณ Starting Docker container..."
76
+ docker run -d \
77
+ --name ${CONTAINER_NAME} \
78
+ -p ${PORT}:8000 \
79
+ -e OPENSPIEL_GAME=${game} \
80
+ ${IMAGE_NAME} > /dev/null
81
+
82
+ # Wait for server to be ready
83
+ if ! wait_for_health ${game}; then
84
+ echo -e " ${RED}โœ— FAILED${NC} - Server did not start"
85
+ RESULTS+=("${game}:FAILED:Server did not start")
86
+ FAILED=$((FAILED + 1))
87
+ cleanup
88
+ return 1
89
+ fi
90
+
91
+ # Run Python client test
92
+ echo -e " ๐ŸŽฎ Running Python client test..."
93
+ if NO_PROXY=localhost,127.0.0.1 HTTP_PROXY= HTTPS_PROXY= \
94
+ PYTHONPATH=$PWD/src:$PYTHONPATH \
95
+ python3 examples/openspiel_simple.py > /tmp/test_${game}.log 2>&1; then
96
+
97
+ # Check if episode completed successfully
98
+ if grep -q "Episode finished!" /tmp/test_${game}.log; then
99
+ echo -e " ${GREEN}โœ“ PASSED${NC} - Episode completed successfully"
100
+ RESULTS+=("${game}:PASSED")
101
+ PASSED=$((PASSED + 1))
102
+ else
103
+ echo -e " ${RED}โœ— FAILED${NC} - Episode did not complete"
104
+ RESULTS+=("${game}:FAILED:Episode incomplete")
105
+ FAILED=$((FAILED + 1))
106
+ fi
107
+ else
108
+ echo -e " ${RED}โœ— FAILED${NC} - Python client error"
109
+ RESULTS+=("${game}:FAILED:Client error")
110
+ FAILED=$((FAILED + 1))
111
+ fi
112
+
113
+ # Cleanup
114
+ cleanup
115
+ }
116
+
117
+ # Run tests for all games
118
+ for game in "${GAMES[@]}"; do
119
+ test_game ${game}
120
+ done
121
+
122
+ # Print summary
123
+ echo -e "\n${BLUE}========================================${NC}"
124
+ echo -e "${BLUE}Test Summary${NC}"
125
+ echo -e "${BLUE}========================================${NC}"
126
+ echo ""
127
+
128
+ for result in "${RESULTS[@]}"; do
129
+ IFS=':' read -r game status message <<< "$result"
130
+ if [ "$status" == "PASSED" ]; then
131
+ echo -e " ${GREEN}โœ“${NC} ${game}"
132
+ else
133
+ echo -e " ${RED}โœ—${NC} ${game} - ${message}"
134
+ fi
135
+ done
136
+
137
+ echo ""
138
+ echo -e "Total: ${PASSED} passed, ${FAILED} failed out of ${#GAMES[@]} games"
139
+ echo ""
140
+
141
+ # Exit with appropriate code
142
+ if [ $FAILED -eq 0 ]; then
143
+ echo -e "${GREEN}========================================${NC}"
144
+ echo -e "${GREEN}All tests PASSED! ๐ŸŽ‰${NC}"
145
+ echo -e "${GREEN}========================================${NC}"
146
+ exit 0
147
+ else
148
+ echo -e "${RED}========================================${NC}"
149
+ echo -e "${RED}Some tests FAILED${NC}"
150
+ echo -e "${RED}========================================${NC}"
151
+ exit 1
152
+ fi