mani_skill.envs.tasks.tabletop.pick_clutter_ycb#

Classes#

PickClutterEnv

Base environment picking items out of clutter type of tasks. Flexibly supports using different configurations and object datasets

PickClutterYCBEnv

Base environment picking items out of clutter type of tasks. Flexibly supports using different configurations and object datasets

Module Contents#

class mani_skill.envs.tasks.tabletop.pick_clutter_ycb.PickClutterEnv(*args, robot_uids='panda', robot_init_qpos_noise=0.02, num_envs=1, reconfiguration_freq=None, episode_json=None, **kwargs)[source]#

Bases: mani_skill.envs.sapien_env.BaseEnv

Base environment picking items out of clutter type of tasks. Flexibly supports using different configurations and object datasets

Parameters:

episode_json (str) –

_get_obs_extra(info)[source]#

Get task-relevant extra observations. Usually defined on a task by task basis

Parameters:

info (dict) –

_initialize_episode(env_idx, options)[source]#

Initialize the episode, e.g., poses of actors and articulations, as well as task relevant data like randomizing goal positions

Parameters:
  • env_idx (torch.Tensor) –

  • options (dict) –

_load_agent(options)[source]#

loads the agent/controllable articulations into the environment. The default function provides a convenient way to setup the agent/robot by a robot_uid (stored in self.robot_uids) without requiring the user to have to write the robot building and controller code themselves. For more advanced use-cases you can override this function to have more control over the agent/robot building process.

Parameters:
  • options (dict) – The options for the environment.

  • initial_agent_poses (Optional[Union[sapien.Pose, Pose]]) – The initial poses of the agent/robot. Providing these poses and ensuring they are picked such that they do not collide with objects if spawned there is highly recommended to ensure more stable simulation (the agent pose can be changed later during episode initialization).

  • build_separate (bool) – Whether to build the agent/robot separately. If True, the agent/robot will be built separately for each parallel environment and then merged together to be accessible under one view/object. This is useful for randomizing physical and visual properties of the agent/robot which is only permitted for articulations built separately in each environment.

abstract _load_model(model_id)[source]#
Parameters:

model_id (str) –

Return type:

mani_skill.utils.building.actor_builder.ActorBuilder

_load_scene(options)[source]#

Loads all objects like actors and articulations into the scene. Called by self._reconfigure. Given options argument is the same options dictionary passed to the self.reset function

Parameters:

options (dict) –

_sample_target_objects()[source]#
evaluate()[source]#

Evaluate whether the environment is currently in a success state by returning a dictionary with a “success” key or a failure state via a “fail” key

This function may also return additional data that has been computed (e.g. is the robot grasping some object) that may be reused when generating observations and rewards.

By default if not overriden this function returns an empty dictionary

DEFAULT_ASSET_ROOT: str[source]#
DEFAULT_EPISODE_JSON: str[source]#
DEFAULT_MODEL_JSON: str[source]#
SUPPORTED_REWARD_MODES = ['none'][source]#
SUPPORTED_ROBOTS = ['panda', 'fetch'][source]#

Override this to enforce which robots or tuples of robots together are supported in the task. During env creation, setting robot_uids auto loads all desired robots into the scene, but not all tasks are designed to support some robot setups

property _default_human_render_camera_configs[source]#

Add default cameras for rendering when using render_mode=’rgb_array’. These can be overriden by the user at env creation time

property _default_sensor_configs[source]#

Add default (non-agent) sensors to the environment by returning sensor configurations. These can be overriden by the user at env creation time

property _default_sim_config[source]#
_episodes: list[dict][source]#
agent: mani_skill.agents.robots.Panda | mani_skill.agents.robots.Fetch[source]#
robot_init_qpos_noise = 0.02[source]#
class mani_skill.envs.tasks.tabletop.pick_clutter_ycb.PickClutterYCBEnv(*args, robot_uids='panda', robot_init_qpos_noise=0.02, num_envs=1, reconfiguration_freq=None, episode_json=None, **kwargs)[source]#

Bases: PickClutterEnv

Base environment picking items out of clutter type of tasks. Flexibly supports using different configurations and object datasets

Parameters:

episode_json (str) –

_load_model(model_id)[source]#
DEFAULT_EPISODE_JSON = 'Instance of pathlib.Path/tasks/pick_clutter/ycb_train_5k.json.gz'[source]#

a link to a sample video of the task. This is mostly used for automatic documentation generation