implement_for

class torchrl._utils.implement_for(module_name: Union[str, Callable], from_version: Optional[str] = None, to_version: Optional[str] = None, *, class_method: bool = False)

一个版本装饰器，用于检查环境中的版本并使用合适的版本实现函数。

如果指定的模块缺失或没有合适的实现，则调用装饰函数将导致显式错误。如果范围相交，则使用最后一个合适的实现。

此包装器也适用于为同一函数实现不同的后端（例如 gym vs gymnasium，numpy vs jax-numpy 等）。

参数:

• module_name (str 或 callable) – 检查具有此名称的模块的版本（例如“gym”）。如果提供可调用对象，则它应返回模块。

• from_version – 实现兼容的版本起点。可以是开放的 (None)。

• to_version – 实现不再兼容的版本起点。可以是开放的 (None)。

关键字参数:

class_method (bool, optional) – 如果 True，函数将写为类方法。默认为 False。

示例

>>> @implement_for("gym", "0.13", "0.14")
>>> def fun(self, x):
...     # Older gym versions will return x + 1
...     return x + 1
...
>>> @implement_for("gym", "0.14", "0.23")
>>> def fun(self, x):
...     # More recent gym versions will return x + 2
...     return x + 2
...
>>> @implement_for(lambda: import_module("gym"), "0.23", None)
>>> def fun(self, x):
...     # More recent gym versions will return x + 2
...     return x + 2
...
>>> @implement_for("gymnasium", None, "1.0.0")
>>> def fun(self, x):
...     # If gymnasium is to be used instead of gym, x+3 will be returned
...     return x + 3
...

这表明该函数与 gym 0.13+ 兼容，但与 gym 0.14+ 不兼容。

static get_class_that_defined_method(f)

返回方法的类（如果已定义），否则返回 None。

classmethod import_module(module_name: Union[Callable, str]) → str

导入模块并返回其版本。

module_set()

如果模块已存在，则在其模块中设置函数。

classmethod reset(setters_dict: Optional[Dict[str, implement_for]] = None)

重置 setter_dict 中的 setter。

setter_dict 是实现的副本。我们只需要遍历其值并为每个值调用 module_set()。