jonyeazel commited on
Commit
7f7fcc7
·
verified ·
1 Parent(s): f932f00

Upload folder using huggingface_hub

Browse files
Dockerfile 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
+ # 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=negotiation_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
+ ENV ENABLE_WEB_INTERFACE=true
81
+ CMD ["sh", "-c", "cd /app/env && uvicorn server.app:app --host 0.0.0.0 --port 8000"]
README.md CHANGED
@@ -1,10 +1,255 @@
1
  ---
2
- title: Cognitive Primitives Negotiation
3
- emoji: 📚
4
- colorFrom: red
5
- colorTo: gray
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: Negotiation Env Environment Server
3
+ emoji: 📺
4
+ colorFrom: blue
5
+ colorTo: red
6
  sdk: docker
7
  pinned: false
8
+ app_port: 8000
9
+ base_path: /web
10
+ tags:
11
+ - openenv
12
  ---
13
 
14
+ # Negotiation 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 Negotiation Env environment is through the `NegotiationEnv` class:
21
+
22
+ ```python
23
+ from negotiation_env import NegotiationAction, NegotiationEnv
24
+
25
+ try:
26
+ # Create environment from Docker image
27
+ negotiation_envenv = NegotiationEnv.from_docker_image("negotiation_env-env:latest")
28
+
29
+ # Reset
30
+ result = negotiation_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 = negotiation_envenv.step(NegotiationAction(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
+ negotiation_envenv.close()
46
+ ```
47
+
48
+ That's it! The `NegotiationEnv.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 negotiation_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
+ **NegotiationAction**: Contains a single field
123
+ - `message` (str) - The message to echo back
124
+
125
+ ### Observation
126
+ **NegotiationObservation**: 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 Negotiation Env environment server running, you can connect directly:
144
+
145
+ ```python
146
+ from negotiation_env import NegotiationEnv
147
+
148
+ # Connect to existing server
149
+ negotiation_envenv = NegotiationEnv(base_url="<ENV_HTTP_URL_HERE>")
150
+
151
+ # Use as normal
152
+ result = negotiation_envenv.reset()
153
+ result = negotiation_envenv.step(NegotiationAction(message="Hello!"))
154
+ ```
155
+
156
+ Note: When connecting to an existing server, `negotiation_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 negotiation_env import NegotiationAction, NegotiationEnv
164
+
165
+ # Connect with context manager (auto-connects and closes)
166
+ with NegotiationEnv(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(NegotiationAction(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
+ NegotiationEnvironment, # Pass class, not instance
189
+ NegotiationAction,
190
+ NegotiationObservation,
191
+ max_concurrent_envs=4, # Allow 4 concurrent sessions
192
+ )
193
+ ```
194
+
195
+ Then multiple clients can connect simultaneously:
196
+
197
+ ```python
198
+ from negotiation_env import NegotiationAction, NegotiationEnv
199
+ from concurrent.futures import ThreadPoolExecutor
200
+
201
+ def run_episode(client_id: int):
202
+ with NegotiationEnv(base_url="http://localhost:8000") as env:
203
+ result = env.reset()
204
+ for i in range(10):
205
+ result = env.step(NegotiationAction(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/negotiation_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
+ negotiation_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 # NegotiationEnv client
249
+ ├── models.py # Action and Observation models
250
+ └── server/
251
+ ├── __init__.py # Server module exports
252
+ ├── negotiation_env_environment.py # Core environment logic
253
+ ├── app.py # FastAPI application (HTTP + WebSocket endpoints)
254
+ └── Dockerfile # Container image definition
255
+ ```
__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
+ """Negotiation Env Environment."""
8
+
9
+ from .client import NegotiationEnv
10
+ from .models import NegotiationAction, NegotiationObservation
11
+
12
+ __all__ = [
13
+ "NegotiationAction",
14
+ "NegotiationObservation",
15
+ "NegotiationEnv",
16
+ ]
client.py ADDED
@@ -0,0 +1,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ """Negotiation Environment Client."""
8
+
9
+ from typing import Dict
10
+
11
+ from openenv.core import EnvClient
12
+ from openenv.core.client_types import StepResult
13
+ from openenv.core.env_server.types import State
14
+
15
+ from .models import NegotiationAction, NegotiationObservation
16
+
17
+
18
+ class NegotiationEnv(EnvClient[NegotiationAction, NegotiationObservation]):
19
+ """
20
+ Client for the Negotiation Environment.
21
+
22
+ Trade with a hidden-strategy bot to maximize your resource value.
23
+ """
24
+
25
+ def _step_payload(self, action: NegotiationAction) -> Dict:
26
+ """Convert NegotiationAction to JSON payload for step message."""
27
+ return {
28
+ "give_iron": action.give_iron,
29
+ "give_crystal": action.give_crystal,
30
+ "give_gold": action.give_gold,
31
+ "want_iron": action.want_iron,
32
+ "want_crystal": action.want_crystal,
33
+ "want_gold": action.want_gold,
34
+ }
35
+
36
+ def _parse_result(self, payload: Dict) -> StepResult[NegotiationObservation]:
37
+ """Parse server response into StepResult[NegotiationObservation]."""
38
+ obs_data = payload.get("observation", {})
39
+ observation = NegotiationObservation(
40
+ player_resources=obs_data.get("player_resources", {"iron": 0, "crystal": 0, "gold": 0}),
41
+ bot_resources=obs_data.get("bot_resources", {"iron": 0, "crystal": 0, "gold": 0}),
42
+ round=obs_data.get("round", 0),
43
+ total_rounds=obs_data.get("total_rounds", 5),
44
+ last_trade_accepted=obs_data.get("last_trade_accepted"),
45
+ player_value=obs_data.get("player_value", 0),
46
+ done=payload.get("done", False),
47
+ metadata=obs_data.get("metadata", {}),
48
+ )
49
+
50
+ return StepResult(
51
+ observation=observation,
52
+ reward=payload.get("reward"),
53
+ done=payload.get("done", False),
54
+ )
55
+
56
+ def _parse_state(self, payload: Dict) -> State:
57
+ """Parse server response into State object."""
58
+ return State(
59
+ episode_id=payload.get("episode_id"),
60
+ step_count=payload.get("step_count", 0),
61
+ )
models.py ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 Negotiation Environment.
9
+
10
+ Trading with a hidden-strategy bot. Negotiate trades to maximize value.
11
+ """
12
+
13
+ from typing import Dict, Optional
14
+
15
+ from openenv.core.env_server.types import Action, Observation
16
+ from pydantic import Field
17
+
18
+
19
+ class NegotiationAction(Action):
20
+ """Action for the Negotiation environment - propose a trade."""
21
+
22
+ give_iron: int = Field(default=0, description="Amount of iron to give", ge=0)
23
+ give_crystal: int = Field(default=0, description="Amount of crystal to give", ge=0)
24
+ give_gold: int = Field(default=0, description="Amount of gold to give", ge=0)
25
+ want_iron: int = Field(default=0, description="Amount of iron to receive", ge=0)
26
+ want_crystal: int = Field(default=0, description="Amount of crystal to receive", ge=0)
27
+ want_gold: int = Field(default=0, description="Amount of gold to receive", ge=0)
28
+
29
+
30
+ class NegotiationObservation(Observation):
31
+ """Observation from the Negotiation environment."""
32
+
33
+ player_resources: Dict[str, int] = Field(
34
+ default_factory=lambda: {"iron": 0, "crystal": 0, "gold": 0},
35
+ description="Player's current resources"
36
+ )
37
+ bot_resources: Dict[str, int] = Field(
38
+ default_factory=lambda: {"iron": 0, "crystal": 0, "gold": 0},
39
+ description="Bot's current resources"
40
+ )
41
+ round: int = Field(default=0, description="Current round number")
42
+ total_rounds: int = Field(default=5, description="Total number of trading rounds")
43
+ last_trade_accepted: Optional[bool] = Field(default=None, description="Whether last trade was accepted")
44
+ player_value: int = Field(default=0, description="Current total value of player's resources")
openenv.yaml ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ spec_version: 1
2
+ name: negotiation_env
3
+ type: space
4
+ runtime: fastapi
5
+ app: server.app:app
6
+ port: 8000
7
+
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-negotiation_env"
13
+ version = "0.1.0"
14
+ description = "Negotiation 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.1",
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 negotiation_env.server.app
40
+ server = "negotiation_env.server.app:main"
41
+
42
+ [tool.setuptools]
43
+ include-package-data = true
44
+ packages = ["negotiation_env", "negotiation_env.server"]
45
+ package-dir = { "negotiation_env" = ".", "negotiation_env.server" = "server" }
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
+ """Negotiation Env environment server components."""
8
+
9
+ from .negotiation_env_environment import NegotiationEnvironment
10
+
11
+ __all__ = ["NegotiationEnvironment"]
server/app.py ADDED
@@ -0,0 +1,82 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 Negotiation Env Environment.
9
+
10
+ This module creates an HTTP server that exposes the NegotiationEnvironment
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 NegotiationAction, NegotiationObservation
40
+
41
+ from .negotiation_env_environment import NegotiationEnvironment
42
+
43
+
44
+ # Create the app with web interface and README integration
45
+ app = create_app(
46
+ NegotiationEnvironment,
47
+ NegotiationAction,
48
+ NegotiationObservation,
49
+ env_name="negotiation_env",
50
+ max_concurrent_envs=1, # increase this number to allow more concurrent WebSocket sessions
51
+ )
52
+
53
+
54
+ def main(host: str = "0.0.0.0", port: int = 8000):
55
+ """
56
+ Entry point for direct execution via uv run or python -m.
57
+
58
+ This function enables running the server without Docker:
59
+ uv run --project . server
60
+ uv run --project . server --port 8001
61
+ python -m negotiation_env.server.app
62
+
63
+ Args:
64
+ host: Host address to bind to (default: "0.0.0.0")
65
+ port: Port number to listen on (default: 8000)
66
+
67
+ For production deployments, consider using uvicorn directly with
68
+ multiple workers:
69
+ uvicorn negotiation_env.server.app:app --workers 4
70
+ """
71
+ import uvicorn
72
+
73
+ uvicorn.run(app, host=host, port=port)
74
+
75
+
76
+ if __name__ == "__main__":
77
+ import argparse
78
+
79
+ parser = argparse.ArgumentParser()
80
+ parser.add_argument("--port", type=int, default=8000)
81
+ args = parser.parse_args()
82
+ main(port=args.port)
server/negotiation_env_environment.py ADDED
@@ -0,0 +1,218 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ Negotiation Environment Implementation.
9
+
10
+ Trading with a hidden-strategy bot. The bot has hidden resource values and
11
+ uses one of four strategies: fair, greedy, generous, or mirror.
12
+ """
13
+
14
+ import random
15
+ from uuid import uuid4
16
+
17
+ from models import NegotiationAction, NegotiationObservation
18
+ from openenv.core.env_server.interfaces import Environment
19
+ from openenv.core.env_server.types import State
20
+
21
+
22
+ class NegotiationEnvironment(Environment):
23
+ """
24
+ Negotiation environment with a hidden-strategy trading bot.
25
+
26
+ Player starts with iron=5, crystal=3, gold=2.
27
+ Bot starts with iron=2, crystal=5, gold=4.
28
+ Player values: iron=1, crystal=3, gold=5.
29
+ Bot gets random hidden values and a random strategy.
30
+
31
+ Strategies:
32
+ - fair: accepts if both sides gain similar value
33
+ - greedy: only accepts if bot gains more than player
34
+ - generous: accepts if bot gains anything
35
+ - mirror: mirrors player's trading pattern
36
+
37
+ Final reward: player_value / theoretical_max_value
38
+ """
39
+
40
+ SUPPORTS_CONCURRENT_SESSIONS: bool = True
41
+
42
+ TOTAL_ROUNDS = 5
43
+ PLAYER_VALUES = {"iron": 1, "crystal": 3, "gold": 5}
44
+
45
+ def __init__(self):
46
+ """Initialize the negotiation environment."""
47
+ self._state = State(episode_id=str(uuid4()), step_count=0)
48
+ self._player_resources: dict[str, int] = {}
49
+ self._bot_resources: dict[str, int] = {}
50
+ self._bot_values: dict[str, int] = {}
51
+ self._bot_strategy: str = ""
52
+ self._round: int = 0
53
+ self._last_trade_accepted: bool | None = None
54
+ self._last_player_give: dict[str, int] = {}
55
+
56
+ def _calculate_player_value(self) -> int:
57
+ """Calculate total value of player's resources."""
58
+ return sum(
59
+ self._player_resources[r] * self.PLAYER_VALUES[r]
60
+ for r in ["iron", "crystal", "gold"]
61
+ )
62
+
63
+ def _calculate_theoretical_max(self) -> int:
64
+ """Calculate theoretical maximum value if player had all resources."""
65
+ total_iron = 5 + 2 # player + bot starting
66
+ total_crystal = 3 + 5
67
+ total_gold = 2 + 4
68
+ return (
69
+ total_iron * self.PLAYER_VALUES["iron"] +
70
+ total_crystal * self.PLAYER_VALUES["crystal"] +
71
+ total_gold * self.PLAYER_VALUES["gold"]
72
+ )
73
+
74
+ def _bot_evaluates_trade(
75
+ self,
76
+ player_gives: dict[str, int],
77
+ player_wants: dict[str, int]
78
+ ) -> bool:
79
+ """Evaluate if bot accepts the trade based on its strategy."""
80
+ # Check if trade is valid (player has resources, bot has resources)
81
+ for r in ["iron", "crystal", "gold"]:
82
+ if player_gives[r] > self._player_resources[r]:
83
+ return False
84
+ if player_wants[r] > self._bot_resources[r]:
85
+ return False
86
+
87
+ # Calculate value changes
88
+ bot_gains = sum(player_gives[r] * self._bot_values[r] for r in ["iron", "crystal", "gold"])
89
+ bot_loses = sum(player_wants[r] * self._bot_values[r] for r in ["iron", "crystal", "gold"])
90
+ bot_net = bot_gains - bot_loses
91
+
92
+ player_gains = sum(player_wants[r] * self.PLAYER_VALUES[r] for r in ["iron", "crystal", "gold"])
93
+ player_loses = sum(player_gives[r] * self.PLAYER_VALUES[r] for r in ["iron", "crystal", "gold"])
94
+ player_net = player_gains - player_loses
95
+
96
+ if self._bot_strategy == "fair":
97
+ # Accept if difference in gains is small
98
+ return abs(bot_net - player_net) <= 2 and bot_net >= 0
99
+
100
+ elif self._bot_strategy == "greedy":
101
+ # Only accept if bot gains more than player
102
+ return bot_net > player_net and bot_net > 0
103
+
104
+ elif self._bot_strategy == "generous":
105
+ # Accept if bot gains anything
106
+ return bot_net > 0
107
+
108
+ elif self._bot_strategy == "mirror":
109
+ # Mirror: accept trades similar to what player previously offered
110
+ if not self._last_player_give:
111
+ return bot_net >= 0
112
+ # Compare ratios
113
+ total_give = sum(player_gives.values())
114
+ total_want = sum(player_wants.values())
115
+ if total_give == 0 or total_want == 0:
116
+ return False
117
+ ratio = total_give / total_want
118
+ return 0.5 <= ratio <= 2.0 and bot_net >= -1
119
+
120
+ return False
121
+
122
+ def reset(self) -> NegotiationObservation:
123
+ """
124
+ Reset the environment.
125
+
126
+ Sets up initial resources and randomly assigns bot values and strategy.
127
+ """
128
+ self._state = State(episode_id=str(uuid4()), step_count=0)
129
+
130
+ # Initialize resources
131
+ self._player_resources = {"iron": 5, "crystal": 3, "gold": 2}
132
+ self._bot_resources = {"iron": 2, "crystal": 5, "gold": 4}
133
+
134
+ # Random bot values (1-5 for each resource)
135
+ self._bot_values = {
136
+ "iron": random.randint(1, 5),
137
+ "crystal": random.randint(1, 5),
138
+ "gold": random.randint(1, 5),
139
+ }
140
+
141
+ # Random strategy
142
+ self._bot_strategy = random.choice(["fair", "greedy", "generous", "mirror"])
143
+
144
+ self._round = 0
145
+ self._last_trade_accepted = None
146
+ self._last_player_give = {}
147
+
148
+ return NegotiationObservation(
149
+ player_resources=self._player_resources.copy(),
150
+ bot_resources=self._bot_resources.copy(),
151
+ round=0,
152
+ total_rounds=self.TOTAL_ROUNDS,
153
+ last_trade_accepted=None,
154
+ player_value=self._calculate_player_value(),
155
+ done=False,
156
+ )
157
+
158
+ def step(self, action: NegotiationAction) -> NegotiationObservation:
159
+ """
160
+ Execute a trading step.
161
+
162
+ Args:
163
+ action: NegotiationAction with trade proposal
164
+
165
+ Returns:
166
+ NegotiationObservation with trade result
167
+ """
168
+ self._state.step_count += 1
169
+ self._round += 1
170
+
171
+ player_gives = {
172
+ "iron": action.give_iron,
173
+ "crystal": action.give_crystal,
174
+ "gold": action.give_gold,
175
+ }
176
+ player_wants = {
177
+ "iron": action.want_iron,
178
+ "crystal": action.want_crystal,
179
+ "gold": action.want_gold,
180
+ }
181
+
182
+ # Evaluate trade
183
+ accepted = self._bot_evaluates_trade(player_gives, player_wants)
184
+ self._last_trade_accepted = accepted
185
+
186
+ if accepted:
187
+ # Execute trade
188
+ for r in ["iron", "crystal", "gold"]:
189
+ self._player_resources[r] -= player_gives[r]
190
+ self._player_resources[r] += player_wants[r]
191
+ self._bot_resources[r] += player_gives[r]
192
+ self._bot_resources[r] -= player_wants[r]
193
+
194
+ # Store for mirror strategy
195
+ self._last_player_give = player_gives.copy()
196
+
197
+ done = self._round >= self.TOTAL_ROUNDS
198
+
199
+ # Calculate reward at end
200
+ reward = 0.0
201
+ if done:
202
+ reward = self._calculate_player_value() / self._calculate_theoretical_max()
203
+
204
+ return NegotiationObservation(
205
+ player_resources=self._player_resources.copy(),
206
+ bot_resources=self._bot_resources.copy(),
207
+ round=self._round,
208
+ total_rounds=self.TOTAL_ROUNDS,
209
+ last_trade_accepted=accepted,
210
+ player_value=self._calculate_player_value(),
211
+ done=done,
212
+ reward=reward,
213
+ )
214
+
215
+ @property
216
+ def state(self) -> State:
217
+ """Get the current environment state."""
218
+ return self._state
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
+