hyphi_gym.envs.HoleyPlane#

Package Contents#

Classes#

Holes

Gridworld Maze Environment based on hyphi Grid.

Point

Base class for Continous Control in Board Games

HoleyPlane

Base class for Continous Control in Board Games
class hyphi_gym.envs.HoleyPlane.Holes(level: str, random=[], **kwargs)#

Bases: hyphi_gym.common.board.Board

Gridworld Maze Environment based on hyphi Grid. :param level: Configuration to use [Train|Shift] :param random: optional list of features to be stochastic supporting layout, agent-, and target-placement

_generate()#

Random generator for holey grids, placing mean(size) holes

class hyphi_gym.envs.HoleyPlane.Point(grid=False, render_mode=None, frame_skip=1)#

Bases: hyphi_gym.common.simulation.Simulation

Base class for Continous Control in Board Games Use for 3D simulation of continuous board envs and rendering of grids

property default_cam_config#
property agent: tuple[hyphi_gym.common.board.np.ndarray, hyphi_gym.common.board.np.ndarray]#

Get noisy initial agent position and velocity

step_scale = 10#
base_xml#
metadata#
state_vector() → hyphi_gym.common.board.np.ndarray#

Return the position and velocity joint states of the model

execute(action: hyphi_gym.common.board.np.ndarray) → tuple[dict, dict]#

Executes the action, returns the new state, info, and distance between the agent and target

reset(**kwargs)#

Reset the environment simulation and randomize if needed

setup_world(layout=None)#

Helper function to generate a simulation from a board-based layout

load_world()#

Helper function to load a generated world from self.model_path falling back to self.base_xml

_toggle_target(active: hyphi_gym.common.board.Optional[bool] = None)#

Toggles activity of the target site, can be forced using active

update_world(action: int, position: hyphi_gym.common.board.Union[hyphi_gym.common.board.np.ndarray, tuple], cell: str)#
reset_world()#

Reset simulation and reposition agent and target to respective i_pos

_update(key: str, oldpos, newpos)#
class hyphi_gym.envs.HoleyPlane.HoleyPlane(render_mode=None, **kwargs)#

Bases: hyphi_gym.common.point.Point, hyphi_gym.common.holes.Holes

Base class for Continous Control in Board Games Use for 3D simulation of continuous board envs and rendering of grids