SerialEnv¶
- class torchrl.envs.SerialEnv(*args, **kwargs)[source]¶
在同一进程中创建一系列环境。批处理环境允许用户查询远程运行环境的任意方法/属性。
这些查询将返回一个列表,其长度等于工作进程的数量,其中包含来自这些查询的值。
>>> env = ParallelEnv(3, my_env_fun) >>> custom_attribute_list = env.custom_attribute >>> custom_method_list = env.custom_method(*args)
- 参数:
num_workers – 要同时部署的工作进程(即环境实例)的数量;
create_env_fn (可调用对象 或 可调用对象列表) – 用于环境创建的函数(或函数列表)。如果使用单个任务,则应使用可调用对象,而不是相同的可调用对象列表:如果提供可调用对象列表,则环境将像需要多个不同的任务一样执行,这会带来轻微的计算开销;
- 关键字参数:
create_env_kwargs (字典 或 字典列表, 可选) – 与正在创建的环境一起使用的 kwargs;
share_individual_td (布尔值, 可选) – 如果
True
,则为每个进程/工作进程创建一个不同的 tensordict,并返回一个惰性堆栈。默认值 = None(如果为单个任务则为 False);shared_memory (布尔值) – 返回的 tensordict 是否将放置在共享内存中;
memmap (布尔值) – 返回的 tensordict 是否将放置在内存映射中。
policy_proof (可调用对象, 可选) – 如果提供,它将用于获取要通过
step()
和reset()
方法返回的张量列表,例如"hidden"
等。device (字符串, 整数, torch.device) – 可以传递批处理环境的设备。如果未传递,则从 env 推断。在这种情况下,假定所有环境的设备都匹配。如果提供,则可以与子环境设备不同。在这种情况下,数据将在收集期间自动转换为适当的设备。这可以用于在设备转换引入开销的情况下加速收集(例如,基于 numpy 的环境等):通过为批处理环境使用
"cuda"
设备,但为嵌套环境使用"cpu"
设备,可以将开销降至最低。num_threads (整数, 可选) – 此进程的线程数。应等于一加上每个子进程中启动的进程数(如果启动单个进程则为一)。默认为工作进程数 + 1。此参数对于
SerialEnv
类无效。num_sub_threads (整数, 可选) – 子进程的线程数。为安全起见,默认为 1:如果未指示,启动多个工作进程可能会过度占用 cpu 负载并损害性能。此参数对于
SerialEnv
类无效。serial_for_single (布尔值, 可选) – 如果
True
,则使用单个工作进程创建并行环境将返回SerialEnv
。此选项对于SerialEnv
无效。默认为False
。non_blocking (布尔值, 可选) – 如果
True
,设备移动将使用non_blocking=True
选项完成。默认为True
。mp_start_method (字符串, 可选) – 多进程启动方法。如果未指示,则使用默认启动方法(如果在首次导入之前未以其他方式启动,则在 TorchRL 中默认为 ‘spawn’)。仅与
ParallelEnv
子类一起使用。use_buffers (布尔值, 可选) –
工作进程之间的通信是否应通过循环预分配内存缓冲区进行。默认为
True
,除非其中一个环境具有动态规范。注意
了解有关动态规范和环境的更多信息 此处。
注意
可以使用以下技术将关键字参数传递给每个子环境:
reset()
中的每个关键字参数都将传递给每个环境,除了list_of_kwargs
参数,如果存在,则应包含一个列表,其长度与工作进程的数量相同,其中工作进程特定的关键字参数存储在字典中。如果查询部分重置,则将忽略list_of_kwargs
中对应于未重置的子环境的元素。示例
>>> from torchrl.envs import GymEnv, ParallelEnv, SerialEnv, EnvCreator >>> make_env = EnvCreator(lambda: GymEnv("Pendulum-v1")) # EnvCreator ensures that the env is sharable. Optional in most cases. >>> env = SerialEnv(2, make_env) # Makes 2 identical copies of the Pendulum env, runs them on the same process serially >>> env = ParallelEnv(2, make_env) # Makes 2 identical copies of the Pendulum env, runs them on dedicated processes >>> from torchrl.envs import DMControlEnv >>> env = ParallelEnv(2, [ ... lambda: DMControlEnv("humanoid", "stand"), ... lambda: DMControlEnv("humanoid", "walk")]) # Creates two independent copies of Humanoid, one that walks one that stands >>> rollout = env.rollout(10) # executes 10 random steps in the environment >>> rollout[0] # data for Humanoid stand TensorDict( fields={ action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), next: TensorDict( fields={ com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> rollout[1] # data for Humanoid walk TensorDict( fields={ action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), next: TensorDict( fields={ com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False), head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> # serial_for_single to avoid creating parallel envs if not necessary >>> env = ParallelEnv(1, make_env, serial_for_single=True) >>> assert isinstance(env, SerialEnv) # serial_for_single allows you to avoid creating parallel envs when not necessary
- property action_key: NestedKey¶
环境的动作键。
默认情况下,这将是“action”。
如果环境中存在多个动作键,此函数将引发异常。
- property action_keys: List[NestedKey]¶
环境的动作键。
默认情况下,只会有一个名为“action”的键。
键按数据树中的深度排序。
- property action_spec: TensorSpec¶
action
规范。action_spec
始终存储为复合规范。如果动作规范作为简单规范提供,则将返回此规范。
>>> env.action_spec = Unbounded(1) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果动作规范作为复合规范提供且仅包含一个叶节点,则此函数将仅返回该叶节点。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1)}}) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果动作规范作为复合规范提供且包含多个叶节点,则此函数将返回整个规范。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1), "another_action": Categorical(1)}}) >>> env.action_spec Composite( nested: Composite( action: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_action: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要检索传递的完整规范,请使用
>>> env.input_spec["full_action_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.action_spec BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
- add_module(name: str, module: Optional[Module]) None ¶
将子模块添加到当前模块。
可以使用给定的名称作为属性访问该模块。
- 参数:
name (str) – 子模块的名称。可以使用给定的名称从此模块访问子模块
module (Module) – 要添加到模块的子模块。
- add_truncated_keys()¶
将 truncated 键添加到环境中。
- append_transform(transform: 'Transform' | Callable[[TensorDictBase], TensorDictBase]) None ¶
返回一个转换后的环境,其中应用了传递的可调用对象/转换。
- 参数:
transform (Transform 或 Callable[[TensorDictBase], TensorDictBase]) – 要应用于环境的转换。
示例
>>> from torchrl.envs import GymEnv >>> import torch >>> env = GymEnv("CartPole-v1") >>> loc = 0.5 >>> scale = 1.0 >>> transform = lambda data: data.set("observation", (data.get("observation") - loc)/scale) >>> env = env.append_transform(transform=transform) >>> print(env) TransformedEnv( env=GymEnv(env=CartPole-v1, batch_size=torch.Size([]), device=cpu), transform=_CallableTransform(keys=[]))
- apply(fn: Callable[[Module], None]) T ¶
将
fn
递归应用于每个子模块(由.children()
返回)以及自身。典型用途包括初始化模型的参数(另请参见 torch.nn.init)。
- 参数:
fn (
Module
-> None) – 要应用于每个子模块的函数- 返回:
self
- 返回类型:
Module
示例
>>> @torch.no_grad() >>> def init_weights(m): >>> print(m) >>> if type(m) == nn.Linear: >>> m.weight.fill_(1.0) >>> print(m.weight) >>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2)) >>> net.apply(init_weights) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )
- property batch_locked: bool¶
环境是否可以与不同于初始化时批大小的批大小一起使用。
如果为 True,则环境需要与具有与环境相同批大小的 tensordict 一起使用。 batch_locked 是一个不可变属性。
- property batch_size: Size¶
在此环境实例中批处理的环境数量,以 torch.Size() 对象组织。
环境可能相似或不同,但假定它们之间几乎没有或没有交互(例如,并行执行多任务或批处理)。
- bfloat16() T ¶
将所有浮点参数和缓冲区转换为
bfloat16
数据类型。注意
此方法会就地修改模块。
- 返回:
self
- 返回类型:
Module
- buffers(recurse: bool = True) Iterator[Tensor] ¶
返回模块缓冲区的迭代器。
- 参数:
recurse (布尔值) – 如果为 True,则产生此模块和所有子模块的缓冲区。否则,仅产生作为此模块直接成员的缓冲区。
- 产生:
torch.Tensor – 模块缓冲区
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for buf in model.buffers(): >>> print(type(buf), buf.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- compile(*args, **kwargs)¶
使用
torch.compile()
编译此模块的 forward。此模块的 __call__ 方法已编译,所有参数都按原样传递给
torch.compile()
。有关此函数的参数的详细信息,请参阅
torch.compile()
。
- cpu() T ¶
将所有模型参数和缓冲区移动到 CPU。
注意
此方法会就地修改模块。
- 返回:
self
- 返回类型:
Module
- cuda(device: Optional[Union[int, device]] = None) T ¶
将所有模型参数和缓冲区移动到 GPU。
这也使关联的参数和缓冲区成为不同的对象。因此,如果模块将在 GPU 上进行优化,则应在构建优化器之前调用它。
注意
此方法会就地修改模块。
- 参数:
device (整数, 可选) – 如果指定,所有参数都将复制到该设备
- 返回:
self
- 返回类型:
Module
- property done_key¶
环境的 done 键。
默认情况下,这将是“done”。
如果环境中存在多个 done 键,此函数将引发异常。
- property done_keys: List[NestedKey]¶
环境的 done 键。
默认情况下,只会有一个名为“done”的键。
键按数据树中的深度排序。
- property done_keys_groups¶
done 键的列表,与重置键分组。
这是一个列表的列表。外层列表的长度与重置键的长度相同,内层列表包含 done 键(例如,done 和 truncated),可以在重置键不存在时读取以确定重置。
- property done_spec: TensorSpec¶
done
规范。done_spec
始终存储为复合规范。如果 done 规范作为简单规范提供,则将返回此规范。
>>> env.done_spec = Categorical(2, dtype=torch.bool) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果 done 规范作为复合规范提供且仅包含一个叶节点,则此函数将仅返回该叶节点。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果 done 规范作为复合规范提供且包含多个叶节点,则此函数将返回整个规范。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool), "another_done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Composite( nested: Composite( done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), another_done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要始终检索传递的完整规范,请使用
>>> env.output_spec["full_done_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.done_spec Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
- double() T ¶
将所有浮点参数和缓冲区转换为
double
数据类型。注意
此方法会就地修改模块。
- 返回:
self
- 返回类型:
Module
- empty_cache()¶
清除所有缓存值。
对于常规环境,键列表(reward、done 等)被缓存,但在某些情况下,它们可能会在代码执行期间发生更改(例如,添加转换时)。
- eval() T ¶
将模块设置为评估模式。
这仅对某些模块有效。有关它们在训练/评估模式下的行为的详细信息,请参阅特定模块的文档(如果受到影响),例如
Dropout
、BatchNorm
等。这等效于
self.train(False)
。有关 .eval() 与可能与其混淆的几种类似机制之间的比较,请参阅 在本地禁用梯度计算。
- 返回:
self
- 返回类型:
Module
- extra_repr() str ¶
设置模块的额外表示形式。
要打印自定义的额外信息,你应该在你自己的模块中重新实现此方法。单行和多行字符串都是可接受的。
- fake_tensordict() TensorDictBase ¶
返回一个伪 tensordict,其键值对在形状、设备和 dtype 上与环境 rollout 期间可能期望的内容匹配。
- float() T ¶
将所有浮点参数和缓冲区转换为
float
数据类型。注意
此方法会就地修改模块。
- 返回:
self
- 返回类型:
Module
- forward(tensordict: TensorDictBase) TensorDictBase ¶
定义每次调用时执行的计算。
应由所有子类覆盖。
注意
虽然 forward 传递的配方需要在该函数中定义,但之后应调用
Module
实例而不是此函数,因为前者负责运行注册的钩子,而后者会默默地忽略它们。
- property full_action_spec: Composite¶
完整的动作规范。
full_action_spec
是一个Composite`
实例,其中包含所有动作条目。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_action_spec
- Composite(
- action: BoundedContinuous(
shape=torch.Size([8]), space=ContinuousBox(
low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)),
device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
- property full_done_spec: Composite¶
完整的 done 规范。
full_done_spec
是一个Composite`
实例,其中包含所有 done 条目。它可用于生成伪数据,其结构模仿运行时获得的结构。示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper >>> env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env.full_done_spec Composite( done: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), truncated: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([]))
- property full_reward_spec: Composite¶
完整的奖励规范。
full_reward_spec
是一个Composite`
实例,其中包含所有奖励条目。示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper, TransformedEnv, RenameTransform >>> base_env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env = TransformedEnv(base_env, RenameTransform("reward", ("nested", "reward"))) >>> env.full_reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=None, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- property full_state_spec: Composite¶
完整的状态规范。
full_state_spec
是一个Composite`
实例,其中包含所有状态条目(即,不是动作的输入数据)。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_state_spec Composite( state: Composite( pipeline_state: Composite( q: UnboundedContinuous( shape=torch.Size([15]), space=None, device=cpu, dtype=torch.float32, domain=continuous), [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- get_buffer(target: str) Tensor ¶
如果
target
给定的缓冲区存在,则返回该缓冲区,否则抛出错误。有关此方法的功能以及如何正确指定
target
的更详细说明,请参阅get_submodule
的文档字符串。- 参数:
target – 要查找的缓冲区的完全限定字符串名称。(有关如何指定完全限定字符串,请参阅
get_submodule
。)- 返回:
由
target
引用的缓冲区- 返回类型:
- 引发:
AttributeError – 如果目标字符串引用无效路径或解析为非缓冲区的内容
- get_extra_state() Any ¶
返回要包含在模块 state_dict 中的任何额外状态。
如果需要存储额外状态,请为你的模块实现此方法和相应的
set_extra_state()
。构建模块的 state_dict() 时会调用此函数。请注意,额外状态应该是可 pickle 的,以确保 state_dict 的工作序列化。我们仅为序列化张量提供向后兼容性保证;如果其他对象的序列化 pickle 形式发生更改,则可能会破坏向后兼容性。
- 返回:
要存储在模块 state_dict 中的任何额外状态
- 返回类型:
object
- get_parameter(target: str) Parameter ¶
返回由
target
给定的参数,如果该参数存在,否则抛出错误。有关此方法的功能以及如何正确指定
target
的更详细说明,请参阅get_submodule
的文档字符串。- 参数:
target – 要查找的参数的完整限定字符串名称。(有关如何指定完整限定字符串,请参阅
get_submodule
。)- 返回:
由
target
引用的参数- 返回类型:
torch.nn.Parameter
- 引发:
AttributeError – 如果目标字符串引用了无效路径或解析为非
nn.Parameter
的对象
- get_submodule(target: str) Module ¶
返回由
target
给定的子模块,如果该子模块存在,否则抛出错误。例如,假设您有一个
nn.Module
A
,其结构如下A( (net_b): Module( (net_c): Module( (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2)) ) (linear): Linear(in_features=100, out_features=200, bias=True) ) )
(该图显示了一个
nn.Module
A
。A
有一个嵌套的子模块net_b
,net_b
本身有两个子模块net_c
和linear
。net_c
随后有一个子模块conv
。)要检查我们是否拥有
linear
子模块,我们将调用get_submodule("net_b.linear")
。要检查我们是否拥有conv
子模块,我们将调用get_submodule("net_b.net_c.conv")
。get_submodule
的运行时受target
中模块嵌套程度的限制。针对named_modules
的查询可以实现相同的结果,但它在传递模块的数量上是 O(N) 的。因此,对于简单的检查以查看某些子模块是否存在,应始终使用get_submodule
。- 参数:
target – 要查找的子模块的完整限定字符串名称。(有关如何指定完整限定字符串,请参阅上面的示例。)
- 返回:
由
target
引用的子模块- 返回类型:
- 引发:
AttributeError – 如果目标字符串引用了无效路径或解析为非
nn.Module
的对象
- half() T ¶
将所有浮点参数和缓冲区转换为
half
数据类型。注意
此方法会就地修改模块。
- 返回:
self
- 返回类型:
Module
- property input_spec: TensorSpec¶
输入规格。
包含环境数据输入的所有规格的复合规格。
它包含
“full_action_spec”:输入动作的规格
“full_state_spec”:所有其他环境输入的规格
此属性已锁定,应为只读。相反,要设置其中包含的规格,请使用相应的属性。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.input_spec Composite( full_state_spec: None, full_action_spec: Composite( action: BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- ipu(device: Optional[Union[int, device]] = None) T ¶
将所有模型参数和缓冲区移动到 IPU。
这也使得相关的参数和缓冲区成为不同的对象。因此,如果模块将在 IPU 上进行优化,则应在构建优化器之前调用此方法。
注意
此方法会就地修改模块。
- 参数:
device (整数, 可选) – 如果指定,所有参数都将复制到该设备
- 返回:
self
- 返回类型:
Module
- load_state_dict(*args, **kwargs)[source]¶
将参数和缓冲区从
state_dict
复制到此模块及其后代模块中。如果
strict
为True
,则state_dict
的键必须与此模块的state_dict()
函数返回的键完全匹配。警告
如果
assign
为True
,则必须在调用load_state_dict
之后创建优化器,除非get_swap_module_params_on_conversion()
为True
。- 参数:
state_dict (dict) – 包含参数和持久缓冲区的字典。
strict (bool, optional) – 是否严格强制
state_dict
中的键与此模块的state_dict()
函数返回的键匹配。默认值:True
assign (bool, optional) – 当
False
时,保留当前模块中张量的属性,而当True
时,保留状态字典中张量的属性。唯一的例外是requires_grad
字段。 默认值:``False``
- 返回:
- missing_keys 是一个字符串列表,其中包含此模块预期但在提供的
state_dict
中缺失的任何键。 由本模块预期但在提供的
state_dict
中缺失的任何键组成的字符串列表。
- missing_keys 是一个字符串列表,其中包含此模块预期但在提供的
- unexpected_keys 是一个字符串列表,其中包含此模块未预期但在提供的
state_dict
中存在的键。 由本模块未预期但在提供的
state_dict
中存在的键组成的字符串列表。
- unexpected_keys 是一个字符串列表,其中包含此模块未预期但在提供的
- 返回类型:
NamedTuple
,包含missing_keys
和unexpected_keys
字段
注意
如果参数或缓冲区注册为
None
,并且其对应的键存在于state_dict
中,则load_state_dict()
将引发RuntimeError
。
- maybe_reset(tensordict: TensorDictBase) TensorDictBase ¶
检查输入 tensordict 的完成键,并在需要时重置已完成的环境。
- 参数:
tensordict (TensorDictBase) – 来自
step_mdp()
输出的 tensordict。- 返回:
一个与输入相同的 tensordict,其中环境未重置,并包含环境重置的新重置数据。
- modules() Iterator[Module] ¶
返回网络中所有模块的迭代器。
- 产生:
Module – 网络中的一个模块
注意
重复的模块仅返回一次。在以下示例中,
l
将仅返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.modules()): ... print(idx, '->', m) 0 -> Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) ) 1 -> Linear(in_features=2, out_features=2, bias=True)
- mtia(device: Optional[Union[int, device]] = None) T ¶
将所有模型参数和缓冲区移动到 MTIA。
这也使得相关的参数和缓冲区成为不同的对象。因此,如果模块将在 MTIA 上进行优化,则应在构建优化器之前调用此方法。
注意
此方法会就地修改模块。
- 参数:
device (整数, 可选) – 如果指定,所有参数都将复制到该设备
- 返回:
self
- 返回类型:
Module
- named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Tensor]] ¶
返回模块缓冲区的迭代器,同时产生缓冲区的名称和缓冲区本身。
- 参数:
prefix (str) – 要添加到所有缓冲区名称的前缀。
recurse (bool, optional) – 如果为 True,则产生此模块和所有子模块的缓冲区。否则,仅产生作为此模块直接成员的缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否删除结果中重复的缓冲区。默认为 True。
- 产生:
(str, torch.Tensor) – 包含名称和缓冲区的元组
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, buf in self.named_buffers(): >>> if name in ['running_var']: >>> print(buf.size())
- named_children() Iterator[Tuple[str, Module]] ¶
返回直接子模块的迭代器,同时产生模块的名称和模块本身。
- 产生:
(str, Module) – 包含名称和子模块的元组
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, module in model.named_children(): >>> if name in ['conv4', 'conv5']: >>> print(module)
- named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶
返回网络中所有模块的迭代器,同时产生模块的名称和模块本身。
- 参数:
memo – 用于存储已添加到结果中的模块集合的备忘录
prefix – 将添加到模块名称的前缀
remove_duplicate – 是否删除结果中重复的模块实例
- 产生:
(str, Module) – 名称和模块的元组
注意
重复的模块仅返回一次。在以下示例中,
l
将仅返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.named_modules()): ... print(idx, '->', m) 0 -> ('', Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )) 1 -> ('0', Linear(in_features=2, out_features=2, bias=True))
- named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Parameter]] ¶
返回模块参数的迭代器,同时产生参数的名称和参数本身。
- 参数:
prefix (str) – 要添加到所有参数名称的前缀。
recurse (bool) – 如果为 True,则产生此模块和所有子模块的参数。否则,仅产生作为此模块直接成员的参数。
remove_duplicate (bool, optional) – 是否删除结果中重复的参数。默认为 True。
- 产生:
(str, Parameter) – 包含名称和参数的元组
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, param in self.named_parameters(): >>> if name in ['bias']: >>> print(param.size())
- property observation_spec: Composite¶
观测规格。
必须是
torchrl.data.Composite
实例。重置和步进后可以直接访问规格中列出的键。在 TorchRL 中,即使它们并非严格意义上的“观测”,来自环境的所有信息、状态、转换结果等输出都存储在
observation_spec
中。因此,
"observation_spec"
应被视为环境输出的通用数据容器,这些输出不是完成或奖励数据。示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.observation_spec Composite( observation: BoundedContinuous( shape=torch.Size([3]), space=ContinuousBox( low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
- property output_spec: TensorSpec¶
输出规格。
包含环境数据输出的所有规格的复合规格。
它包含
“full_reward_spec”:奖励的规格
“full_done_spec”:完成状态的规格
“full_observation_spec”:所有其他环境输出的规格
此属性已锁定,应为只读。相反,要设置其中包含的规格,请使用相应的属性。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.output_spec Composite( full_reward_spec: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), full_observation_spec: Composite( observation: BoundedContinuous( shape=torch.Size([3]), space=ContinuousBox( low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), full_done_spec: Composite( done: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- parameters(recurse: bool = True) Iterator[Parameter] ¶
返回模块参数的迭代器。
这通常传递给优化器。
- 参数:
recurse (bool) – 如果为 True,则产生此模块和所有子模块的参数。否则,仅产生作为此模块直接成员的参数。
- 产生:
Parameter – 模块参数
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for param in model.parameters(): >>> print(type(param), param.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- rand_action(tensordict: Optional[TensorDictBase] = None)¶
根据 action_spec 属性执行随机动作。
- 参数:
tensordict (TensorDictBase, optional) – 应该写入结果动作的 tensordict。
- 返回:
一个 tensordict 对象,其中的 “action” 条目已使用来自 action-spec 的随机样本更新。
- rand_step(tensordict: Optional[TensorDictBase] = None) TensorDictBase ¶
根据 action_spec 属性在环境中执行随机步进。
- 参数:
tensordict (TensorDictBase, optional) – 应该写入结果信息的 tensordict。
- 返回:
一个 tensordict 对象,其中包含在环境中随机步进后的新观测。动作将使用 “action” 键存储。
- register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]]) RemovableHandle ¶
在模块上注册一个反向钩子。
此函数已被弃用,推荐使用
register_full_backward_hook()
,并且此函数的行为将在未来版本中更改。- 返回:
一个句柄,可用于通过调用
handle.remove()
删除添加的钩子- 返回类型:
torch.utils.hooks.RemovableHandle
- register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) None ¶
向模块添加缓冲区。
这通常用于注册不应被视为模型参数的缓冲区。例如,BatchNorm 的
running_mean
不是参数,但它是模块状态的一部分。默认情况下,缓冲区是持久的,并将与参数一起保存。可以通过将persistent
设置为False
来更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别是,后者不会成为此模块的state_dict
的一部分。可以使用给定的名称作为属性访问缓冲区。
- 参数:
name (str) – 缓冲区的名称。可以使用给定的名称从此模块访问缓冲区
tensor (Tensor 或 None) – 要注册的缓冲区。如果为
None
,则忽略对缓冲区运行的操作,例如cuda
。如果为None
,则缓冲区不包含在模块的state_dict
中。persistent (bool) – 缓冲区是否为此模块的
state_dict
的一部分。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> self.register_buffer('running_mean', torch.zeros(num_features))
- register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) RemovableHandle ¶
在模块上注册一个前向钩子。
hook 将在每次
forward()
计算输出之后被调用。如果
with_kwargs
为False
或未指定,则输入仅包含传递给模块的位置参数。 关键字参数将不会传递给 hook,而只会传递给forward
。 hook 可以修改输出。 它可以原地修改输入,但由于 hook 在forward()
调用之后被调用,因此不会对 forward 产生影响。 hook 应该具有以下签名hook(module, args, output) -> None or modified output
如果
with_kwargs
为True
,则前向钩子将会传递给 forward 函数的kwargs
,并且期望返回可能被修改的输出。 hook 应该具有以下签名hook(module, args, kwargs, output) -> None or modified output
- 参数:
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果
True
,则提供的hook
将在此torch.nn.modules.Module
上的所有现有forward
hook 之前触发。 否则,提供的hook
将在此torch.nn.modules.Module
上的所有现有forward
hook 之后触发。 请注意,使用register_module_forward_hook()
注册的全局forward
hook 将在此方法注册的所有 hook 之前触发。 默认值:False
with_kwargs (bool) – 如果
True
,则hook
将会传递给 forward 函数的 kwargs。 默认值:False
always_call (bool) – 如果
True
,则无论在调用模块时是否引发异常,hook
都会运行。 默认值:False
- 返回:
一个句柄,可用于通过调用
handle.remove()
删除添加的钩子- 返回类型:
torch.utils.hooks.RemovableHandle
- register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) RemovableHandle ¶
在模块上注册一个前向预钩子。
hook 将在每次
forward()
被调用之前被调用。如果
with_kwargs
为 false 或未指定,则输入仅包含传递给模块的位置参数。 关键字参数将不会传递给 hook,而只会传递给forward
。 hook 可以修改输入。 用户可以在 hook 中返回一个元组或一个修改后的单个值。 如果返回单个值(除非该值已经是元组),我们将把该值包装成一个元组。 hook 应该具有以下签名hook(module, args) -> None or modified input
如果
with_kwargs
为 true,则前向预钩子将会传递给 forward 函数的 kwargs。 并且如果 hook 修改了输入,则 args 和 kwargs 都应该被返回。 hook 应该具有以下签名hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 参数:
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 true,则提供的
hook
将在此torch.nn.modules.Module
上的所有现有forward_pre
hook 之前触发。 否则,提供的hook
将在此torch.nn.modules.Module
上的所有现有forward_pre
hook 之后触发。 请注意,使用register_module_forward_pre_hook()
注册的全局forward_pre
hook 将在此方法注册的所有 hook 之前触发。 默认值:False
with_kwargs (bool) – 如果为 true,则
hook
将会传递给 forward 函数的 kwargs。 默认值:False
- 返回:
一个句柄,可用于通过调用
handle.remove()
删除添加的钩子- 返回类型:
torch.utils.hooks.RemovableHandle
- register_full_backward_hook(hook: Callable[[(Module, Union[Tuple[Tensor, ...], Tensor]], Union[Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle ¶
在模块上注册一个反向钩子。
hook 将在每次计算模块的梯度时被调用,也就是说,当且仅当计算模块输出的梯度时,hook 才会执行。 hook 应该具有以下签名
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
grad_input
和grad_output
是元组,分别包含关于输入和输出的梯度。 hook 不应修改其参数,但可以选择性地返回一个新的关于输入的梯度,该梯度将在后续计算中代替grad_input
使用。grad_input
将仅对应于作为位置参数给出的输入,并且所有 kwarg 参数都将被忽略。 对于所有非 Tensor 参数,grad_input
和grad_output
中的条目将为None
。由于技术原因,当此 hook 应用于模块时,其 forward 函数将接收传递给模块的每个 Tensor 的视图。 类似地,调用者将接收模块的 forward 函数返回的每个 Tensor 的视图。
警告
使用反向钩子时,不允许原地修改输入或输出,并且会引发错误。
- 参数:
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 true,则提供的
hook
将在此torch.nn.modules.Module
上的所有现有backward
hook 之前触发。 否则,提供的hook
将在此torch.nn.modules.Module
上的所有现有backward
hook 之后触发。 请注意,使用register_module_full_backward_hook()
注册的全局backward
hook 将在此方法注册的所有 hook 之前触发。
- 返回:
一个句柄,可用于通过调用
handle.remove()
删除添加的钩子- 返回类型:
torch.utils.hooks.RemovableHandle
- register_full_backward_pre_hook(hook: Callable[[(Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle ¶
在模块上注册一个反向预钩子。
hook 将在每次计算模块的梯度时被调用。 hook 应该具有以下签名
hook(module, grad_output) -> tuple[Tensor] or None
grad_output
是一个元组。 hook 不应修改其参数,但可以选择性地返回一个新的关于输出的梯度,该梯度将在后续计算中代替grad_output
使用。 对于所有非 Tensor 参数,grad_output
中的条目将为None
。由于技术原因,当此 hook 应用于模块时,其 forward 函数将接收传递给模块的每个 Tensor 的视图。 类似地,调用者将接收模块的 forward 函数返回的每个 Tensor 的视图。
警告
使用反向钩子时,不允许原地修改输入,并且会引发错误。
- 参数:
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 true,则提供的
hook
将在此torch.nn.modules.Module
上的所有现有backward_pre
hook 之前触发。 否则,提供的hook
将在此torch.nn.modules.Module
上的所有现有backward_pre
hook 之后触发。 请注意,使用register_module_full_backward_pre_hook()
注册的全局backward_pre
hook 将在此方法注册的所有 hook 之前触发。
- 返回:
一个句柄,可用于通过调用
handle.remove()
删除添加的钩子- 返回类型:
torch.utils.hooks.RemovableHandle
- classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: 'Transform' | None = None, info_keys: List[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)¶
在 gym(nasium) 中注册一个环境。
此方法的设计考虑了以下范围
在一个使用 Gym 的框架中整合一个 TorchRL 优先的环境;
在一个使用 Gym 的框架中整合另一个环境(例如,DeepMind Control、Brax、Jumanji 等)。
- 参数:
id (str) – 环境的名称。 应遵循 gym 命名约定。
- 关键字参数:
entry_point (callable, optional) –
构建环境的入口点。 如果未传递任何内容,则父类将用作入口点。 通常,这用于注册一个不一定从正在使用的基类继承的环境
>>> from torchrl.envs import DMControlEnv >>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run") >>> # equivalently >>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")
transform (torchrl.envs.Transform) – 要与环境一起使用的 transform(或
torchrl.envs.Compose
实例中的 transform 列表)。 此参数可以在调用make()
时传递(见下面的示例)。info_keys (List[NestedKey], optional) –
如果提供,这些键将用于构建 info 字典,并将从观察键中排除。 此参数可以在调用
make()
时传递(见下面的示例)。警告
可能会出现这样的情况:使用
info_keys
会使 spec 为空,因为内容已移动到 info 字典中。 Gym 不喜欢 specs 中有空的Dict
,因此应该使用RemoveEmptySpecs
删除此空内容。backend (str, optional) – 后端。 可以是 “gym” 或 “gymnasium”,或任何其他与
set_gym_backend
兼容的后端。to_numpy (bool, optional) – 如果
True
,则调用 step 和 reset 的结果将映射到 numpy 数组。 默认为False
(结果是 tensors)。 此参数可以在调用make()
时传递(见下面的示例)。reward_threshold (float, optional) – [Gym kwarg] 被认为已学会环境的奖励阈值。
nondeterministic (bool, optional) – [Gym kwarg] 如果环境是非确定性的(即使知道初始种子和所有动作)。 默认为
False
。max_episode_steps (int, optional) – [Gym kwarg] 截断之前的最大 episode 步数。 由 Time Limit wrapper 使用。
order_enforce (bool, optional) – [Gym >= 0.14] 是否应应用 order enforcer wrapper 以确保用户以正确的顺序运行函数。 默认为
True
。autoreset (bool, optional) – [Gym >= 0.14] 是否应添加 autoreset wrapper,以便不需要调用 reset。 默认为
False
。disable_env_checker – [Gym >= 0.14] 是否应为环境禁用 environment checker。 默认为
False
。apply_api_compatibility – [Gym >= 0.26] 是否应用 StepAPICompatibility wrapper。 默认为
False
。**kwargs – 传递给环境构造函数的任意关键字参数。
注意
TorchRL 的环境没有
"info"
字典的概念,因为TensorDict
提供了在大多数训练环境中被认为必要的所有存储需求。 尽管如此,您仍然可以使用info_keys
参数来精细控制哪些内容被视为观察,哪些内容应被视为 info。示例
>>> # Register the "cheetah" env from DMControl with the "run" task >>> from torchrl.envs import DMControlEnv >>> import torch >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gym", env_name="cheetah", task_name="run") >>> import gym >>> envgym = gym.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {}) >>> envgym.step(envgym.action_space.sample()) ({'position': tensor([-0.0833, 0.0275, -0.0612, -0.0770, -0.1256, 0.0082, 0.0186, 0.0476], dtype=torch.float64), 'velocity': tensor([ 0.2221, 0.2256, 0.5930, 2.6937, -3.5865, -1.5479, 0.0187, -0.6825, 0.5224], dtype=torch.float64)}, tensor([0.0018], dtype=torch.float64), tensor([False]), tensor([False]), {}) >>> # same environment with observation stacked >>> from torchrl.envs import CatTensors >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation")) >>> envgym.reset() ({'observation': tensor([-0.1005, 0.0335, -0.0268, 0.0133, -0.0627, 0.0074, -0.0488, -0.0353, -0.0075, -0.0069, 0.0098, -0.0058, 0.0033, -0.0157, -0.0004, -0.0381, -0.0452], dtype=torch.float64)}, {}) >>> # same environment with numpy observations >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"), to_numpy=True) >>> envgym.reset() ({'observation': array([-0.11355747, 0.04257728, 0.00408397, 0.04155852, -0.0389733 , -0.01409826, -0.0978704 , -0.08808327, 0.03970837, 0.00535434, -0.02353762, 0.05116226, 0.02788907, 0.06848346, 0.05154399, 0.0371798 , 0.05128025])}, {}) >>> # If gymnasium is installed, we can register the environment there too. >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gymnasium", env_name="cheetah", task_name="run") >>> import gymnasium >>> envgym = gymnasium.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {})
注意
此功能也适用于无状态环境(例如,
BraxEnv
)。>>> import gymnasium >>> import torch >>> from tensordict import TensorDict >>> from torchrl.envs import BraxEnv, SelectTransform >>> >>> # get action for dydactic purposes >>> env = BraxEnv("ant", batch_size=[2]) >>> env.set_seed(0) >>> torch.manual_seed(0) >>> td = env.rollout(10) >>> >>> actions = td.get("action") >>> >>> # register env >>> env.register_gym("Brax-Ant-v0", env_name="ant", batch_size=[2], info_keys=["state"]) >>> gym_env = gymnasium.make("Brax-Ant-v0") >>> gym_env.seed(0) >>> torch.manual_seed(0) >>> >>> gym_env.reset() >>> obs = [] >>> for i in range(10): ... obs, reward, terminated, truncated, info = gym_env.step(td[..., i].get("action"))
- register_load_state_dict_post_hook(hook)¶
注册一个后钩子,在模块的
load_state_dict()
被调用后运行。- 它应该具有以下签名:
hook(module, incompatible_keys) -> None
module
参数是此 hook 注册的当前模块,并且incompatible_keys
参数是一个NamedTuple
,由属性missing_keys
和unexpected_keys
组成。missing_keys
是一个str
列表,包含缺失的键,而unexpected_keys
是一个str
列表,包含意外的键。如果需要,可以原地修改给定的 incompatible_keys。
请注意,使用
strict=True
调用load_state_dict()
时执行的检查会受到 hook 对missing_keys
或unexpected_keys
所做修改的影响,正如预期的那样。 当strict=True
时,向任一键集添加内容都将导致抛出错误,清除 missing 和 unexpected 键集都将避免错误。- 返回:
一个句柄,可用于通过调用
handle.remove()
删除添加的钩子- 返回类型:
torch.utils.hooks.RemovableHandle
- register_load_state_dict_pre_hook(hook)¶
注册一个预钩子,在模块的
load_state_dict()
被调用之前运行。- 它应该具有以下签名:
hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950
- 参数:
hook (Callable) – 可调用的 hook,将在加载 state dict 之前被调用。
- register_module(name: str, module: Optional[Module]) None ¶
别名:
add_module()
。
- register_parameter(name: str, param: Optional[Parameter]) None ¶
向模块添加一个参数。
可以使用给定的名称作为属性访问该参数。
- 参数:
name (str) – 参数的名称。可以使用给定的名称从此模块访问该参数
param (Parameter 或 None) – 要添加到模块的参数。如果为
None
,则将忽略在参数上运行的操作,例如cuda
。如果为None
,则该参数不包含在模块的state_dict
中。
- register_state_dict_post_hook(hook)¶
为
state_dict()
方法注册一个后置钩子。- 它应该具有以下签名:
hook(module, state_dict, prefix, local_metadata) -> None
注册的钩子可以就地修改
state_dict
。
- register_state_dict_pre_hook(hook)¶
为
state_dict()
方法注册一个前置钩子。- 它应该具有以下签名:
hook(module, prefix, keep_vars) -> None
注册的钩子可用于在调用
state_dict
之前执行预处理。
- requires_grad_(requires_grad: bool = True) T ¶
更改 autograd 是否应记录此模块中参数上的操作。
此方法就地设置参数的
requires_grad
属性。此方法有助于冻结模块的一部分,以进行微调或单独训练模型的各个部分(例如,GAN 训练)。
有关 .requires_grad_() 与可能与其混淆的几种类似机制之间的比较,请参阅 本地禁用梯度计算。
- 参数:
requires_grad (bool) – autograd 是否应记录此模块中参数上的操作。默认值:
True
。- 返回:
self
- 返回类型:
Module
- reset(tensordict: Optional[TensorDictBase] = None, **kwargs) TensorDictBase ¶
重置环境。
对于 step 和 _step,只有私有方法
_reset
应被 EnvBase 子类覆盖。- 参数:
tensordict (TensorDictBase, optional) – 用于包含结果新观察的 tensordict。在某些情况下,此输入也可用于将参数传递给 reset 函数。
kwargs (optional) – 要传递给原生 reset 函数的其他参数。
- 返回:
一个 tensordict(或输入 tensordict,如果有),就地修改为结果观察。
- property reset_keys: List[NestedKey]¶
返回重置键的列表。
重置键是指示部分重置的键,在批量、多任务或多智能体设置中。它们的结构为
(*prefix, "_reset")
,其中prefix
是指向可以找到完成状态的 tensordict 位置的(可能为空的)字符串元组。键按数据树中的深度排序。
- property reward_key¶
环境的奖励键。
默认情况下,这将是“reward”。
如果环境中存在多个奖励键,此函数将引发异常。
- property reward_keys: List[NestedKey]¶
环境的奖励键列表。
默认情况下,将只有一个名为“reward”的键。
键按数据树中的深度排序。
- property reward_spec: TensorSpec¶
reward
规格。reward_spec
始终存储为复合规格。如果奖励规格作为简单规格提供,则将返回此规格。
>>> env.reward_spec = Unbounded(1) >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果奖励规格作为复合规格提供,并且仅包含一个叶子,则此函数将仅返回该叶子。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1)}}) >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果奖励规格作为复合规格提供,并且有多个叶子,则此函数将返回整个规格。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}}) >>> env.reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_reward: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要检索传递的完整规范,请使用
>>> env.output_spec["full_reward_spec"]
此属性是可变的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous)
- rollout(max_steps: int, policy: Optional[Callable[[TensorDictBase], TensorDictBase]] = None, callback: Optional[Callable[[TensorDictBase, ...], Any]] = None, *, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: Optional[bool] = None, break_when_all_done: Optional[bool] = None, return_contiguous: bool = True, tensordict: Optional[TensorDictBase] = None, set_truncated: bool = False, out=None, trust_policy: bool = False)¶
在环境中执行展开。
当包含的环境之一返回 done=True 时,该函数将立即停止。
- 参数:
max_steps (int) – 要执行的最大步数。如果环境在执行 max_steps 之前达到完成状态,则实际步数可能会更小。
policy (callable, optional) – 要调用以计算所需动作的可调用对象。如果未提供策略,则将使用
env.rand_step()
调用动作。策略可以是任何可调用对象,它可以读取 tensordict 或整个观察条目序列,__sorted as__env.observation_spec.keys()
。默认为 None。callback (Callable[[TensorDict], Any], optional) – 在每次迭代时使用给定的 TensorDict 调用的函数。默认为
None
。callback
的输出将不会被收集,用户有责任在 callback 调用中保存任何结果,如果数据需要在 rollout 调用之外进行传输。
- 关键字参数:
auto_reset (bool, optional) – 如果为
True
,则在启动展开时,如果环境处于完成状态,则自动重置环境。默认值为True
。auto_cast_to_device (bool, optional) – 如果为
True
,则在策略使用之前,tensordict 的设备将自动转换为策略设备。默认值为False
。break_when_any_done (bool) – 如果任何完成状态为 True,则中断。如果为 False,则在已完成的子环境上调用 reset()。默认值为 True。
break_when_all_done (bool) – TODO
return_contiguous (bool) – 如果为 False,则将返回 LazyStackedTensorDict。默认值为 True。
tensordict (TensorDict, optional) – 如果
auto_reset
为 False,则必须提供初始 tensordict。Rollout 将检查此 tensordict 是否具有完成标志,并在这些维度中重置环境(如果需要)。如果tensordict
是 reset 的输出,则通常不应发生这种情况,但如果tensordict
是先前展开的最后一步,则可能会发生这种情况。当auto_reset=True
时,如果需要将元数据传递给reset
方法,例如无状态环境的批大小或设备,也可以提供tensordict
。set_truncated (bool, optional) – 如果
True
,则在展开完成后,"truncated"
和"done"
键将设置为True
。如果在done_spec
中未找到"truncated"
,则会引发异常。截断键可以通过env.add_truncated_keys
设置。默认值为False
。trust_policy (bool, optional) – 如果为
True
,则将信任非 TensorDictModule 策略被假定为与收集器兼容。对于 CudaGraphModules,此值默认为True
,否则为False
。
- 返回:
包含结果轨迹的 TensorDict 对象。
返回的数据将使用“time”维度名称标记 tensordict 的最后一个维度(在
env.ndim
索引处)。rollout
非常方便地显示环境的数据结构。示例
>>> # Using rollout without a policy >>> from torchrl.envs.libs.gym import GymEnv >>> from torchrl.envs.transforms import TransformedEnv, StepCounter >>> env = TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20)) >>> rollout = env.rollout(max_steps=1000) >>> print(rollout) TensorDict( fields={ action: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([20]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([20]), device=cpu, is_shared=False) >>> print(rollout.names) ['time'] >>> # with envs that contain more dimensions >>> from torchrl.envs import SerialEnv >>> env = SerialEnv(3, lambda: TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20))) >>> rollout = env.rollout(max_steps=1000) >>> print(rollout) TensorDict( fields={ action: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 20]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 20]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
使用策略(常规
Module
或TensorDictModule
)也很容易示例
>>> from torch import nn >>> env = GymEnv("CartPole-v1", categorical_action_encoding=True) >>> class ArgMaxModule(nn.Module): ... def forward(self, values): ... return values.argmax(-1) >>> n_obs = env.observation_spec["observation"].shape[-1] >>> n_act = env.action_spec.n >>> # A deterministic policy >>> policy = nn.Sequential( ... nn.Linear(n_obs, n_act), ... ArgMaxModule()) >>> env.rollout(max_steps=10, policy=policy) TensorDict( fields={ action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> # Under the hood, rollout will wrap the policy in a TensorDictModule >>> # To speed things up we can do that ourselves >>> from tensordict.nn import TensorDictModule >>> policy = TensorDictModule(policy, in_keys=list(env.observation_spec.keys()), out_keys=["action"]) >>> env.rollout(max_steps=10, policy=policy) TensorDict( fields={ action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False)
在某些情况下,无法获得连续的 tensordict,因为它们无法堆叠。当每步返回的数据可能具有不同的形状,或者当不同的环境一起执行时,可能会发生这种情况。在这种情况下,
return_contiguous=False
将导致返回的 tensordict 成为 tensordict 的惰性堆叠- 非连续展开的示例
>>> rollout = env.rollout(4, return_contiguous=False) >>> print(rollout) LazyStackedTensorDict( fields={ action: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: LazyStackedTensorDict( fields={ done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
展开可以在循环中使用,以模拟数据收集。为此,您需要在调用
step_mdp()
后,将来自先前展开的最后一个 tensordict 作为输入传递。- 数据收集展开的示例
>>> from torchrl.envs import GymEnv, step_mdp >>> env = GymEnv("CartPole-v1") >>> epochs = 10 >>> input_td = env.reset() >>> for i in range(epochs): ... rollout_td = env.rollout( ... max_steps=100, ... break_when_any_done=False, ... auto_reset=False, ... tensordict=input_td, ... ) ... input_td = step_mdp( ... rollout_td[..., -1], ... )
- set_extra_state(state: Any) None ¶
设置加载的 state_dict 中包含的额外状态。
此函数从
load_state_dict()
调用,以处理在 state_dict 中找到的任何额外状态。如果您需要在模块的 state_dict 中存储额外状态,请为您的模块实现此函数和相应的get_extra_state()
。- 参数:
state (dict) – 来自 state_dict 的额外状态
- set_seed(*args, **kwargs)[source]¶
设置环境的种子,并返回要使用的下一个种子(如果存在单个环境,则为输入种子)。
- 参数:
seed (int) – 要设置的种子。种子仅在环境中本地设置。要处理全局种子,请参阅
manual_seed()
。static_seed (bool, optional) – 如果为
True
,则种子不会递增。默认值为 False
- 返回:
即,如果与此环境同时创建另一个环境,则应使用的种子。
- 返回类型:
表示“下一个种子”的整数
- set_submodule(target: str, module: Module) None ¶
如果子模块存在,则设置由
target
给定的子模块,否则抛出错误。例如,假设您有一个
nn.Module
A
,其结构如下A( (net_b): Module( (net_c): Module( (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2)) ) (linear): Linear(in_features=100, out_features=200, bias=True) ) )
(该图显示了一个
nn.Module
A
。A
有一个嵌套的子模块net_b
,net_b
本身有两个子模块net_c
和linear
。net_c
随后有一个子模块conv
。)要使用新的子模块
Linear
覆盖Conv2d
,您可以调用set_submodule("net_b.net_c.conv", nn.Linear(33, 16))
。- 参数:
target – 要查找的子模块的完整限定字符串名称。(有关如何指定完整限定字符串,请参阅上面的示例。)
module – 要将子模块设置为的模块。
- 引发:
ValueError – 如果目标字符串为空
AttributeError – 如果目标字符串引用了无效路径或解析为非
nn.Module
的对象
- property shape¶
等效于
batch_size
。
- state_dict(*args, **kwargs)[source]¶
返回一个字典,其中包含对模块整个状态的引用。
参数和持久缓冲区(例如,运行平均值)都包含在内。键是相应的参数和缓冲区名称。设置为
None
的参数和缓冲区不包括在内。注意
返回的对象是浅拷贝。它包含对模块的参数和缓冲区的引用。
警告
目前,
state_dict()
也按顺序接受destination
、prefix
和keep_vars
的位置参数。但是,这已被弃用,并且将在未来的版本中强制使用关键字参数。警告
请避免使用参数
destination
,因为它不是为最终用户设计的。- 参数:
destination (dict, optional) – 如果提供,模块的状态将更新到字典中,并返回相同的对象。否则,将创建并返回
OrderedDict
。默认值:None
。prefix (str, optional) – 添加到参数和缓冲区名称的前缀,以组成 state_dict 中的键。默认值:
''
。keep_vars (bool, optional) – 默认情况下,state dict 中返回的
Tensor
与 autograd 分离。如果设置为True
,则不会执行分离。默认值:False
。
- 返回:
包含模块整个状态的字典
- 返回类型:
dict
示例
>>> # xdoctest: +SKIP("undefined vars") >>> module.state_dict().keys() ['bias', 'weight']
- property state_keys: List[NestedKey]¶
环境的状态键。
默认情况下,将只有一个名为“state”的键。
键按数据树中的深度排序。
- property state_spec: Composite¶
状态规格。
必须是
torchrl.data.Composite
实例。此处列出的键应与动作一起作为环境的输入提供。在 TorchRL 中,即使它们严格来说不是“状态”,所有不是动作的环境输入都存储在
state_spec
中。因此,“state_spec”应被视为不是动作数据的环境输入的通用数据容器。
示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.state_spec Composite( state: Composite( pipeline_state: Composite( q: UnboundedContinuous( shape=torch.Size([15]), space=None, device=cpu, dtype=torch.float32, domain=continuous), [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- step(tensordict: TensorDictBase) TensorDictBase ¶
在环境中执行一步。
Step 接受一个参数 tensordict,它通常带有一个“action”键,指示要采取的动作。Step 将调用一个外部私有方法 _step,该方法是要由 EnvBase 子类重写的方法。
- 参数:
tensordict (TensorDictBase) – 包含要采取的动作的 Tensordict。如果输入 tensordict 包含一个
"next"
条目,则其中包含的值将优先于新计算的值。这提供了一种覆盖底层计算的机制。- 返回:
输入 tensordict,就地修改为结果观察、完成状态和奖励(以及其他需要的)。
- step_and_maybe_reset(tensordict: TensorDictBase) Tuple[TensorDictBase, TensorDictBase] ¶
在环境中运行一步,并在需要时(部分)重置它。
- 参数:
tensordict (TensorDictBase) –
step()
方法的输入数据结构。
此方法允许轻松编写非停止展开函数。
示例
>>> from torchrl.envs import ParallelEnv, GymEnv >>> def rollout(env, n): ... data_ = env.reset() ... result = [] ... for i in range(n): ... data, data_ = env.step_and_maybe_reset(data_) ... result.append(data) ... return torch.stack(result) >>> env = ParallelEnv(2, lambda: GymEnv("CartPole-v1")) >>> print(rollout(env, 2)) TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False)
- to(device: Union[device, str, int])[source]¶
移动和/或转换参数和缓冲区。
可以这样调用:
- to(device=None, dtype=None, non_blocking=False)[source]
- to(dtype, non_blocking=False)[source]
- to(tensor, non_blocking=False)[source]
- to(memory_format=torch.channels_last)[source]
其签名与
torch.Tensor.to()
类似,但仅接受浮点型或复数dtype
。 此外,此方法将仅将浮点型或复数参数和缓冲区强制转换为dtype
(如果给定)。 整数参数和缓冲区将移动到device
(如果给定),但 dtype 保持不变。 当设置non_blocking
时,如果可能,它会尝试相对于主机异步转换/移动,例如,将具有固定内存的 CPU 张量移动到 CUDA 设备。请参阅以下示例。
注意
此方法会就地修改模块。
- 参数:
device (
torch.device
) – 此模块中参数和期望的设备dtype (
torch.dtype
) – 此模块中参数和缓冲区的期望浮点型或复数 dtypetensor (torch.Tensor) – 张量,其 dtype 和设备是此模块中所有参数和缓冲区的期望 dtype 和设备
memory_format (
torch.memory_format
) – 此模块中 4D 参数和缓冲区的期望内存格式(仅关键字参数)
- 返回:
self
- 返回类型:
Module
示例
>>> # xdoctest: +IGNORE_WANT("non-deterministic") >>> linear = nn.Linear(2, 2) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]]) >>> linear.to(torch.double) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]], dtype=torch.float64) >>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1) >>> gpu1 = torch.device("cuda:1") >>> linear.to(gpu1, dtype=torch.half, non_blocking=True) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1') >>> cpu = torch.device("cpu") >>> linear.to(cpu) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16) >>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble) >>> linear.weight Parameter containing: tensor([[ 0.3741+0.j, 0.2382+0.j], [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128) >>> linear(torch.ones(3, 2, dtype=torch.cdouble)) tensor([[0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)
- to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) T ¶
将参数和缓冲区移动到指定的设备,而不复制存储。
- 参数:
device (
torch.device
) – 此模块中参数和缓冲区的期望设备。recurse (bool) – 子模块的参数和缓冲区是否应递归移动到指定的设备。
- 返回:
self
- 返回类型:
Module
- train(mode: bool = True) T ¶
将模块设置为训练模式。
这仅对某些模块有效。有关它们在训练/评估模式下的行为的详细信息,请参阅特定模块的文档(如果受到影响),例如
Dropout
、BatchNorm
等。- 参数:
mode (bool) – 是否设置训练模式 (
True
) 或评估模式 (False
)。 默认值:True
。- 返回:
self
- 返回类型:
Module
- type(dst_type: Union[dtype, str]) T ¶
将所有参数和缓冲区强制转换为
dst_type
。注意
此方法会就地修改模块。
- 参数:
dst_type (type 或 string) – 期望的类型
- 返回:
self
- 返回类型:
Module
- update_kwargs(kwargs: Union[dict, List[dict]]) None ¶
根据字典或字典列表更新每个环境的 kwargs。
- 参数:
kwargs (dict 或 dict 列表) – 要与环境一起使用的新 kwargs
- xpu(device: Optional[Union[int, device]] = None) T ¶
将所有模型参数和缓冲区移动到 XPU。
这也使得关联的参数和缓冲区成为不同的对象。 因此,如果模块将在 XPU 上运行并进行优化,则应在构建优化器之前调用它。
注意
此方法会就地修改模块。
- 参数:
device (整数, 可选) – 如果指定,所有参数都将复制到该设备
- 返回:
self
- 返回类型:
Module
- zero_grad(set_to_none: bool = True) None ¶
重置所有模型参数的梯度。
有关更多上下文,请参阅
torch.optim.Optimizer
下的类似函数。- 参数:
set_to_none (bool) – 不是设置为零,而是将梯度设置为 None。 有关详细信息,请参阅
torch.optim.Optimizer.zero_grad()
。