nihalaninihal Claude Opus 4.6 commited on
Commit
ccb5f4e
·
0 Parent(s):

Initial project setup for OpenEnv Hackathon

Browse files

Scaffolded OpenEnv 0.2.1 environment with FastAPI server, client,
training script (TRL GRPO + Unsloth), and Docker/HF Spaces deployment.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

.gitignore ADDED
@@ -0,0 +1,38 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.so
6
+ *.egg-info/
7
+ dist/
8
+ build/
9
+ *.egg
10
+
11
+ # Virtual environments
12
+ .venv/
13
+ venv/
14
+ env/
15
+
16
+ # IDE
17
+ .vscode/
18
+ .idea/
19
+ *.swp
20
+ *.swo
21
+ *~
22
+
23
+ # OS
24
+ .DS_Store
25
+ Thumbs.db
26
+
27
+ # Environment
28
+ .env
29
+ .env.local
30
+
31
+ # Jupyter
32
+ .ipynb_checkpoints/
33
+
34
+ # Docker
35
+ *.log
36
+
37
+ # uv
38
+ uv.lock
README.md ADDED
@@ -0,0 +1,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # OpenEnv Hackathon Project
2
+
3
+ Built for the [OpenEnv Hackathon](https://cerebralvalley.ai/e/openenv-hackathon-sf) (March 7-8, 2026)
4
+
5
+ ## Quick Start
6
+
7
+ ```bash
8
+ # Setup
9
+ python3.12 -m venv .venv
10
+ source .venv/bin/activate
11
+ pip install "openenv-core[core]>=0.2.1"
12
+
13
+ # Run environment locally
14
+ cd hackathon_env
15
+ uvicorn server.app:app --reload --host 0.0.0.0 --port 8000
16
+ ```
17
+
18
+ ## Project Structure
19
+
20
+ ```
21
+ openev/
22
+ ├── hackathon_env/ # OpenEnv environment
23
+ │ ├── models.py # Action/Observation data models
24
+ │ ├── client.py # Environment client
25
+ │ ├── server/
26
+ │ │ ├── hackathon_env_environment.py # Core environment logic
27
+ │ │ ├── app.py # FastAPI server
28
+ │ │ └── Dockerfile # Container config
29
+ │ ├── openenv.yaml # OpenEnv spec
30
+ │ └── pyproject.toml # Dependencies
31
+ ├── train.py # Training script (TRL + GRPO)
32
+ └── README.md
33
+ ```
34
+
35
+ ## Deployment
36
+
37
+ ### HuggingFace Spaces
38
+
39
+ ```bash
40
+ # Build & push to HF Spaces
41
+ cd hackathon_env
42
+ openenv push --space <your-hf-username>/hackathon-env
43
+ ```
44
+
45
+ ### Local Docker
46
+
47
+ ```bash
48
+ cd hackathon_env
49
+ docker build -t hackathon-env:latest -f server/Dockerfile .
50
+ docker run -p 8000:8000 hackathon-env:latest
51
+ ```
52
+
53
+ ## Training
54
+
55
+ See `train.py` for the minimal training script using HF TRL's GRPOTrainer with OpenEnv integration.
56
+
57
+ ## Tech Stack
58
+
59
+ - **OpenEnv** 0.2.1 - Environment framework
60
+ - **HuggingFace TRL** - RL training (GRPO)
61
+ - **Unsloth** - Fast fine-tuning (2x speed, 70% less VRAM)
hackathon_env/README.md ADDED
@@ -0,0 +1,255 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Hackathon Env Environment Server
3
+ emoji: 📻
4
+ colorFrom: gray
5
+ colorTo: blue
6
+ sdk: docker
7
+ pinned: false
8
+ app_port: 8000
9
+ base_path: /web
10
+ tags:
11
+ - openenv
12
+ ---
13
+
14
+ # Hackathon Env Environment
15
+
16
+ A simple test environment that echoes back messages. Perfect for testing the env APIs as well as demonstrating environment usage patterns.
17
+
18
+ ## Quick Start
19
+
20
+ The simplest way to use the Hackathon Env environment is through the `HackathonEnv` class:
21
+
22
+ ```python
23
+ from hackathon_env import HackathonAction, HackathonEnv
24
+
25
+ try:
26
+ # Create environment from Docker image
27
+ hackathon_envenv = HackathonEnv.from_docker_image("hackathon_env-env:latest")
28
+
29
+ # Reset
30
+ result = hackathon_envenv.reset()
31
+ print(f"Reset: {result.observation.echoed_message}")
32
+
33
+ # Send multiple messages
34
+ messages = ["Hello, World!", "Testing echo", "Final message"]
35
+
36
+ for msg in messages:
37
+ result = hackathon_envenv.step(HackathonAction(message=msg))
38
+ print(f"Sent: '{msg}'")
39
+ print(f" → Echoed: '{result.observation.echoed_message}'")
40
+ print(f" → Length: {result.observation.message_length}")
41
+ print(f" → Reward: {result.reward}")
42
+
43
+ finally:
44
+ # Always clean up
45
+ hackathon_envenv.close()
46
+ ```
47
+
48
+ That's it! The `HackathonEnv.from_docker_image()` method handles:
49
+ - Starting the Docker container
50
+ - Waiting for the server to be ready
51
+ - Connecting to the environment
52
+ - Container cleanup when you call `close()`
53
+
54
+ ## Building the Docker Image
55
+
56
+ Before using the environment, you need to build the Docker image:
57
+
58
+ ```bash
59
+ # From project root
60
+ docker build -t hackathon_env-env:latest -f server/Dockerfile .
61
+ ```
62
+
63
+ ## Deploying to Hugging Face Spaces
64
+
65
+ You can easily deploy your OpenEnv environment to Hugging Face Spaces using the `openenv push` command:
66
+
67
+ ```bash
68
+ # From the environment directory (where openenv.yaml is located)
69
+ openenv push
70
+
71
+ # Or specify options
72
+ openenv push --namespace my-org --private
73
+ ```
74
+
75
+ The `openenv push` command will:
76
+ 1. Validate that the directory is an OpenEnv environment (checks for `openenv.yaml`)
77
+ 2. Prepare a custom build for Hugging Face Docker space (enables web interface)
78
+ 3. Upload to Hugging Face (ensuring you're logged in)
79
+
80
+ ### Prerequisites
81
+
82
+ - Authenticate with Hugging Face: The command will prompt for login if not already authenticated
83
+
84
+ ### Options
85
+
86
+ - `--directory`, `-d`: Directory containing the OpenEnv environment (defaults to current directory)
87
+ - `--repo-id`, `-r`: Repository ID in format 'username/repo-name' (defaults to 'username/env-name' from openenv.yaml)
88
+ - `--base-image`, `-b`: Base Docker image to use (overrides Dockerfile FROM)
89
+ - `--private`: Deploy the space as private (default: public)
90
+
91
+ ### Examples
92
+
93
+ ```bash
94
+ # Push to your personal namespace (defaults to username/env-name from openenv.yaml)
95
+ openenv push
96
+
97
+ # Push to a specific repository
98
+ openenv push --repo-id my-org/my-env
99
+
100
+ # Push with a custom base image
101
+ openenv push --base-image ghcr.io/meta-pytorch/openenv-base:latest
102
+
103
+ # Push as a private space
104
+ openenv push --private
105
+
106
+ # Combine options
107
+ openenv push --repo-id my-org/my-env --base-image custom-base:latest --private
108
+ ```
109
+
110
+ After deployment, your space will be available at:
111
+ `https://huggingface.co/spaces/<repo-id>`
112
+
113
+ The deployed space includes:
114
+ - **Web Interface** at `/web` - Interactive UI for exploring the environment
115
+ - **API Documentation** at `/docs` - Full OpenAPI/Swagger interface
116
+ - **Health Check** at `/health` - Container health monitoring
117
+ - **WebSocket** at `/ws` - Persistent session endpoint for low-latency interactions
118
+
119
+ ## Environment Details
120
+
121
+ ### Action
122
+ **HackathonAction**: Contains a single field
123
+ - `message` (str) - The message to echo back
124
+
125
+ ### Observation
126
+ **HackathonObservation**: Contains the echo response and metadata
127
+ - `echoed_message` (str) - The message echoed back
128
+ - `message_length` (int) - Length of the message
129
+ - `reward` (float) - Reward based on message length (length × 0.1)
130
+ - `done` (bool) - Always False for echo environment
131
+ - `metadata` (dict) - Additional info like step count
132
+
133
+ ### Reward
134
+ The reward is calculated as: `message_length × 0.1`
135
+ - "Hi" → reward: 0.2
136
+ - "Hello, World!" → reward: 1.3
137
+ - Empty message → reward: 0.0
138
+
139
+ ## Advanced Usage
140
+
141
+ ### Connecting to an Existing Server
142
+
143
+ If you already have a Hackathon Env environment server running, you can connect directly:
144
+
145
+ ```python
146
+ from hackathon_env import HackathonEnv
147
+
148
+ # Connect to existing server
149
+ hackathon_envenv = HackathonEnv(base_url="<ENV_HTTP_URL_HERE>")
150
+
151
+ # Use as normal
152
+ result = hackathon_envenv.reset()
153
+ result = hackathon_envenv.step(HackathonAction(message="Hello!"))
154
+ ```
155
+
156
+ Note: When connecting to an existing server, `hackathon_envenv.close()` will NOT stop the server.
157
+
158
+ ### Using the Context Manager
159
+
160
+ The client supports context manager usage for automatic connection management:
161
+
162
+ ```python
163
+ from hackathon_env import HackathonAction, HackathonEnv
164
+
165
+ # Connect with context manager (auto-connects and closes)
166
+ with HackathonEnv(base_url="http://localhost:8000") as env:
167
+ result = env.reset()
168
+ print(f"Reset: {result.observation.echoed_message}")
169
+ # Multiple steps with low latency
170
+ for msg in ["Hello", "World", "!"]:
171
+ result = env.step(HackathonAction(message=msg))
172
+ print(f"Echoed: {result.observation.echoed_message}")
173
+ ```
174
+
175
+ The client uses WebSocket connections for:
176
+ - **Lower latency**: No HTTP connection overhead per request
177
+ - **Persistent session**: Server maintains your environment state
178
+ - **Efficient for episodes**: Better for many sequential steps
179
+
180
+ ### Concurrent WebSocket Sessions
181
+
182
+ The server supports multiple concurrent WebSocket connections. To enable this,
183
+ modify `server/app.py` to use factory mode:
184
+
185
+ ```python
186
+ # In server/app.py - use factory mode for concurrent sessions
187
+ app = create_app(
188
+ HackathonEnvironment, # Pass class, not instance
189
+ HackathonAction,
190
+ HackathonObservation,
191
+ max_concurrent_envs=4, # Allow 4 concurrent sessions
192
+ )
193
+ ```
194
+
195
+ Then multiple clients can connect simultaneously:
196
+
197
+ ```python
198
+ from hackathon_env import HackathonAction, HackathonEnv
199
+ from concurrent.futures import ThreadPoolExecutor
200
+
201
+ def run_episode(client_id: int):
202
+ with HackathonEnv(base_url="http://localhost:8000") as env:
203
+ result = env.reset()
204
+ for i in range(10):
205
+ result = env.step(HackathonAction(message=f"Client {client_id}, step {i}"))
206
+ return client_id, result.observation.message_length
207
+
208
+ # Run 4 episodes concurrently
209
+ with ThreadPoolExecutor(max_workers=4) as executor:
210
+ results = list(executor.map(run_episode, range(4)))
211
+ ```
212
+
213
+ ## Development & Testing
214
+
215
+ ### Direct Environment Testing
216
+
217
+ Test the environment logic directly without starting the HTTP server:
218
+
219
+ ```bash
220
+ # From the server directory
221
+ python3 server/hackathon_env_environment.py
222
+ ```
223
+
224
+ This verifies that:
225
+ - Environment resets correctly
226
+ - Step executes actions properly
227
+ - State tracking works
228
+ - Rewards are calculated correctly
229
+
230
+ ### Running Locally
231
+
232
+ Run the server locally for development:
233
+
234
+ ```bash
235
+ uvicorn server.app:app --reload
236
+ ```
237
+
238
+ ## Project Structure
239
+
240
+ ```
241
+ hackathon_env/
242
+ ├── .dockerignore # Docker build exclusions
243
+ ├── __init__.py # Module exports
244
+ ├── README.md # This file
245
+ ├── openenv.yaml # OpenEnv manifest
246
+ ├── pyproject.toml # Project metadata and dependencies
247
+ ├── uv.lock # Locked dependencies (generated)
248
+ ├── client.py # HackathonEnv client
249
+ ├── models.py # Action and Observation models
250
+ └── server/
251
+ ├── __init__.py # Server module exports
252
+ ├── hackathon_env_environment.py # Core environment logic
253
+ ├── app.py # FastAPI application (HTTP + WebSocket endpoints)
254
+ └── Dockerfile # Container image definition
255
+ ```
hackathon_env/__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
+ """Hackathon Env Environment."""
8
+
9
+ from .client import HackathonEnv
10
+ from .models import HackathonAction, HackathonObservation
11
+
12
+ __all__ = [
13
+ "HackathonAction",
14
+ "HackathonObservation",
15
+ "HackathonEnv",
16
+ ]
hackathon_env/client.py ADDED
@@ -0,0 +1,99 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ """Hackathon Env Environment Client."""
8
+
9
+ from typing import Dict
10
+
11
+ from openenv.core.client_types import StepResult
12
+ from openenv.core.env_server.types import State
13
+ from openenv.core import EnvClient
14
+
15
+ from .models import HackathonAction, HackathonObservation
16
+
17
+
18
+ class HackathonEnv(
19
+ EnvClient[HackathonAction, HackathonObservation]
20
+ ):
21
+ """
22
+ Client for the Hackathon Env Environment.
23
+
24
+ This client maintains a persistent WebSocket connection to the environment server,
25
+ enabling efficient multi-step interactions with lower latency.
26
+ Each client instance has its own dedicated environment session on the server.
27
+
28
+ Example:
29
+ >>> # Connect to a running server
30
+ >>> with HackathonEnv(base_url="http://localhost:8000") as client:
31
+ ... result = client.reset()
32
+ ... print(result.observation.echoed_message)
33
+ ...
34
+ ... result = client.step(HackathonAction(message="Hello!"))
35
+ ... print(result.observation.echoed_message)
36
+
37
+ Example with Docker:
38
+ >>> # Automatically start container and connect
39
+ >>> client = HackathonEnv.from_docker_image("hackathon_env-env:latest")
40
+ >>> try:
41
+ ... result = client.reset()
42
+ ... result = client.step(HackathonAction(message="Test"))
43
+ ... finally:
44
+ ... client.close()
45
+ """
46
+
47
+ def _step_payload(self, action: HackathonAction) -> Dict:
48
+ """
49
+ Convert HackathonAction to JSON payload for step message.
50
+
51
+ Args:
52
+ action: HackathonAction instance
53
+
54
+ Returns:
55
+ Dictionary representation suitable for JSON encoding
56
+ """
57
+ return {
58
+ "message": action.message,
59
+ }
60
+
61
+ def _parse_result(self, payload: Dict) -> StepResult[HackathonObservation]:
62
+ """
63
+ Parse server response into StepResult[HackathonObservation].
64
+
65
+ Args:
66
+ payload: JSON response data from server
67
+
68
+ Returns:
69
+ StepResult with HackathonObservation
70
+ """
71
+ obs_data = payload.get("observation", {})
72
+ observation = HackathonObservation(
73
+ echoed_message=obs_data.get("echoed_message", ""),
74
+ message_length=obs_data.get("message_length", 0),
75
+ done=payload.get("done", False),
76
+ reward=payload.get("reward"),
77
+ metadata=obs_data.get("metadata", {}),
78
+ )
79
+
80
+ return StepResult(
81
+ observation=observation,
82
+ reward=payload.get("reward"),
83
+ done=payload.get("done", False),
84
+ )
85
+
86
+ def _parse_state(self, payload: Dict) -> State:
87
+ """
88
+ Parse server response into State object.
89
+
90
+ Args:
91
+ payload: JSON response from state request
92
+
93
+ Returns:
94
+ State object with episode_id and step_count
95
+ """
96
+ return State(
97
+ episode_id=payload.get("episode_id"),
98
+ step_count=payload.get("step_count", 0),
99
+ )
hackathon_env/models.py ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 the Hackathon Env Environment.
9
+
10
+ The hackathon_env environment is a simple test environment that echoes back messages.
11
+ """
12
+
13
+ from pydantic import Field
14
+
15
+ from openenv.core.env_server.types import Action, Observation
16
+
17
+
18
+ class HackathonAction(Action):
19
+ """Action for the Hackathon Env environment - just a message to echo."""
20
+
21
+ message: str = Field(..., description="Message to echo back")
22
+
23
+
24
+ class HackathonObservation(Observation):
25
+ """Observation from the Hackathon Env environment - the echoed message."""
26
+
27
+ echoed_message: str = Field(default="", description="The echoed message")
28
+ message_length: int = Field(default=0, description="Length of the echoed message")
hackathon_env/openenv.yaml ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ spec_version: 1
2
+ name: hackathon_env
3
+ type: space
4
+ runtime: fastapi
5
+ app: server.app:app
6
+ port: 8000
7
+
hackathon_env/pyproject.toml ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ [build-system]
8
+ requires = ["setuptools>=45", "wheel"]
9
+ build-backend = "setuptools.build_meta"
10
+
11
+ [project]
12
+ name = "openenv-hackathon_env"
13
+ version = "0.1.0"
14
+ description = "Hackathon Env environment for OpenEnv"
15
+ requires-python = ">=3.10"
16
+ dependencies = [
17
+ # Core OpenEnv runtime (provides FastAPI server + HTTP client types)
18
+ # install from github
19
+ # "openenv-core[core] @ git+https://github.com/meta-pytorch/OpenEnv.git",
20
+ "openenv-core[core]>=0.2.0",
21
+ # Environment-specific dependencies
22
+ # Add all dependencies needed for your environment here
23
+ # Examples:
24
+ # "numpy>=1.19.0",
25
+ # "torch>=2.0.0",
26
+ # "gymnasium>=0.29.0",
27
+ # "openspiel>=1.0.0",
28
+ # "smolagents>=1.22.0,<2",
29
+ ]
30
+
31
+ [project.optional-dependencies]
32
+ dev = [
33
+ "pytest>=8.0.0",
34
+ "pytest-cov>=4.0.0",
35
+ ]
36
+
37
+ [project.scripts]
38
+ # Server entry point - enables running via: uv run --project . server
39
+ # or: python -m hackathon_env.server.app
40
+ server = "hackathon_env.server.app:main"
41
+
42
+ [tool.setuptools]
43
+ include-package-data = true
44
+ packages = ["hackathon_env", "hackathon_env.server"]
45
+ package-dir = { "hackathon_env" = ".", "hackathon_env.server" = "server" }
hackathon_env/server/Dockerfile ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ # Multi-stage build using openenv-base
8
+ # This Dockerfile is flexible and works for both:
9
+ # - In-repo environments (with local OpenEnv sources)
10
+ # - Standalone environments (with openenv from PyPI/Git)
11
+ # The build script (openenv build) handles context detection and sets appropriate build args.
12
+
13
+ ARG BASE_IMAGE=ghcr.io/meta-pytorch/openenv-base:latest
14
+ FROM ${BASE_IMAGE} AS builder
15
+
16
+ WORKDIR /app
17
+
18
+ # Ensure git is available (required for installing dependencies from VCS)
19
+ RUN apt-get update && \
20
+ apt-get install -y --no-install-recommends git && \
21
+ rm -rf /var/lib/apt/lists/*
22
+
23
+ # Build argument to control whether we're building standalone or in-repo
24
+ ARG BUILD_MODE=in-repo
25
+ ARG ENV_NAME=hackathon_env
26
+
27
+ # Copy environment code (always at root of build context)
28
+ COPY . /app/env
29
+
30
+ # For in-repo builds, openenv is already vendored in the build context
31
+ # For standalone builds, openenv will be installed via pyproject.toml
32
+ WORKDIR /app/env
33
+
34
+ # Ensure uv is available (for local builds where base image lacks it)
35
+ RUN if ! command -v uv >/dev/null 2>&1; then \
36
+ curl -LsSf https://astral.sh/uv/install.sh | sh && \
37
+ mv /root/.local/bin/uv /usr/local/bin/uv && \
38
+ mv /root/.local/bin/uvx /usr/local/bin/uvx; \
39
+ fi
40
+
41
+ # Install dependencies using uv sync
42
+ # If uv.lock exists, use it; otherwise resolve on the fly
43
+ RUN --mount=type=cache,target=/root/.cache/uv \
44
+ if [ -f uv.lock ]; then \
45
+ uv sync --frozen --no-install-project --no-editable; \
46
+ else \
47
+ uv sync --no-install-project --no-editable; \
48
+ fi
49
+
50
+ RUN --mount=type=cache,target=/root/.cache/uv \
51
+ if [ -f uv.lock ]; then \
52
+ uv sync --frozen --no-editable; \
53
+ else \
54
+ uv sync --no-editable; \
55
+ fi
56
+
57
+ # Final runtime stage
58
+ FROM ${BASE_IMAGE}
59
+
60
+ WORKDIR /app
61
+
62
+ # Copy the virtual environment from builder
63
+ COPY --from=builder /app/env/.venv /app/.venv
64
+
65
+ # Copy the environment code
66
+ COPY --from=builder /app/env /app/env
67
+
68
+ # Set PATH to use the virtual environment
69
+ ENV PATH="/app/.venv/bin:$PATH"
70
+
71
+ # Set PYTHONPATH so imports work correctly
72
+ ENV PYTHONPATH="/app/env:$PYTHONPATH"
73
+
74
+ # Health check
75
+ HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
76
+ CMD curl -f http://localhost:8000/health || exit 1
77
+
78
+ # Run the FastAPI server
79
+ # The module path is constructed to work with the /app/env structure
80
+ CMD ["sh", "-c", "cd /app/env && uvicorn server.app:app --host 0.0.0.0 --port 8000"]
hackathon_env/server/__init__.py ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
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
+ """Hackathon Env environment server components."""
8
+
9
+ from .hackathon_env_environment import HackathonEnvironment
10
+
11
+ __all__ = ["HackathonEnvironment"]
hackathon_env/server/app.py ADDED
@@ -0,0 +1,81 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 Hackathon Env Environment.
9
+
10
+ This module creates an HTTP server that exposes the HackathonEnvironment
11
+ over HTTP and WebSocket endpoints, compatible with EnvClient.
12
+
13
+ Endpoints:
14
+ - POST /reset: Reset the environment
15
+ - POST /step: Execute an action
16
+ - GET /state: Get current environment state
17
+ - GET /schema: Get action/observation schemas
18
+ - WS /ws: WebSocket endpoint for persistent sessions
19
+
20
+ Usage:
21
+ # Development (with auto-reload):
22
+ uvicorn server.app:app --reload --host 0.0.0.0 --port 8000
23
+
24
+ # Production:
25
+ uvicorn server.app:app --host 0.0.0.0 --port 8000 --workers 4
26
+
27
+ # Or run directly:
28
+ python -m server.app
29
+ """
30
+
31
+ try:
32
+ from openenv.core.env_server.http_server import create_app
33
+ except Exception as e: # pragma: no cover
34
+ raise ImportError(
35
+ "openenv is required for the web interface. Install dependencies with '\n uv sync\n'"
36
+ ) from e
37
+
38
+ # Import from local models.py (PYTHONPATH includes /app/env in Docker)
39
+ from models import HackathonAction, HackathonObservation
40
+ from .hackathon_env_environment import HackathonEnvironment
41
+
42
+
43
+ # Create the app with web interface and README integration
44
+ app = create_app(
45
+ HackathonEnvironment,
46
+ HackathonAction,
47
+ HackathonObservation,
48
+ env_name="hackathon_env",
49
+ max_concurrent_envs=1, # increase this number to allow more concurrent WebSocket sessions
50
+ )
51
+
52
+
53
+ def main(host: str = "0.0.0.0", port: int = 8000):
54
+ """
55
+ Entry point for direct execution via uv run or python -m.
56
+
57
+ This function enables running the server without Docker:
58
+ uv run --project . server
59
+ uv run --project . server --port 8001
60
+ python -m hackathon_env.server.app
61
+
62
+ Args:
63
+ host: Host address to bind to (default: "0.0.0.0")
64
+ port: Port number to listen on (default: 8000)
65
+
66
+ For production deployments, consider using uvicorn directly with
67
+ multiple workers:
68
+ uvicorn hackathon_env.server.app:app --workers 4
69
+ """
70
+ import uvicorn
71
+
72
+ uvicorn.run(app, host=host, port=port)
73
+
74
+
75
+ if __name__ == "__main__":
76
+ import argparse
77
+
78
+ parser = argparse.ArgumentParser()
79
+ parser.add_argument("--port", type=int, default=8000)
80
+ args = parser.parse_args()
81
+ main(port=args.port)
hackathon_env/server/hackathon_env_environment.py ADDED
@@ -0,0 +1,101 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ Hackathon Env Environment Implementation.
9
+
10
+ A simple test environment that echoes back messages sent to it.
11
+ Perfect for testing HTTP server infrastructure.
12
+ """
13
+
14
+ from uuid import uuid4
15
+
16
+ from openenv.core.env_server.interfaces import Environment
17
+ from openenv.core.env_server.types import State
18
+
19
+ from models import HackathonAction, HackathonObservation
20
+
21
+
22
+ class HackathonEnvironment(Environment):
23
+ """
24
+ A simple echo environment that echoes back messages.
25
+
26
+ This environment is designed for testing the HTTP server infrastructure.
27
+ It maintains minimal state and simply echoes back whatever message it receives.
28
+
29
+ Example:
30
+ >>> env = HackathonEnvironment()
31
+ >>> obs = env.reset()
32
+ >>> print(obs.echoed_message) # "Hackathon Env environment ready!"
33
+ >>>
34
+ >>> obs = env.step(HackathonAction(message="Hello"))
35
+ >>> print(obs.echoed_message) # "Hello"
36
+ >>> print(obs.message_length) # 5
37
+ """
38
+
39
+ # Enable concurrent WebSocket sessions.
40
+ # Set to True if your environment isolates state between instances.
41
+ # When True, multiple WebSocket clients can connect simultaneously, each
42
+ # getting their own environment instance (when using factory mode in app.py).
43
+ SUPPORTS_CONCURRENT_SESSIONS: bool = True
44
+
45
+ def __init__(self):
46
+ """Initialize the hackathon_env environment."""
47
+ self._state = State(episode_id=str(uuid4()), step_count=0)
48
+ self._reset_count = 0
49
+
50
+ def reset(self) -> HackathonObservation:
51
+ """
52
+ Reset the environment.
53
+
54
+ Returns:
55
+ HackathonObservation with a ready message
56
+ """
57
+ self._state = State(episode_id=str(uuid4()), step_count=0)
58
+ self._reset_count += 1
59
+
60
+ return HackathonObservation(
61
+ echoed_message="Hackathon Env environment ready!",
62
+ message_length=0,
63
+ done=False,
64
+ reward=0.0,
65
+ )
66
+
67
+ def step(self, action: HackathonAction) -> HackathonObservation: # type: ignore[override]
68
+ """
69
+ Execute a step in the environment by echoing the message.
70
+
71
+ Args:
72
+ action: HackathonAction containing the message to echo
73
+
74
+ Returns:
75
+ HackathonObservation with the echoed message and its length
76
+ """
77
+ self._state.step_count += 1
78
+
79
+ message = action.message
80
+ length = len(message)
81
+
82
+ # Simple reward: longer messages get higher rewards
83
+ reward = length * 0.1
84
+
85
+ return HackathonObservation(
86
+ echoed_message=message,
87
+ message_length=length,
88
+ done=False,
89
+ reward=reward,
90
+ metadata={"original_message": message, "step": self._state.step_count},
91
+ )
92
+
93
+ @property
94
+ def state(self) -> State:
95
+ """
96
+ Get the current environment state.
97
+
98
+ Returns:
99
+ Current State with episode_id and step_count
100
+ """
101
+ return self._state
hackathon_env/server/requirements.txt ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ openenv[core]>=0.2.0
2
+ fastapi>=0.115.0
3
+ uvicorn>=0.24.0
4
+
5
+
6
+
train.py ADDED
@@ -0,0 +1,154 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ """
2
+ Minimal Training Script for OpenEnv Hackathon
3
+ ==============================================
4
+ Uses HuggingFace TRL's GRPOTrainer with OpenEnv environment integration.
5
+
6
+ Run in Google Colab with GPU runtime:
7
+ !pip install "openenv-core[core]>=0.2.1" trl transformers torch accelerate
8
+ # Or with Unsloth for 2x faster training:
9
+ !pip install unsloth "openenv-core[core]>=0.2.1" trl
10
+
11
+ Usage:
12
+ python train.py --env_url https://<your-hf-space>.hf.space
13
+ """
14
+
15
+ import argparse
16
+
17
+ from hackathon_env.client import HackathonEnv
18
+ from hackathon_env.models import HackathonAction
19
+
20
+
21
+ def collect_rollouts(env_url: str, prompts: list[str]) -> list[dict]:
22
+ """
23
+ Collect rollouts by interacting with the OpenEnv environment.
24
+
25
+ Args:
26
+ env_url: URL of the deployed OpenEnv environment
27
+ prompts: List of prompts to send to the environment
28
+
29
+ Returns:
30
+ List of rollout dicts with prompt, completion, and reward
31
+ """
32
+ rollouts = []
33
+
34
+ with HackathonEnv(base_url=env_url) as env:
35
+ for prompt in prompts:
36
+ env.reset()
37
+ result = env.step(HackathonAction(message=prompt))
38
+
39
+ rollouts.append({
40
+ "prompt": prompt,
41
+ "completion": result.observation.echoed_message,
42
+ "reward": result.reward,
43
+ })
44
+
45
+ return rollouts
46
+
47
+
48
+ def reward_function(completions: list[str], **kwargs) -> list[float]:
49
+ """
50
+ Reward function for GRPO training.
51
+ Extracts rewards from environment rollout results.
52
+ """
53
+ env_rewards = kwargs.get("env_reward", [])
54
+ if env_rewards:
55
+ return env_rewards
56
+ # Fallback: simple length-based reward
57
+ return [len(c) * 0.1 for c in completions]
58
+
59
+
60
+ def main():
61
+ parser = argparse.ArgumentParser(description="Train with OpenEnv + TRL GRPO")
62
+ parser.add_argument(
63
+ "--env_url",
64
+ type=str,
65
+ default="http://localhost:8000",
66
+ help="URL of the OpenEnv environment server",
67
+ )
68
+ parser.add_argument(
69
+ "--model_name",
70
+ type=str,
71
+ default="Qwen/Qwen2.5-0.5B-Instruct",
72
+ help="Model to train",
73
+ )
74
+ parser.add_argument(
75
+ "--use_unsloth",
76
+ action="store_true",
77
+ help="Use Unsloth for faster training",
78
+ )
79
+ parser.add_argument(
80
+ "--num_epochs",
81
+ type=int,
82
+ default=1,
83
+ help="Number of training epochs",
84
+ )
85
+ args = parser.parse_args()
86
+
87
+ print(f"Environment URL: {args.env_url}")
88
+ print(f"Model: {args.model_name}")
89
+ print(f"Using Unsloth: {args.use_unsloth}")
90
+
91
+ # --- Step 1: Verify environment connectivity ---
92
+ print("\n[1/3] Verifying environment connection...")
93
+ with HackathonEnv(base_url=args.env_url) as env:
94
+ result = env.reset()
95
+ print(f" Environment ready: {result.observation.echoed_message}")
96
+
97
+ test_result = env.step(HackathonAction(message="test"))
98
+ print(f" Test step reward: {test_result.reward}")
99
+
100
+ # --- Step 2: Load model ---
101
+ print("\n[2/3] Loading model...")
102
+ if args.use_unsloth:
103
+ from unsloth import FastLanguageModel
104
+
105
+ model, tokenizer = FastLanguageModel.from_pretrained(
106
+ model_name=args.model_name,
107
+ max_seq_length=2048,
108
+ load_in_4bit=True,
109
+ )
110
+ model = FastLanguageModel.get_peft_model(
111
+ model,
112
+ r=16,
113
+ target_modules=["q_proj", "k_proj", "v_proj", "o_proj",
114
+ "gate_proj", "up_proj", "down_proj"],
115
+ lora_alpha=16,
116
+ lora_dropout=0,
117
+ bias="none",
118
+ use_gradient_checkpointing="unsloth",
119
+ )
120
+ else:
121
+ from transformers import AutoModelForCausalLM, AutoTokenizer
122
+
123
+ tokenizer = AutoTokenizer.from_pretrained(args.model_name)
124
+ model = AutoModelForCausalLM.from_pretrained(args.model_name)
125
+
126
+ # --- Step 3: Train with GRPO ---
127
+ print("\n[3/3] Starting GRPO training...")
128
+ from trl import GRPOTrainer, GRPOConfig
129
+
130
+ training_args = GRPOConfig(
131
+ output_dir="./output",
132
+ num_train_epochs=args.num_epochs,
133
+ per_device_train_batch_size=2,
134
+ gradient_accumulation_steps=4,
135
+ learning_rate=5e-6,
136
+ max_completion_length=256,
137
+ logging_steps=1,
138
+ save_steps=100,
139
+ report_to="none",
140
+ )
141
+
142
+ trainer = GRPOTrainer(
143
+ model=model,
144
+ processing_class=tokenizer,
145
+ reward_funcs=[reward_function],
146
+ args=training_args,
147
+ )
148
+
149
+ trainer.train()
150
+ print("\nTraining complete! Model saved to ./output")
151
+
152
+
153
+ if __name__ == "__main__":
154
+ main()