File size: 3,313 Bytes
01a29cc | 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 | # 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.
"""Finenv 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 FinenvAction, FinenvObservation
class FinenvEnv(
EnvClient[FinenvAction, FinenvObservation, State]
):
"""
Client for the Finenv 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 FinenvEnv(base_url="http://localhost:8000") as client:
... result = client.reset()
... print(result.observation.echoed_message)
...
... result = client.step(FinenvAction(message="Hello!"))
... print(result.observation.echoed_message)
Example with Docker:
>>> # Automatically start container and connect
>>> client = FinenvEnv.from_docker_image("finenv-env:latest")
>>> try:
... result = client.reset()
... result = client.step(FinenvAction(message="Test"))
... finally:
... client.close()
"""
def _step_payload(self, action: FinenvAction) -> Dict:
"""
Convert FinenvAction to JSON payload for step message.
Args:
action: FinenvAction instance
Returns:
Dictionary representation suitable for JSON encoding
"""
return {
"type": action.type,
"quantity": action.quantity,
"stock": action.stock,
"market": action.market,
"initial_cash": action.initial_cash,
"max_steps": action.max_steps,
}
def _parse_result(self, payload: Dict) -> StepResult[FinenvObservation]:
"""
Parse server response into StepResult[FinenvObservation].
Args:
payload: JSON response data from server
Returns:
StepResult with FinenvObservation
"""
obs = payload.get("observation", {})
observation = FinenvObservation(
stock=obs.get("stock"),
market=obs.get("market"),
price=obs.get("price"),
shares=obs.get("shares"),
cash=obs.get("cash"),
done=payload.get("done", False),
reward=payload.get("reward"),
metadata=obs.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),
)
|