File size: 31,143 Bytes
406662d | 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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 | # Copyright (c) 2022-2026, The Isaac Lab Project Developers (https://github.com/isaac-sim/IsaacLab/blob/main/CONTRIBUTORS.md).
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
# needed to import for allowing type-hinting: torch.Tensor | None
from __future__ import annotations
"""Launch Isaac Sim Simulator first."""
from isaaclab.app import AppLauncher
# launch omniverse app
simulation_app = AppLauncher(headless=True).app
"""Rest everything follows."""
from collections import namedtuple
from typing import TYPE_CHECKING
import pytest
import torch
import isaaclab.sim as sim_utils
from isaaclab.managers import (
ManagerTermBase,
ObservationGroupCfg,
ObservationManager,
ObservationTermCfg,
RewardTermCfg,
)
from isaaclab.utils import configclass, modifiers
if TYPE_CHECKING:
from isaaclab.envs import ManagerBasedEnv
def grilled_chicken(env):
return torch.ones(env.num_envs, 4, device=env.device)
def grilled_chicken_with_bbq(env, bbq: bool):
return bbq * torch.ones(env.num_envs, 1, device=env.device)
def grilled_chicken_with_curry(env, hot: bool):
return hot * 2 * torch.ones(env.num_envs, 1, device=env.device)
def grilled_chicken_with_yoghurt(env, hot: bool, bland: float):
return hot * bland * torch.ones(env.num_envs, 5, device=env.device)
def grilled_chicken_with_yoghurt_and_bbq(env, hot: bool, bland: float, bbq: bool = False):
return hot * bland * bbq * torch.ones(env.num_envs, 3, device=env.device)
def grilled_chicken_image(env, bland: float, channel: int = 1):
return bland * torch.ones(env.num_envs, 128, 256, channel, device=env.device)
class complex_function_class(ManagerTermBase):
def __init__(self, cfg: ObservationTermCfg, env: object):
self.cfg = cfg
self.env = env
# define some variables
self._time_passed = torch.zeros(env.num_envs, device=env.device)
def reset(self, env_ids: torch.Tensor | None = None):
if env_ids is None:
env_ids = slice(None)
self._time_passed[env_ids] = 0.0
def __call__(self, env: object, interval: float) -> torch.Tensor:
self._time_passed += interval
return self._time_passed.clone().unsqueeze(-1)
class non_callable_complex_function_class(ManagerTermBase):
def __init__(self, cfg: ObservationTermCfg, env: object):
self.cfg = cfg
self.env = env
# define some variables
self._cost = 2 * self.env.num_envs
def call_me(self, env: object) -> torch.Tensor:
return torch.ones(env.num_envs, 2, device=env.device) * self._cost
class MyDataClass:
def __init__(self, num_envs: int, device: str):
self.pos_w = torch.rand((num_envs, 3), device=device)
self.lin_vel_w = torch.rand((num_envs, 3), device=device)
def pos_w_data(env) -> torch.Tensor:
return env.data.pos_w
def lin_vel_w_data(env) -> torch.Tensor:
return env.data.lin_vel_w
@pytest.fixture(autouse=True)
def setup_env():
dt = 0.01
num_envs = 20
device = "cuda:0"
# set up sim
sim_cfg = sim_utils.SimulationCfg(dt=dt, device=device)
sim = sim_utils.SimulationContext(sim_cfg)
# create dummy environment
env = namedtuple("ManagerBasedEnv", ["num_envs", "device", "data", "dt", "sim"])(
num_envs, device, MyDataClass(num_envs, device), dt, sim
)
# let the simulation play (we need this for observation manager to compute obs dims)
env.sim._app_control_on_stop_handle = None
env.sim.reset()
return env
def test_str(setup_env):
env = setup_env
"""Test the string representation of the observation manager."""
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class SampleGroupCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, scale=10)
term_2 = ObservationTermCfg(func=grilled_chicken, scale=2)
term_3 = ObservationTermCfg(func=grilled_chicken_with_bbq, scale=5, params={"bbq": True})
term_4 = ObservationTermCfg(
func=grilled_chicken_with_yoghurt, scale=1.0, params={"hot": False, "bland": 2.0}
)
term_5 = ObservationTermCfg(
func=grilled_chicken_with_yoghurt_and_bbq, scale=1.0, params={"hot": False, "bland": 2.0}
)
policy: ObservationGroupCfg = SampleGroupCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
assert len(obs_man.active_terms["policy"]) == 5
# print the expected string
obs_man_str = str(obs_man)
print()
print(obs_man_str)
obs_man_str_split = obs_man_str.split("|")
term_1_str_index = obs_man_str_split.index(" term_1 ")
term_1_str_shape = obs_man_str_split[term_1_str_index + 1].strip()
assert term_1_str_shape == "(4,)"
def test_str_with_history(setup_env):
env = setup_env
"""Test the string representation of the observation manager with history terms."""
TERM_1_HISTORY = 5
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class SampleGroupCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, scale=10, history_length=TERM_1_HISTORY)
term_2 = ObservationTermCfg(func=grilled_chicken, scale=2)
term_3 = ObservationTermCfg(func=grilled_chicken_with_bbq, scale=5, params={"bbq": True})
term_4 = ObservationTermCfg(
func=grilled_chicken_with_yoghurt, scale=1.0, params={"hot": False, "bland": 2.0}
)
term_5 = ObservationTermCfg(
func=grilled_chicken_with_yoghurt_and_bbq, scale=1.0, params={"hot": False, "bland": 2.0}
)
policy: ObservationGroupCfg = SampleGroupCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
assert len(obs_man.active_terms["policy"]) == 5
# print the expected string
obs_man_str = str(obs_man)
print()
print(obs_man_str)
obs_man_str_split = obs_man_str.split("|")
term_1_str_index = obs_man_str_split.index(" term_1 ")
term_1_str_shape = obs_man_str_split[term_1_str_index + 1].strip()
assert term_1_str_shape == "(20,)"
def test_config_equivalence(setup_env):
env = setup_env
"""Test the equivalence of observation manager created from different config types."""
# create from config class
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class SampleGroupCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
your_term = ObservationTermCfg(func=grilled_chicken, scale=10)
his_term = ObservationTermCfg(func=grilled_chicken, scale=2)
my_term = ObservationTermCfg(func=grilled_chicken_with_bbq, scale=5, params={"bbq": True})
her_term = ObservationTermCfg(
func=grilled_chicken_with_yoghurt, scale=1.0, params={"hot": False, "bland": 2.0}
)
policy = SampleGroupCfg()
critic = SampleGroupCfg(concatenate_terms=False, her_term=None)
cfg = MyObservationManagerCfg()
obs_man_from_cfg = ObservationManager(cfg, env)
# create from config class
@configclass
class MyObservationManagerAnnotatedCfg:
"""Test config class for observation manager with annotations on terms."""
@configclass
class SampleGroupCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
your_term: ObservationTermCfg = ObservationTermCfg(func=grilled_chicken, scale=10)
his_term: ObservationTermCfg = ObservationTermCfg(func=grilled_chicken, scale=2)
my_term: ObservationTermCfg = ObservationTermCfg(
func=grilled_chicken_with_bbq, scale=5, params={"bbq": True}
)
her_term: ObservationTermCfg = ObservationTermCfg(
func=grilled_chicken_with_yoghurt, scale=1.0, params={"hot": False, "bland": 2.0}
)
policy: ObservationGroupCfg = SampleGroupCfg()
critic: ObservationGroupCfg = SampleGroupCfg(concatenate_terms=False, her_term=None)
cfg = MyObservationManagerAnnotatedCfg()
obs_man_from_annotated_cfg = ObservationManager(cfg, env)
# check equivalence
# parsed terms
assert obs_man_from_cfg.active_terms == obs_man_from_annotated_cfg.active_terms
assert obs_man_from_cfg.group_obs_term_dim == obs_man_from_annotated_cfg.group_obs_term_dim
assert obs_man_from_cfg.group_obs_dim == obs_man_from_annotated_cfg.group_obs_dim
# parsed term configs
assert obs_man_from_cfg._group_obs_term_cfgs == obs_man_from_annotated_cfg._group_obs_term_cfgs
assert obs_man_from_cfg._group_obs_concatenate == obs_man_from_annotated_cfg._group_obs_concatenate
def test_config_terms(setup_env):
env = setup_env
"""Test the number of terms in the observation manager."""
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class SampleGroupCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, scale=10)
term_2 = ObservationTermCfg(func=grilled_chicken_with_curry, scale=0.0, params={"hot": False})
@configclass
class SampleMixedGroupCfg(ObservationGroupCfg):
"""Test config class for policy observation group with a mix of vector and matrix terms."""
concatenate_terms = False
term_1 = ObservationTermCfg(func=grilled_chicken, scale=2.0)
term_2 = ObservationTermCfg(func=grilled_chicken_image, scale=1.5, params={"bland": 0.5})
@configclass
class SampleImageGroupCfg(ObservationGroupCfg):
term_1 = ObservationTermCfg(func=grilled_chicken_image, scale=1.5, params={"bland": 0.5, "channel": 1})
term_2 = ObservationTermCfg(func=grilled_chicken_image, scale=0.5, params={"bland": 0.1, "channel": 3})
policy: ObservationGroupCfg = SampleGroupCfg()
critic: ObservationGroupCfg = SampleGroupCfg(term_2=None)
mixed: ObservationGroupCfg = SampleMixedGroupCfg()
image: ObservationGroupCfg = SampleImageGroupCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
assert len(obs_man.active_terms["policy"]) == 2
assert len(obs_man.active_terms["critic"]) == 1
assert len(obs_man.active_terms["mixed"]) == 2
assert len(obs_man.active_terms["image"]) == 2
# create a new obs manager but where mixed group has invalid config
cfg = MyObservationManagerCfg()
cfg.mixed.concatenate_terms = True
with pytest.raises(RuntimeError):
ObservationManager(cfg, env)
def test_compute(setup_env):
env = setup_env
"""Test the observation computation."""
pos_scale_tuple = (2.0, 3.0, 1.0)
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, scale=10)
term_2 = ObservationTermCfg(func=grilled_chicken_with_curry, scale=0.0, params={"hot": False})
term_3 = ObservationTermCfg(func=pos_w_data, scale=pos_scale_tuple)
term_4 = ObservationTermCfg(func=lin_vel_w_data, scale=1.5)
@configclass
class CriticCfg(ObservationGroupCfg):
term_1 = ObservationTermCfg(func=pos_w_data, scale=pos_scale_tuple)
term_2 = ObservationTermCfg(func=lin_vel_w_data, scale=1.5)
term_3 = ObservationTermCfg(func=pos_w_data, scale=pos_scale_tuple)
term_4 = ObservationTermCfg(func=lin_vel_w_data, scale=1.5)
@configclass
class ImageCfg(ObservationGroupCfg):
term_1 = ObservationTermCfg(func=grilled_chicken_image, scale=1.5, params={"bland": 0.5, "channel": 1})
term_2 = ObservationTermCfg(func=grilled_chicken_image, scale=0.5, params={"bland": 0.1, "channel": 3})
policy: ObservationGroupCfg = PolicyCfg()
critic: ObservationGroupCfg = CriticCfg()
image: ObservationGroupCfg = ImageCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# obtain the group observations
obs_policy: torch.Tensor = observations["policy"]
obs_critic: torch.Tensor = observations["critic"]
obs_image: torch.Tensor = observations["image"]
# check the observation shape
assert obs_policy.shape == (env.num_envs, 11)
assert obs_critic.shape == (env.num_envs, 12)
assert obs_image.shape == (env.num_envs, 128, 256, 4)
# check that the scales are applied correctly
assert torch.equal(env.data.pos_w * torch.tensor(pos_scale_tuple, device=env.device), obs_critic[:, :3])
assert torch.equal(env.data.lin_vel_w * 1.5, obs_critic[:, 3:6])
# make sure that the data are the same for same terms
# -- within group
assert torch.equal(obs_critic[:, 0:3], obs_critic[:, 6:9])
assert torch.equal(obs_critic[:, 3:6], obs_critic[:, 9:12])
# -- between groups
assert torch.equal(obs_policy[:, 5:8], obs_critic[:, 0:3])
assert torch.equal(obs_policy[:, 8:11], obs_critic[:, 3:6])
def test_compute_with_history(setup_env):
env = setup_env
"""Test the observation computation with history buffers."""
HISTORY_LENGTH = 5
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, history_length=HISTORY_LENGTH)
# total observation size: term_dim (4) * history_len (5) = 20
term_2 = ObservationTermCfg(func=lin_vel_w_data)
# total observation size: term_dim (3) = 3
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# obtain the group observations
obs_policy: torch.Tensor = observations["policy"]
# check the observation shape
assert obs_policy.shape == (env.num_envs, 23)
# check the observation data
expected_obs_term_1_data = torch.ones(env.num_envs, 4 * HISTORY_LENGTH, device=env.device)
expected_obs_term_2_data = lin_vel_w_data(env)
expected_obs_data_t0 = torch.concat((expected_obs_term_1_data, expected_obs_term_2_data), dim=-1)
torch.testing.assert_close(expected_obs_data_t0, obs_policy)
# test that the history buffer holds previous data
for _ in range(HISTORY_LENGTH):
observations = obs_man.compute()
obs_policy = observations["policy"]
expected_obs_term_1_data = torch.ones(env.num_envs, 4 * HISTORY_LENGTH, device=env.device)
expected_obs_data_t5 = torch.concat((expected_obs_term_1_data, expected_obs_term_2_data), dim=-1)
assert torch.equal(expected_obs_data_t5, obs_policy)
# test reset
obs_man.reset()
observations = obs_man.compute()
obs_policy = observations["policy"]
torch.testing.assert_close(expected_obs_data_t0, obs_policy)
# test reset of specific env ids
reset_env_ids = [2, 4, 16]
obs_man.reset(reset_env_ids)
torch.testing.assert_close(expected_obs_data_t0[reset_env_ids], obs_policy[reset_env_ids])
def test_compute_with_2d_history(setup_env):
env = setup_env
"""Test the observation computation with history buffers for 2D observations."""
HISTORY_LENGTH = 5
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class FlattenedPolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(
func=grilled_chicken_image, params={"bland": 1.0, "channel": 1}, history_length=HISTORY_LENGTH
)
# total observation size: term_dim (128, 256) * history_len (5) = 163840
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(
func=grilled_chicken_image,
params={"bland": 1.0, "channel": 1},
history_length=HISTORY_LENGTH,
flatten_history_dim=False,
)
# total observation size: (5, 128, 256, 1)
flat_obs_policy: ObservationGroupCfg = FlattenedPolicyCfg()
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# obtain the group observations
obs_policy_flat: torch.Tensor = observations["flat_obs_policy"]
obs_policy: torch.Tensor = observations["policy"]
# check the observation shapes
assert obs_policy_flat.shape == (env.num_envs, 163840)
assert obs_policy.shape == (env.num_envs, HISTORY_LENGTH, 128, 256, 1)
def test_compute_with_group_history(setup_env):
env = setup_env
"""Test the observation computation with group level history buffer configuration."""
TERM_HISTORY_LENGTH = 5
GROUP_HISTORY_LENGTH = 10
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
history_length = GROUP_HISTORY_LENGTH
# group level history length will override all terms
term_1 = ObservationTermCfg(func=grilled_chicken, history_length=TERM_HISTORY_LENGTH)
# total observation size: term_dim (4) * history_len (5) = 20
# with override total obs size: term_dim (4) * history_len (10) = 40
term_2 = ObservationTermCfg(func=lin_vel_w_data)
# total observation size: term_dim (3) = 3
# with override total obs size: term_dim (3) * history_len (10) = 30
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# obtain the group observations
obs_policy: torch.Tensor = observations["policy"]
# check the total observation shape
assert obs_policy.shape == (env.num_envs, 70)
# check the observation data is initialized properly
expected_obs_term_1_data = torch.ones(env.num_envs, 4 * GROUP_HISTORY_LENGTH, device=env.device)
expected_obs_term_2_data = lin_vel_w_data(env).repeat(1, GROUP_HISTORY_LENGTH)
expected_obs_data_t0 = torch.concat((expected_obs_term_1_data, expected_obs_term_2_data), dim=-1)
torch.testing.assert_close(expected_obs_data_t0, obs_policy)
# test that the history buffer holds previous data
for _ in range(GROUP_HISTORY_LENGTH):
observations = obs_man.compute()
obs_policy = observations["policy"]
expected_obs_term_1_data = torch.ones(env.num_envs, 4 * GROUP_HISTORY_LENGTH, device=env.device)
expected_obs_term_2_data = lin_vel_w_data(env).repeat(1, GROUP_HISTORY_LENGTH)
expected_obs_data_t10 = torch.concat((expected_obs_term_1_data, expected_obs_term_2_data), dim=-1)
torch.testing.assert_close(expected_obs_data_t10, obs_policy)
# test reset
obs_man.reset()
observations = obs_man.compute()
obs_policy = observations["policy"]
torch.testing.assert_close(expected_obs_data_t0, obs_policy)
# test reset of specific env ids
reset_env_ids = [2, 4, 16]
obs_man.reset(reset_env_ids)
torch.testing.assert_close(expected_obs_data_t0[reset_env_ids], obs_policy[reset_env_ids])
def test_invalid_observation_config(setup_env):
env = setup_env
"""Test the invalid observation config."""
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken_with_bbq, scale=0.1, params={"hot": False})
term_2 = ObservationTermCfg(func=grilled_chicken_with_yoghurt, scale=2.0, params={"hot": False})
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
# check the invalid config
with pytest.raises(ValueError):
ObservationManager(cfg, env)
def test_callable_class_term(setup_env):
env = setup_env
"""Test the observation computation with callable class term."""
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, scale=10)
term_2 = ObservationTermCfg(func=complex_function_class, scale=0.2, params={"interval": 0.5})
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# check the observation
assert observations["policy"].shape == (env.num_envs, 5)
assert observations["policy"][0, -1].item() == pytest.approx(0.2 * 0.5)
# check memory in term
num_exec_count = 10
for _ in range(num_exec_count):
observations = obs_man.compute()
assert observations["policy"][0, -1].item() == pytest.approx(0.2 * 0.5 * (num_exec_count + 1))
# check reset works
obs_man.reset(env_ids=[0, 4, 9, 14, 19])
observations = obs_man.compute()
assert observations["policy"][0, -1].item() == pytest.approx(0.2 * 0.5)
assert observations["policy"][1, -1].item() == pytest.approx(0.2 * 0.5 * (num_exec_count + 2))
def test_non_callable_class_term(setup_env):
env = setup_env
"""Test the observation computation with non-callable class term."""
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
term_1 = ObservationTermCfg(func=grilled_chicken, scale=10)
term_2 = ObservationTermCfg(func=non_callable_complex_function_class, scale=0.2)
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager config
cfg = MyObservationManagerCfg()
# create observation manager
with pytest.raises(NotImplementedError):
ObservationManager(cfg, env)
def test_modifier_compute(setup_env):
env = setup_env
"""Test the observation computation with modifiers."""
modifier_1 = modifiers.ModifierCfg(func=modifiers.bias, params={"value": 1.0})
modifier_2 = modifiers.ModifierCfg(func=modifiers.scale, params={"multiplier": 2.0})
modifier_3 = modifiers.ModifierCfg(func=modifiers.clip, params={"bounds": (-0.5, 0.5)})
modifier_4 = modifiers.IntegratorCfg(dt=env.dt)
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
concatenate_terms = False
term_1 = ObservationTermCfg(func=pos_w_data, modifiers=[])
term_2 = ObservationTermCfg(func=pos_w_data, modifiers=[modifier_1])
term_3 = ObservationTermCfg(func=pos_w_data, modifiers=[modifier_1, modifier_4])
@configclass
class CriticCfg(ObservationGroupCfg):
"""Test config class for critic observation group"""
concatenate_terms = False
term_1 = ObservationTermCfg(func=pos_w_data, modifiers=[])
term_2 = ObservationTermCfg(func=pos_w_data, modifiers=[modifier_1])
term_3 = ObservationTermCfg(func=pos_w_data, modifiers=[modifier_1, modifier_2])
term_4 = ObservationTermCfg(func=pos_w_data, modifiers=[modifier_1, modifier_2, modifier_3])
policy: ObservationGroupCfg = PolicyCfg()
critic: ObservationGroupCfg = CriticCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# obtain the group observations
obs_policy: dict[str, torch.Tensor] = observations["policy"]
obs_critic: dict[str, torch.Tensor] = observations["critic"]
# check correct application of modifications
assert torch.equal(obs_policy["term_1"] + 1.0, obs_policy["term_2"])
assert torch.equal(obs_critic["term_1"] + 1.0, obs_critic["term_2"])
assert torch.equal(2.0 * (obs_critic["term_1"] + 1.0), obs_critic["term_3"])
assert torch.min(obs_critic["term_4"]) >= -0.5
assert torch.max(obs_critic["term_4"]) <= 0.5
def test_serialize(setup_env):
"""Test serialize call for ManagerTermBase terms."""
env = setup_env
serialize_data = {"test": 0}
class test_serialize_term(ManagerTermBase):
def __init__(self, cfg: RewardTermCfg, env: ManagerBasedEnv):
super().__init__(cfg, env)
def __call__(self, env: ManagerBasedEnv) -> torch.Tensor:
return grilled_chicken(env)
def serialize(self) -> dict:
return serialize_data
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
concatenate_terms = False
term_1 = ObservationTermCfg(func=test_serialize_term)
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# check expected output
assert obs_man.serialize() == {"policy": {"term_1": serialize_data}}
def test_modifier_invalid_config(setup_env):
env = setup_env
"""Test modifier initialization with invalid config."""
modifier = modifiers.ModifierCfg(func=modifiers.clip, params={"min": -0.5, "max": 0.5})
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
concatenate_terms = False
term_1 = ObservationTermCfg(func=pos_w_data, modifiers=[modifier])
policy: ObservationGroupCfg = PolicyCfg()
# create observation manager
cfg = MyObservationManagerCfg()
with pytest.raises(ValueError):
ObservationManager(cfg, env)
def test_concatenate_dim(setup_env):
"""Test concatenation of observations along different dimensions."""
env = setup_env
@configclass
class MyObservationManagerCfg:
"""Test config class for observation manager."""
@configclass
class PolicyCfg(ObservationGroupCfg):
"""Test config class for policy observation group."""
concatenate_terms = True
concatenate_dim = 1 # Concatenate along dimension 1
term_1 = ObservationTermCfg(func=grilled_chicken_image, scale=1.0, params={"bland": 1.0, "channel": 1})
term_2 = ObservationTermCfg(func=grilled_chicken_image, scale=1.0, params={"bland": 1.0, "channel": 1})
@configclass
class CriticCfg(ObservationGroupCfg):
"""Test config class for critic observation group."""
concatenate_terms = True
concatenate_dim = 2 # Concatenate along dimension 2
term_1 = ObservationTermCfg(func=grilled_chicken_image, scale=1.0, params={"bland": 1.0, "channel": 1})
term_2 = ObservationTermCfg(func=grilled_chicken_image, scale=1.0, params={"bland": 1.0, "channel": 1})
@configclass
class CriticCfg_neg_dim(ObservationGroupCfg):
"""Test config class for critic observation group."""
concatenate_terms = True
concatenate_dim = -1 # Concatenate along last dimension
term_1 = ObservationTermCfg(func=grilled_chicken_image, scale=1.0, params={"bland": 1.0, "channel": 1})
term_2 = ObservationTermCfg(func=grilled_chicken_image, scale=1.0, params={"bland": 1.0, "channel": 1})
policy: ObservationGroupCfg = PolicyCfg()
critic: ObservationGroupCfg = CriticCfg()
critic_neg_dim: ObservationGroupCfg = CriticCfg_neg_dim()
# create observation manager
cfg = MyObservationManagerCfg()
obs_man = ObservationManager(cfg, env)
# compute observation using manager
observations = obs_man.compute()
# obtain the group observations
obs_policy: torch.Tensor = observations["policy"]
obs_critic: torch.Tensor = observations["critic"]
obs_critic_neg_dim: torch.Tensor = observations["critic_neg_dim"]
# check the observation shapes
# For policy: concatenated along dim 1, so width should be doubled
assert obs_policy.shape == (env.num_envs, 128, 512, 1)
# For critic: concatenated along last dim, so channels should be doubled
assert obs_critic.shape == (env.num_envs, 128, 256, 2)
# For critic_neg_dim: concatenated along last dim, so channels should be doubled
assert obs_critic_neg_dim.shape == (env.num_envs, 128, 256, 2)
# verify the data is concatenated correctly
# For policy: check that the second half matches the first half
torch.testing.assert_close(obs_policy[:, :, :256, :], obs_policy[:, :, 256:, :])
# For critic: check that the second channel matches the first channel
torch.testing.assert_close(obs_critic[:, :, :, 0], obs_critic[:, :, :, 1])
# For critic_neg_dim: check that it is the same as critic
torch.testing.assert_close(obs_critic_neg_dim, obs_critic)
|