simulo.Player

The playback contract — roll a trained policy through an environment.

A player loads a policy output and drives it for a bounded number of episodes or steps, optionally in real time and optionally capturing video. Structural mirror of simulo.core.player.Player.

play()

Player.play(
    num_episodes: Optional[int] = ...,
    num_steps: Optional[int] = ...,
    real_time: bool = ...,
    video_path: Optional[str] = ...,
    video_length: int = ...,
    deterministic: bool = ...,
) -> Dict[str, Any]

Run the policy and return playback metrics (e.g. mean episode return).

Bound the run with num_episodes or num_steps. real_time paces stepping to the sim clock (for watching live); video_path captures up to video_length frames to a file; deterministic disables action sampling and takes the policy’s mean action.

load()

Player.load(path: str) -> None

Load the policy output (e.g. a checkpoint or exported policy) from path.

close()

Player.close() -> None

Release the player’s resources. Idempotent; call before closing the env.

---

Note

simulo.Player is a mode-aware name: at submit time it resolves to a lean, torch-free stand-in so your app imports instantly; on the GPU worker it resolves to the real runtime class. The contract below is the definitive list of members every simulo.Player provides, and the contract your own subclass fulfils.

Declared as:

@runtime_checkable
class PlayerProtocol(Protocol)