Spaces:
Sleeping
Sleeping
File size: 55,920 Bytes
d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 d0ae716 538f1d3 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 |
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
"""
Web interface for OpenEnv environments.
This module provides a web-based interface for interacting with OpenEnv environments,
including a two-pane layout for HumanAgent interaction and state observation.
"""
from __future__ import annotations
import json
import time
from dataclasses import asdict, dataclass
from typing import Any, Dict, List, Optional, Type
from datetime import datetime
from fastapi import FastAPI, WebSocket, WebSocketDisconnect, Request
from fastapi.responses import HTMLResponse, FileResponse
from fastapi.staticfiles import StaticFiles
from pydantic import BaseModel
from .interfaces import Environment
from .types import Action, Observation, State, EnvironmentMetadata
def load_environment_metadata(env: Environment, env_name: Optional[str] = None) -> EnvironmentMetadata:
"""
Load environment metadata including README content.
Args:
env: The environment instance
env_name: Optional environment name for README file lookup
Returns:
EnvironmentMetadata with loaded information
"""
# Try to get metadata from environment if it has a method for it
if hasattr(env, 'get_metadata'):
return env.get_metadata()
# Default metadata
metadata = EnvironmentMetadata(
name=env_name or env.__class__.__name__,
description=f"{env.__class__.__name__} environment",
version="1.0.0"
)
# Try to load README from file system
readme_content = _load_readme_from_filesystem(env_name)
if readme_content:
metadata.readme_content = readme_content
return metadata
def _load_readme_from_filesystem(env_name: Optional[str]) -> Optional[str]:
"""
Load README content from the filesystem.
Tries multiple locations:
1. Container filesystem: /app/README.md
2. Local development: src/envs/{env_name}/README.md
3. Environment variable: ENV_README_PATH
"""
import os
from pathlib import Path
# Try container filesystem first
container_readme = Path("/app/README.md")
if container_readme.exists():
try:
return container_readme.read_text(encoding='utf-8')
except Exception:
pass
# Try environment variable path
custom_path = os.environ.get("ENV_README_PATH")
if custom_path and Path(custom_path).exists():
try:
return Path(custom_path).read_text(encoding='utf-8')
except Exception:
pass
# Try local development path
if env_name:
local_readme = Path(f"src/envs/{env_name}/README.md")
if local_readme.exists():
try:
return local_readme.read_text(encoding='utf-8')
except Exception:
pass
return None
@dataclass
class ActionLog:
"""Log entry for an action taken."""
timestamp: str
action: Dict[str, Any]
observation: Dict[str, Any]
reward: Optional[float]
done: bool
step_count: int
@dataclass
class EpisodeState:
"""Current episode state for the web interface."""
episode_id: Optional[str]
step_count: int
current_observation: Optional[Dict[str, Any]]
action_logs: List[ActionLog]
is_reset: bool = True
class WebInterfaceManager:
"""Manages the web interface for an environment."""
def __init__(
self,
env: Environment,
action_cls: Type[Action],
observation_cls: Type[Observation],
metadata: Optional[EnvironmentMetadata] = None,
):
self.env = env
self.action_cls = action_cls
self.observation_cls = observation_cls
self.metadata = metadata or EnvironmentMetadata(
name=env.__class__.__name__,
description=f"{env.__class__.__name__} environment"
)
self.episode_state = EpisodeState(
episode_id=None,
step_count=0,
current_observation=None,
action_logs=[]
)
self.connected_clients: List[WebSocket] = []
async def connect_websocket(self, websocket: WebSocket):
"""Connect a new WebSocket client."""
await websocket.accept()
self.connected_clients.append(websocket)
# Send current state to the new client
await self._send_state_update()
async def disconnect_websocket(self, websocket: WebSocket):
"""Disconnect a WebSocket client."""
if websocket in self.connected_clients:
self.connected_clients.remove(websocket)
async def _send_state_update(self):
"""Send current state to all connected clients."""
if not self.connected_clients:
return
state_data = {
"type": "state_update",
"episode_state": asdict(self.episode_state)
}
# Send to all connected clients
disconnected_clients = []
for client in self.connected_clients:
try:
await client.send_text(json.dumps(state_data))
except:
disconnected_clients.append(client)
# Remove disconnected clients
for client in disconnected_clients:
self.connected_clients.remove(client)
async def reset_environment(self) -> Dict[str, Any]:
"""Reset the environment and update state."""
observation = self.env.reset()
state = self.env.state
# Update episode state
self.episode_state.episode_id = state.episode_id
self.episode_state.step_count = 0
self.episode_state.current_observation = asdict(observation)
self.episode_state.action_logs = []
self.episode_state.is_reset = True
# Send state update
await self._send_state_update()
return {
"observation": asdict(observation),
"reward": observation.reward,
"done": observation.done,
}
async def step_environment(self, action_data: Dict[str, Any]) -> Dict[str, Any]:
"""Execute a step in the environment and update state."""
# Deserialize action
action = self._deserialize_action(action_data)
# Execute step
observation = self.env.step(action)
state = self.env.state
# Create action log
action_log = ActionLog(
timestamp=datetime.now().isoformat(),
action=asdict(action),
observation=asdict(observation),
reward=observation.reward,
done=observation.done,
step_count=state.step_count
)
# Update episode state
self.episode_state.episode_id = state.episode_id
self.episode_state.step_count = state.step_count
self.episode_state.current_observation = asdict(observation)
self.episode_state.action_logs.append(action_log)
self.episode_state.is_reset = False
# Send state update
await self._send_state_update()
return {
"observation": asdict(observation),
"reward": observation.reward,
"done": observation.done,
}
def get_state(self) -> Dict[str, Any]:
"""Get current environment state."""
state = self.env.state
return asdict(state)
def _deserialize_action(self, action_data: Dict[str, Any]) -> Action:
"""Convert JSON dict to Action instance."""
metadata = action_data.pop("metadata", {})
# Handle tensor fields that come from JSON as lists
processed_data = {}
for key, value in action_data.items():
if key == "tokens" and isinstance(value, (list, str)):
# Convert list or string to tensor
if isinstance(value, str):
# If it's a string, try to parse it as a list of numbers
try:
import json
value = json.loads(value)
except:
# If parsing fails, treat as empty list
value = []
if isinstance(value, list):
import torch
processed_data[key] = torch.tensor(value, dtype=torch.long)
else:
processed_data[key] = value
elif key == "action_id" and isinstance(value, str):
# Convert action_id from string to int
try:
processed_data[key] = int(value)
except ValueError:
# If conversion fails, keep original value
processed_data[key] = value
else:
processed_data[key] = value
action = self.action_cls(**processed_data)
action.metadata = metadata
return action
def create_web_interface_app(
env: Environment,
action_cls: Type[Action],
observation_cls: Type[Observation],
env_name: Optional[str] = None,
) -> FastAPI:
"""
Create a FastAPI application with web interface for the given environment.
Args:
env: The Environment instance to serve
action_cls: The Action subclass this environment expects
observation_cls: The Observation subclass this environment returns
env_name: Optional environment name for README loading
Returns:
FastAPI application instance with web interface
"""
from .http_server import create_fastapi_app
# Create the base environment app
app = create_fastapi_app(env, action_cls, observation_cls)
# Load environment metadata
metadata = load_environment_metadata(env, env_name)
# Create web interface manager
web_manager = WebInterfaceManager(env, action_cls, observation_cls, metadata)
# Add web interface routes
@app.get("/web", response_class=HTMLResponse)
async def web_interface():
"""Serve the web interface."""
return get_web_interface_html(action_cls, web_manager.metadata)
@app.get("/web/metadata")
async def web_metadata():
"""Get environment metadata."""
return asdict(web_manager.metadata)
@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
"""WebSocket endpoint for real-time updates."""
await web_manager.connect_websocket(websocket)
try:
while True:
# Keep connection alive
await websocket.receive_text()
except WebSocketDisconnect:
await web_manager.disconnect_websocket(websocket)
@app.post("/web/reset")
async def web_reset():
"""Reset endpoint for web interface."""
return await web_manager.reset_environment()
@app.post("/web/step")
async def web_step(request: Dict[str, Any]):
"""Step endpoint for web interface."""
# Check if this is a message-based request (chat environment)
if "message" in request:
message = request["message"]
# Convert message to action using the environment's message_to_action method
action = web_manager.env.message_to_action(message)
action_data = {"tokens": action.tokens.tolist()}
else:
action_data = request.get("action", {})
return await web_manager.step_environment(action_data)
@app.get("/web/state")
async def web_state():
"""State endpoint for web interface."""
return web_manager.get_state()
return app
def get_web_interface_html(action_cls: Type[Action], metadata: Optional[EnvironmentMetadata] = None) -> str:
"""Generate the HTML for the web interface."""
# Check if this is a chat environment by looking for tokens field
is_chat_env = False
if hasattr(action_cls, '__dataclass_fields__'):
for field_name, field_info in action_cls.__dataclass_fields__.items():
if field_name == 'tokens' and hasattr(field_info.type, '__name__') and 'Tensor' in field_info.type.__name__:
is_chat_env = True
break
# Get action fields for dynamic form generation with enhanced metadata
action_fields = _extract_action_fields(action_cls)
return f"""
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>OpenEnv Web Interface</title>
<style>
* {{
margin: 0;
padding: 0;
box-sizing: border-box;
}}
body {{
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
background-color: #f5f5f5;
height: 100vh;
overflow: hidden;
}}
.container {{
display: flex;
height: 100vh;
}}
.left-pane {{
width: 50%;
background: white;
border-right: 1px solid #e0e0e0;
display: flex;
flex-direction: column;
}}
.right-pane {{
width: 50%;
background: #fafafa;
display: flex;
flex-direction: column;
}}
.pane-header {{
padding: 20px;
border-bottom: 1px solid #e0e0e0;
background: #f8f9fa;
font-weight: 600;
font-size: 16px;
}}
.pane-content {{
flex: 1;
padding: 20px;
overflow-y: auto;
}}
.action-form {{
background: white;
border: 1px solid #e0e0e0;
border-radius: 8px;
padding: 20px;
margin-bottom: 20px;
}}
.form-group {{
margin-bottom: 15px;
}}
.form-group label {{
display: block;
margin-bottom: 5px;
font-weight: 500;
color: #333;
}}
.form-group input, .form-group textarea {{
width: 100%;
padding: 8px 12px;
border: 1px solid #ddd;
border-radius: 4px;
font-size: 14px;
}}
.form-group input:focus, .form-group textarea:focus {{
outline: none;
border-color: #007bff;
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}}
.btn {{
background: #007bff;
color: white;
border: none;
padding: 10px 20px;
border-radius: 4px;
cursor: pointer;
font-size: 14px;
margin-right: 10px;
margin-bottom: 10px;
}}
.btn:hover {{
background: #0056b3;
}}
.btn:disabled {{
background: #6c757d;
cursor: not-allowed;
}}
.btn-secondary {{
background: #6c757d;
}}
.btn-secondary:hover {{
background: #545b62;
}}
.state-display {{
background: white;
border: 1px solid #e0e0e0;
border-radius: 8px;
padding: 15px;
margin-bottom: 20px;
}}
.state-item {{
margin-bottom: 8px;
}}
.state-label {{
font-weight: 500;
color: #666;
}}
.state-value {{
color: #333;
font-family: monospace;
}}
.logs-container {{
background: white;
border: 1px solid #e0e0e0;
border-radius: 8px;
padding: 15px;
max-height: 400px;
overflow-y: auto;
}}
.log-entry {{
border-bottom: 1px solid #f0f0f0;
padding: 10px 0;
}}
.log-entry:last-child {{
border-bottom: none;
}}
.log-timestamp {{
font-size: 12px;
color: #666;
margin-bottom: 5px;
}}
.log-action {{
background: #e3f2fd;
padding: 8px;
border-radius: 4px;
margin-bottom: 5px;
font-family: monospace;
font-size: 12px;
}}
.log-observation {{
background: #f3e5f5;
padding: 8px;
border-radius: 4px;
font-family: monospace;
font-size: 12px;
}}
.log-reward {{
font-weight: 600;
color: #28a745;
}}
.log-done {{
font-weight: 600;
color: #dc3545;
}}
.status-indicator {{
display: inline-block;
width: 8px;
height: 8px;
border-radius: 50%;
margin-right: 8px;
}}
.status-connected {{
background: #28a745;
}}
.status-disconnected {{
background: #dc3545;
}}
.json-display {{
background: #f8f9fa;
border: 1px solid #e9ecef;
border-radius: 4px;
padding: 10px;
font-family: monospace;
font-size: 12px;
white-space: pre-wrap;
max-height: 200px;
overflow-y: auto;
}}
/* Chat Interface Styles */
.chat-interface {{
background: white;
border: 1px solid #e0e0e0;
border-radius: 8px;
padding: 20px;
margin-bottom: 20px;
}}
.chat-messages {{
background: #f8f9fa;
border: 1px solid #e0e0e0;
border-radius: 8px;
padding: 15px;
margin-bottom: 15px;
max-height: 400px;
overflow-y: auto;
}}
.chat-message {{
margin-bottom: 15px;
padding: 10px;
border-radius: 8px;
}}
.chat-message:last-child {{
margin-bottom: 0;
}}
.chat-message.user {{
background: #e3f2fd;
margin-left: 20px;
}}
.chat-message.assistant {{
background: #f3e5f5;
margin-right: 20px;
}}
.chat-message.system {{
background: #e8f5e8;
font-style: italic;
}}
.message-role {{
font-weight: 600;
font-size: 12px;
color: #666;
margin-bottom: 5px;
}}
.message-content {{
font-size: 14px;
line-height: 1.4;
}}
.chat-input-container {{
border-top: 1px solid #e0e0e0;
padding-top: 15px;
}}
.role-selector {{
margin-bottom: 10px;
}}
.role-selector label {{
font-weight: 500;
margin-right: 10px;
}}
.role-selector select {{
padding: 5px 10px;
border: 1px solid #ddd;
border-radius: 4px;
}}
.message-input {{
display: flex;
gap: 10px;
align-items: flex-end;
}}
.message-input textarea {{
flex: 1;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
resize: vertical;
font-family: inherit;
}}
.message-input textarea:focus {{
outline: none;
border-color: #007bff;
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}}
/* Instructions Section Styles */
.instructions-section {{
background: white;
border: 1px solid #e0e0e0;
border-radius: 8px;
padding: 20px;
margin-bottom: 20px;
}}
.instructions-header {{
display: flex;
justify-content: space-between;
align-items: center;
margin-bottom: 15px;
}}
.instructions-title {{
font-size: 18px;
font-weight: 600;
color: #333;
margin: 0;
}}
.instructions-toggle {{
background: #f8f9fa;
border: 1px solid #dee2e6;
border-radius: 4px;
padding: 5px 10px;
cursor: pointer;
font-size: 12px;
color: #6c757d;
}}
.instructions-toggle:hover {{
background: #e9ecef;
}}
.instructions-content {{
display: none;
max-height: 400px;
overflow-y: auto;
border-top: 1px solid #e0e0e0;
padding-top: 15px;
}}
.instructions-content.expanded {{
display: block;
}}
.instructions-content h1,
.instructions-content h2,
.instructions-content h3 {{
color: #333;
margin-top: 20px;
margin-bottom: 10px;
}}
.instructions-content h1 {{
font-size: 24px;
border-bottom: 2px solid #007bff;
padding-bottom: 10px;
}}
.instructions-content h2 {{
font-size: 20px;
}}
.instructions-content h3 {{
font-size: 16px;
}}
.instructions-content p {{
margin-bottom: 10px;
line-height: 1.6;
}}
.instructions-content code {{
background: #f8f9fa;
padding: 2px 4px;
border-radius: 3px;
font-family: monospace;
font-size: 14px;
}}
.instructions-content pre {{
background: #f8f9fa;
border: 1px solid #e9ecef;
border-radius: 4px;
padding: 15px;
overflow-x: auto;
margin: 10px 0;
}}
.instructions-content pre code {{
background: none;
padding: 0;
}}
.instructions-content ul,
.instructions-content ol {{
margin: 10px 0;
padding-left: 20px;
}}
.instructions-content li {{
margin-bottom: 5px;
}}
.instructions-content table {{
border-collapse: collapse;
width: 100%;
margin: 15px 0;
}}
.instructions-content th,
.instructions-content td {{
border: 1px solid #dee2e6;
padding: 8px 12px;
text-align: left;
}}
.instructions-content th {{
background: #f8f9fa;
font-weight: 600;
}}
/* Enhanced Form Styles */
.help-text {{
display: block;
margin-top: 5px;
font-size: 12px;
color: #6c757d;
font-style: italic;
}}
.form-group label {{
font-weight: 500;
color: #333;
margin-bottom: 5px;
}}
.form-group select {{
width: 100%;
padding: 8px 12px;
border: 1px solid #ddd;
border-radius: 4px;
font-size: 14px;
background-color: white;
}}
.form-group select:focus {{
outline: none;
border-color: #007bff;
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}}
.form-group textarea {{
width: 100%;
padding: 8px 12px;
border: 1px solid #ddd;
border-radius: 4px;
font-size: 14px;
font-family: inherit;
resize: vertical;
}}
.form-group textarea:focus {{
outline: none;
border-color: #007bff;
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}}
.form-group input[type="number"] {{
width: 100%;
padding: 8px 12px;
border: 1px solid #ddd;
border-radius: 4px;
font-size: 14px;
}}
.form-group input[type="number"]:focus {{
outline: none;
border-color: #007bff;
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}}
.form-group input[type="text"]:focus {{
outline: none;
border-color: #007bff;
box-shadow: 0 0 0 2px rgba(0, 123, 255, 0.25);
}}
.required-indicator {{
color: #dc3545;
font-weight: bold;
}}
.form-group .field-description {{
font-size: 11px;
color: #666;
margin-top: 2px;
font-style: italic;
}}
</style>
</head>
<body>
<div class="container">
<!-- Left Pane: HumanAgent Interface -->
<div class="left-pane">
<div class="pane-header">
<span class="status-indicator status-disconnected" id="connection-status"></span>
HumanAgent Interface
</div>
<div class="pane-content">
<!-- Instructions Section -->
{_generate_instructions_section(metadata)}
<!-- Action Form or Chat Interface -->
{_generate_action_interface(action_fields, is_chat_env)}
<!-- Control Buttons -->
<div style="margin-bottom: 20px;">
<button class="btn btn-secondary" id="reset-btn">Reset Environment</button>
<button class="btn btn-secondary" id="state-btn">Get State</button>
</div>
<!-- Current State Display -->
<div class="state-display">
<h3>Current State</h3>
<div id="current-state">
<div class="state-item">
<span class="state-label">Status:</span>
<span class="state-value" id="env-status">Not initialized</span>
</div>
<div class="state-item">
<span class="state-label">Episode ID:</span>
<span class="state-value" id="episode-id">-</span>
</div>
<div class="state-item">
<span class="state-label">Step Count:</span>
<span class="state-value" id="step-count">0</span>
</div>
</div>
</div>
</div>
</div>
<!-- Right Pane: State Observer -->
<div class="right-pane">
<div class="pane-header">
State Observer
</div>
<div class="pane-content">
<!-- Current Observation -->
<div class="state-display">
<h3>Current Observation</h3>
<div id="current-observation" class="json-display">
No observation yet
</div>
</div>
<!-- Action Logs -->
<div class="logs-container">
<h3>Action History</h3>
<div id="action-logs">
No actions taken yet
</div>
</div>
</div>
</div>
</div>
<script>
class OpenEnvWebInterface {{
constructor() {{
this.ws = null;
this.isConnected = false;
this.init();
}}
init() {{
this.connectWebSocket();
this.setupEventListeners();
}}
connectWebSocket() {{
const protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsUrl = `${{protocol}}//${{window.location.host}}/ws`;
this.ws = new WebSocket(wsUrl);
this.ws.onopen = () => {{
this.isConnected = true;
this.updateConnectionStatus(true);
console.log('WebSocket connected');
}};
this.ws.onmessage = (event) => {{
const data = JSON.parse(event.data);
if (data.type === 'state_update') {{
this.updateUI(data.episode_state);
}}
}};
this.ws.onclose = () => {{
this.isConnected = false;
this.updateConnectionStatus(false);
console.log('WebSocket disconnected');
// Attempt to reconnect after 3 seconds
setTimeout(() => this.connectWebSocket(), 3000);
}};
this.ws.onerror = (error) => {{
console.error('WebSocket error:', error);
}};
}}
setupEventListeners() {{
// Instructions toggle
const instructionsToggle = document.getElementById('instructions-toggle');
const instructionsContent = document.getElementById('instructions-content');
if (instructionsToggle && instructionsContent) {{
instructionsToggle.addEventListener('click', () => {{
instructionsContent.classList.toggle('expanded');
instructionsToggle.textContent = instructionsContent.classList.contains('expanded')
? 'Hide Instructions' : 'Show Instructions';
}});
}}
// Check if this is a chat environment
const isChatEnv = document.getElementById('chat-messages') !== null;
if (isChatEnv) {{
// Chat environment event listeners
document.getElementById('send-message-btn').addEventListener('click', () => {{
this.sendMessage();
}});
// Send message on Enter (but allow Shift+Enter for new lines)
document.getElementById('message-input').addEventListener('keydown', (e) => {{
if (e.key === 'Enter' && !e.shiftKey) {{
e.preventDefault();
this.sendMessage();
}}
}});
}} else {{
// Traditional action form submission
const actionForm = document.getElementById('action-form');
if (actionForm) {{
actionForm.addEventListener('submit', (e) => {{
e.preventDefault();
this.submitAction();
}});
}}
}}
// Reset button
document.getElementById('reset-btn').addEventListener('click', () => {{
this.resetEnvironment();
}});
// State button
document.getElementById('state-btn').addEventListener('click', () => {{
this.getState();
}});
}}
async sendMessage() {{
const messageInput = document.getElementById('message-input');
const roleSelect = document.getElementById('message-role');
const message = messageInput.value.trim();
const role = roleSelect.value;
if (!message) {{
return;
}}
// Add message to chat display immediately
this.addMessageToChat(role, message);
// Clear input
messageInput.value = '';
try {{
// Send message to server to convert to action and step
const response = await fetch('/web/step', {{
method: 'POST',
headers: {{ 'Content-Type': 'application/json' }},
body: JSON.stringify({{
message: {{
role: role,
content: message
}}
}})
}});
if (!response.ok) {{
throw new Error(`HTTP error! status: ${{response.status}}`);
}}
const result = await response.json();
console.log('Message sent:', result);
}} catch (error) {{
console.error('Error sending message:', error);
alert('Error sending message: ' + error.message);
}}
}}
addMessageToChat(role, content) {{
const chatMessages = document.getElementById('chat-messages');
const messageDiv = document.createElement('div');
messageDiv.className = `chat-message ${{role}}`;
messageDiv.innerHTML = `
<div class="message-role">${{role.charAt(0).toUpperCase() + role.slice(1)}}</div>
<div class="message-content">${{content}}</div>
`;
chatMessages.appendChild(messageDiv);
chatMessages.scrollTop = chatMessages.scrollHeight;
}}
async submitAction() {{
const formData = new FormData(document.getElementById('action-form'));
const action = {{}};
// Collect form data
for (const [key, value] of formData.entries()) {{
if (value !== '') {{
// Handle tensor fields (tokens) - convert comma-separated string to array
if (key === 'tokens') {{
try {{
action[key] = value.split(',').map(x => parseInt(x.trim())).filter(x => !isNaN(x));
}} catch (e) {{
console.error('Error parsing tokens:', e);
action[key] = [];
}}
}} else {{
action[key] = value;
}}
}}
}}
try {{
const response = await fetch('/web/step', {{
method: 'POST',
headers: {{ 'Content-Type': 'application/json' }},
body: JSON.stringify({{ action }})
}});
if (!response.ok) {{
throw new Error(`HTTP error! status: ${{response.status}}`);
}}
const result = await response.json();
console.log('Step result:', result);
}} catch (error) {{
console.error('Error submitting action:', error);
alert('Error submitting action: ' + error.message);
}}
}}
async resetEnvironment() {{
try {{
const response = await fetch('/web/reset', {{
method: 'POST',
headers: {{ 'Content-Type': 'application/json' }}
}});
if (!response.ok) {{
throw new Error(`HTTP error! status: ${{response.status}}`);
}}
const result = await response.json();
console.log('Reset result:', result);
}} catch (error) {{
console.error('Error resetting environment:', error);
alert('Error resetting environment: ' + error.message);
}}
}}
async getState() {{
try {{
const response = await fetch('/web/state');
const state = await response.json();
console.log('Current state:', state);
alert('Current state: ' + JSON.stringify(state, null, 2));
}} catch (error) {{
console.error('Error getting state:', error);
alert('Error getting state: ' + error.message);
}}
}}
updateConnectionStatus(connected) {{
const indicator = document.getElementById('connection-status');
if (connected) {{
indicator.className = 'status-indicator status-connected';
}} else {{
indicator.className = 'status-indicator status-disconnected';
}}
}}
updateUI(episodeState) {{
// Check if this is a chat environment
const isChatEnv = document.getElementById('chat-messages') !== null;
// Update current state
document.getElementById('env-status').textContent =
episodeState.is_reset ? 'Reset' : 'Running';
document.getElementById('episode-id').textContent =
episodeState.episode_id || '-';
document.getElementById('step-count').textContent =
episodeState.step_count.toString();
if (isChatEnv) {{
// Update chat interface
this.updateChatInterface(episodeState);
}} else {{
// Update traditional observation display
const observationDiv = document.getElementById('current-observation');
if (episodeState.current_observation) {{
observationDiv.textContent = JSON.stringify(
episodeState.current_observation, null, 2
);
}} else {{
observationDiv.textContent = 'No observation yet';
}}
}}
// Update action logs
const logsDiv = document.getElementById('action-logs');
if (episodeState.action_logs.length === 0) {{
logsDiv.innerHTML = 'No actions taken yet';
}} else {{
logsDiv.innerHTML = episodeState.action_logs.map(log => `
<div class="log-entry">
<div class="log-timestamp">${{log.timestamp}} (Step ${{log.step_count}})</div>
<div class="log-action">Action: ${{JSON.stringify(log.action, null, 2)}}</div>
<div class="log-observation">Observation: ${{JSON.stringify(log.observation, null, 2)}}</div>
<div>
<span class="log-reward">Reward: ${{log.reward !== null ? log.reward : 'None'}}</span>
${{log.done ? '<span class="log-done">DONE</span>' : ''}}
</div>
</div>
`).join('');
}}
}}
updateChatInterface(episodeState) {{
const chatMessages = document.getElementById('chat-messages');
if (!chatMessages) return;
// Clear existing messages (except system message)
const systemMessage = chatMessages.querySelector('.chat-message.system');
chatMessages.innerHTML = '';
if (systemMessage) {{
chatMessages.appendChild(systemMessage);
}}
// Add messages from current observation
if (episodeState.current_observation && episodeState.current_observation.messages) {{
episodeState.current_observation.messages.forEach(msg => {{
this.addMessageToChat(msg.role, msg.content);
}});
}}
}}
}}
// Initialize the web interface when the page loads
document.addEventListener('DOMContentLoaded', () => {{
new OpenEnvWebInterface();
}});
</script>
</body>
</html>
""".replace('{_generate_action_form_fields(action_fields)}', _generate_action_form_fields(action_fields))
def _generate_instructions_section(metadata: Optional[EnvironmentMetadata]) -> str:
"""Generate the instructions section with environment documentation."""
if not metadata or not metadata.readme_content:
return ''
# Convert markdown to HTML (basic conversion)
import re
html_content = _markdown_to_html(metadata.readme_content)
return f'''
<!-- Instructions Section -->
<div class="instructions-section">
<div class="instructions-header">
<h3 class="instructions-title">{metadata.name}</h3>
<button class="instructions-toggle" id="instructions-toggle">Show Instructions</button>
</div>
<div class="instructions-content" id="instructions-content">
<div class="instructions-readme">
{html_content}
</div>
</div>
</div>
'''
def _extract_action_fields(action_cls: Type[Action]) -> List[Dict[str, Any]]:
"""Extract enhanced field metadata from Action class for form generation."""
import typing
from typing import get_origin, get_args
action_fields = []
if not hasattr(action_cls, '__dataclass_fields__'):
return action_fields
for field_name, field_info in action_cls.__dataclass_fields__.items():
if field_name == 'metadata':
continue
field_type = field_info.type
field_metadata = _extract_field_metadata(field_name, field_info)
# Determine input type based on field type
input_type = _determine_input_type(field_type)
# Check if field is required
is_required = field_info.default is field_info.default_factory
action_fields.append({
'name': field_name,
'type': input_type,
'required': is_required,
'description': field_metadata.get('description', ''),
'default_value': field_metadata.get('default_value'),
'choices': field_metadata.get('choices', []),
'min_value': field_metadata.get('min_value'),
'max_value': field_metadata.get('max_value'),
'placeholder': field_metadata.get('placeholder', ''),
'help_text': field_metadata.get('help_text', ''),
})
return action_fields
def _extract_field_metadata(field_name: str, field_info) -> Dict[str, Any]:
"""Extract metadata from dataclass field including docstring and type hints."""
import typing
from typing import get_origin, get_args, Literal, Union, Optional
metadata = {}
# Extract description from field docstring or annotation
if hasattr(field_info, 'metadata') and field_info.metadata:
# Check for custom metadata
for meta in field_info.metadata:
if isinstance(meta, dict):
metadata.update(meta)
# Extract type information
field_type = field_info.type
origin = get_origin(field_type)
# Handle Literal types for dropdown choices
if origin is Literal:
args = get_args(field_type)
metadata['choices'] = list(args)
# Handle Optional types
if origin is Union:
args = get_args(field_type)
if len(args) == 2 and type(None) in args:
# This is Optional[SomeType]
non_none_type = args[0] if args[1] is type(None) else args[1]
metadata['optional'] = True
# Recursively check the non-None type for choices
if get_origin(non_none_type) is Literal:
metadata['choices'] = list(get_args(non_none_type))
else:
# Regular Union type
metadata['choices'] = [str(arg) for arg in args if arg is not type(None)]
# Handle numeric constraints
if field_type in (int, float):
# Check for common constraint patterns in field name
if 'count' in field_name.lower() or 'num' in field_name.lower():
metadata['min_value'] = 0
if 'id' in field_name.lower():
metadata['min_value'] = 0
# Generate placeholder text
if 'message' in field_name.lower():
metadata['placeholder'] = f'Enter {field_name.replace("_", " ")}...'
elif 'code' in field_name.lower():
metadata['placeholder'] = 'Enter Python code here...'
elif 'tokens' in field_name.lower():
metadata['placeholder'] = 'Enter comma-separated token IDs (e.g., 1,2,3,4,5)'
else:
metadata['placeholder'] = f'Enter {field_name.replace("_", " ")}...'
# Generate help text based on field name and type
if 'action_id' in field_name.lower():
metadata['help_text'] = 'The action ID to execute in the environment'
elif 'game_name' in field_name.lower():
metadata['help_text'] = 'Name of the game or environment'
elif 'tokens' in field_name.lower():
metadata['help_text'] = 'Token IDs as a comma-separated list of integers'
elif 'code' in field_name.lower():
metadata['help_text'] = 'Python code to execute in the environment'
elif 'message' in field_name.lower():
metadata['help_text'] = 'Text message to send'
return metadata
def _determine_input_type(field_type) -> str:
"""Determine the appropriate HTML input type for a field type."""
import typing
from typing import get_origin, get_args, Literal, Union
# Handle direct types
if field_type == str:
return "text"
elif field_type == int:
return "number"
elif field_type == float:
return "number"
elif field_type == bool:
return "checkbox"
# Handle complex types
origin = get_origin(field_type)
if origin is Literal:
return "select"
elif origin is Union:
args = get_args(field_type)
if len(args) == 2 and type(None) in args:
# Optional type - use the non-None type
non_none_type = args[0] if args[1] is type(None) else args[1]
return _determine_input_type(non_none_type)
elif all(isinstance(arg, str) for arg in args if arg is not type(None)):
return "select"
else:
return "text"
elif hasattr(field_type, '__name__') and 'Tensor' in field_type.__name__:
return "tensor"
else:
return "text"
def _markdown_to_html(markdown: str) -> str:
"""Convert basic markdown to HTML for README display."""
import html
import re
# Escape HTML first
html_content = html.escape(markdown)
# Convert headers
html_content = re.sub(r'^# (.*?)$', r'<h1>\1</h1>', html_content, flags=re.MULTILINE)
html_content = re.sub(r'^## (.*?)$', r'<h2>\1</h2>', html_content, flags=re.MULTILINE)
html_content = re.sub(r'^### (.*?)$', r'<h3>\1</h3>', html_content, flags=re.MULTILINE)
# Convert code blocks
html_content = re.sub(r'```(.*?)\n(.*?)\n```', r'<pre><code>\2</code></pre>', html_content, flags=re.DOTALL)
html_content = re.sub(r'`([^`]+)`', r'<code>\1</code>', html_content)
# Convert bold and italic
html_content = re.sub(r'\*\*(.*?)\*\*', r'<strong>\1</strong>', html_content)
html_content = re.sub(r'\*(.*?)\*', r'<em>\1</em>', html_content)
# Convert lists
html_content = re.sub(r'^- (.*?)$', r'<li>\1</li>', html_content, flags=re.MULTILINE)
html_content = re.sub(r'(<li>.*</li>)', r'<ul>\1</ul>', html_content, flags=re.DOTALL)
# Convert line breaks
html_content = html_content.replace('\n', '<br>')
return html_content
def _generate_action_interface(action_fields: List[Dict[str, Any]], is_chat_env: bool) -> str:
"""Generate either a chat interface or action form based on environment type."""
if is_chat_env:
return _generate_chat_interface()
else:
return _generate_action_form(action_fields)
def _generate_chat_interface() -> str:
"""Generate a chat-style interface for chat environments."""
return '''
<!-- Chat Interface -->
<div class="chat-interface">
<h3>Chat Interface</h3>
<div class="chat-messages" id="chat-messages">
<div class="chat-message system">
<div class="message-role">System</div>
<div class="message-content">Chat environment ready. Send a message to start the conversation.</div>
</div>
</div>
<div class="chat-input-container">
<div class="role-selector">
<label for="message-role">Role:</label>
<select id="message-role">
<option value="user">User</option>
<option value="assistant">Assistant</option>
</select>
</div>
<div class="message-input">
<textarea id="message-input" placeholder="Type your message here..." rows="3"></textarea>
<button class="btn" id="send-message-btn">Send Message</button>
</div>
</div>
</div>
'''
def _generate_action_form(action_fields: List[Dict[str, Any]]) -> str:
"""Generate a traditional action form for non-chat environments."""
return f'''
<!-- Action Form -->
<div class="action-form">
<h3>Take Action</h3>
<form id="action-form">
{_generate_action_form_fields(action_fields)}
<button type="submit" class="btn" id="step-btn">Step</button>
</form>
</div>
'''
def _generate_action_form_fields(action_fields: List[Dict[str, Any]]) -> str:
"""Generate HTML form fields for action input with enhanced metadata."""
if not action_fields:
return '<p>No action fields available</p>'
fields_html = []
for field in action_fields:
field_html = _generate_single_field(field)
fields_html.append(field_html)
return '\n'.join(fields_html)
def _generate_single_field(field: Dict[str, Any]) -> str:
"""Generate HTML for a single form field with enhanced metadata."""
field_name = field['name']
field_type = field['type']
required = field['required']
placeholder = field.get('placeholder', '')
help_text = field.get('help_text', '')
choices = field.get('choices', [])
min_value = field.get('min_value')
max_value = field.get('max_value')
default_value = field.get('default_value')
# Build label with required indicator
label_text = field_name.replace('_', ' ').title()
if required:
label_text += ' <span style="color: red;">*</span>'
# Build input attributes
input_attrs = []
if required:
input_attrs.append('required')
if placeholder:
input_attrs.append(f'placeholder="{placeholder}"')
if min_value is not None:
input_attrs.append(f'min="{min_value}"')
if max_value is not None:
input_attrs.append(f'max="{max_value}"')
if default_value is not None:
input_attrs.append(f'value="{default_value}"')
attrs_str = ' '.join(input_attrs)
if field_type == 'checkbox':
return f'''
<div class="form-group">
<label>
<input type="checkbox" name="{field_name}" value="true" {attrs_str}>
{label_text}
</label>
{f'<small class="help-text">{help_text}</small>' if help_text else ''}
</div>
'''
elif field_type == 'select':
options_html = []
if not required:
options_html.append(f'<option value="">-- Select {label_text} --</option>')
for choice in choices:
selected = 'selected' if str(choice) == str(default_value) else ''
options_html.append(f'<option value="{choice}" {selected}>{choice}</option>')
return f'''
<div class="form-group">
<label for="{field_name}">{label_text}:</label>
<select name="{field_name}" id="{field_name}" {attrs_str}>
{''.join(options_html)}
</select>
{f'<small class="help-text">{help_text}</small>' if help_text else ''}
</div>
'''
elif field_type == 'tensor':
return f'''
<div class="form-group">
<label for="{field_name}">{label_text} (comma-separated integers):</label>
<input type="text" name="{field_name}" id="{field_name}" {attrs_str}>
<small class="help-text">{help_text or 'Enter token IDs as comma-separated integers (e.g., 1,2,3,4,5)'}</small>
</div>
'''
elif field_type == 'text' and ('message' in field_name.lower() or 'code' in field_name.lower()):
return f'''
<div class="form-group">
<label for="{field_name}">{label_text}:</label>
<textarea name="{field_name}" id="{field_name}" rows="3" {attrs_str}></textarea>
{f'<small class="help-text">{help_text}</small>' if help_text else ''}
</div>
'''
else:
return f'''
<div class="form-group">
<label for="{field_name}">{label_text}:</label>
<input type="{field_type}" name="{field_name}" id="{field_name}" {attrs_str}>
{f'<small class="help-text">{help_text}</small>' if help_text else ''}
</div>
'''
|