File size: 8,320 Bytes
6e5cc8b |
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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# coding=utf-8
# Copyright 2021 The Google Research Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""A collection of MuJoCo-based Reinforcement Learning environments.
The suite provides a similar API to the original dm_control suite.
Users can configure the distractions on top of the original tasks. The suite is
targeted for loading environments directly with similar configurations as those
used in the original paper. Each distraction wrapper can be used independently
though.
"""
try:
from dm_control import suite # pylint: disable=g-import-not-at-top
from dm_control.suite.wrappers import pixels # pylint: disable=g-import-not-at-top
except ImportError:
suite = None
from envs.distracting_control import background
from envs.distracting_control import camera
from envs.distracting_control import color
from envs.distracting_control import suite_utils
def is_available():
return suite is not None
def load(domain_name,
task_name,
difficulty=None,
dynamic=False,
background_dataset_path=None,
background_dataset_videos="train",
background_kwargs=None,
camera_kwargs=None,
color_kwargs=None,
task_kwargs=None,
environment_kwargs=None,
visualize_reward=False,
render_kwargs=None,
pixels_only=True,
pixels_observation_key="pixels",
env_state_wrappers=None,
#
fixed_distraction=False,
background_seed=None,
color_seed=None,
camera_seed=None,
):
"""Returns an environment from a domain name, task name and optional settings.
```python
env = suite.load('cartpole', 'balance')
```
Adding a difficulty will configure distractions matching the reference paper
for easy, medium, hard.
Users can also toggle dynamic properties for distractions.
Args:
domain_name: A string containing the name of a domain.
task_name: A string containing the name of a task.
difficulty: Difficulty for the suite. One of 'easy', 'medium', 'hard'.
dynamic: Boolean controlling whether distractions are dynamic or static.
background_dataset_path: String to the davis directory that contains the
video directories.
background_dataset_videos: String ('train'/'val') or list of strings of the
DAVIS videos to be used for backgrounds.
background_kwargs: Dict, overwrites settings for background distractions.
camera_kwargs: Dict, overwrites settings for camera distractions.
color_kwargs: Dict, overwrites settings for color disdifficultytractions.
task_kwargs: Dict, dm control task kwargs.
environment_kwargs: Optional `dict` specifying keyword arguments for the
environment.
visualize_reward: Optional `bool`. If `True`, object colours in rendered
frames are set to indicate the reward at each step. Default `False`.
render_kwargs: Dict, render kwargs for pixel wrapper.
pixels_only: Boolean controlling the exclusion of states in the observation.
pixels_observation_key: Key in the observation used for the rendered image.
env_state_wrappers: Env state wrappers to be called before the PixelWrapper.
Returns:
The requested environment.
"""
if not is_available():
raise ImportError("dm_control module is not available. Make sure you "
"follow the installation instructions from the "
"dm_control package.")
if difficulty not in [None, "easy", "medium", "hard"]:
raise ValueError("Difficulty should be one of: 'easy', 'medium', 'hard'.")
render_kwargs = render_kwargs or {}
if "camera_id" not in render_kwargs:
render_kwargs["camera_id"] = 2 if domain_name == "quadruped" else 0
env = suite.load(
domain_name,
task_name,
task_kwargs=task_kwargs,
environment_kwargs=environment_kwargs,
visualize_reward=visualize_reward)
env = distracting_wrapper(
env,
domain_name,
difficulty,
dynamic,
background_dataset_path,
background_dataset_videos,
background_kwargs,
camera_kwargs,
color_kwargs,
render_kwargs,
pixels_only,
pixels_observation_key,
env_state_wrappers,
#
fixed_distraction,
background_seed,
color_seed,
camera_seed
)
return env
def distracting_wrapper(
env,
domain_name,
difficulty=None,
dynamic=False,
background_dataset_path=None,
background_dataset_videos="train",
background_kwargs=None,
camera_kwargs=None,
color_kwargs=None,
render_kwargs=None,
pixels_only=True,
pixels_observation_key="pixels",
env_state_wrappers=None,
#
fixed_distraction=False,
background_seed=None,
color_seed=None,
camera_seed=None):
# Apply background distractions.
if difficulty or background_kwargs:
background_dataset_path = (
background_dataset_path or suite_utils.DEFAULT_BACKGROUND_PATH)
final_background_kwargs = dict(fixed=fixed_distraction, seed=background_seed)
if difficulty:
# Get kwargs for the given difficulty.
num_videos = suite_utils.DIFFICULTY_NUM_VIDEOS[difficulty]
final_background_kwargs.update(
suite_utils.get_background_kwargs(domain_name, num_videos, dynamic,
background_dataset_path,
background_dataset_videos))
else:
# Set the dataset path and the videos.
final_background_kwargs.update(
dict(dataset_path=background_dataset_path,
dataset_videos=background_dataset_videos))
if background_kwargs:
# Overwrite kwargs with those passed here.
final_background_kwargs.update(background_kwargs)
env = background.DistractingBackgroundEnv(env, **final_background_kwargs)
# Apply camera distractions.
if difficulty or camera_kwargs:
final_camera_kwargs = dict(camera_id=render_kwargs["camera_id"], fixed=fixed_distraction, seed=camera_seed)
if difficulty:
# Get kwargs for the given difficulty.
scale = suite_utils.DIFFICULTY_SCALE[difficulty]
final_camera_kwargs.update(
suite_utils.get_camera_kwargs(domain_name, scale, dynamic))
if camera_kwargs:
# Overwrite kwargs with those passed here.
final_camera_kwargs.update(camera_kwargs)
env = camera.DistractingCameraEnv(env, **final_camera_kwargs)
# Apply color distractions.
if difficulty or color_kwargs:
final_color_kwargs = dict(fixed=fixed_distraction, seed=color_seed)
if difficulty:
# Get kwargs for the given difficulty.
scale = suite_utils.DIFFICULTY_SCALE[difficulty]
final_color_kwargs.update(suite_utils.get_color_kwargs(scale, dynamic))
if color_kwargs:
# Overwrite kwargs with those passed here.
final_color_kwargs.update(color_kwargs)
env = color.DistractingColorEnv(env, **final_color_kwargs)
if env_state_wrappers is not None:
for wrapper in env_state_wrappers:
env = wrapper(env)
# Apply Pixel wrapper after distractions. This is needed to ensure the
# changes from the distraction wrapper are applied to the MuJoCo environment
# before the rendering occurs.
env = pixels.Wrapper(
env,
pixels_only=pixels_only,
render_kwargs=render_kwargs,
observation_key=pixels_observation_key)
return env
|