Spaces:
Running
Running
File size: 3,415 Bytes
b4ac377 | 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 | # 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.
"""__ENV_TITLE_NAME__ Environment Client."""
from typing import Dict
from openenv.core import EnvClient
from openenv.core.client_types import StepResult
from openenv.core.env_server.types import State
from .models import __ENV_CLASS_NAME__Action, __ENV_CLASS_NAME__Observation
class __ENV_CLASS_NAME__Env(
EnvClient[__ENV_CLASS_NAME__Action, __ENV_CLASS_NAME__Observation, State]
):
"""
Client for the __ENV_TITLE_NAME__ Environment.
This client maintains a persistent WebSocket connection to the environment server,
enabling efficient multi-step interactions with lower latency.
Each client instance has its own dedicated environment session on the server.
Example:
>>> # Connect to a running server
>>> with __ENV_CLASS_NAME__Env(base_url="http://localhost:8000") as client:
... result = client.reset()
... print(result.observation.echoed_message)
...
... result = client.step(__ENV_CLASS_NAME__Action(message="Hello!"))
... print(result.observation.echoed_message)
Example with Docker:
>>> # Automatically start container and connect
>>> client = __ENV_CLASS_NAME__Env.from_docker_image("__ENV_NAME__-env:latest")
>>> try:
... result = client.reset()
... result = client.step(__ENV_CLASS_NAME__Action(message="Test"))
... finally:
... client.close()
"""
def _step_payload(self, action: __ENV_CLASS_NAME__Action) -> Dict:
"""
Convert __ENV_CLASS_NAME__Action to JSON payload for step message.
Args:
action: __ENV_CLASS_NAME__Action instance
Returns:
Dictionary representation suitable for JSON encoding
"""
return {
"message": action.message,
}
def _parse_result(self, payload: Dict) -> StepResult[__ENV_CLASS_NAME__Observation]:
"""
Parse server response into StepResult[__ENV_CLASS_NAME__Observation].
Args:
payload: JSON response data from server
Returns:
StepResult with __ENV_CLASS_NAME__Observation
"""
obs_data = payload.get("observation", {})
observation = __ENV_CLASS_NAME__Observation(
echoed_message=obs_data.get("echoed_message", ""),
message_length=obs_data.get("message_length", 0),
done=payload.get("done", False),
reward=payload.get("reward"),
metadata=obs_data.get("metadata", {}),
)
return StepResult(
observation=observation,
reward=payload.get("reward"),
done=payload.get("done", False),
)
def _parse_state(self, payload: Dict) -> State:
"""
Parse server response into State object.
Args:
payload: JSON response from state request
Returns:
State object with episode_id and step_count
"""
return State(
episode_id=payload.get("episode_id"),
step_count=payload.get("step_count", 0),
)
|