生成器

class torch.Generator(device='cpu')

创建并返回一个生成器对象，该对象管理产生伪随机数的算法的状态。用作许多就地随机采样函数的关键字参数。

参数

device (torch.device, 可选) – 生成器的期望设备。

返回

一个 torch.Generator 对象。

返回类型

生成器

示例

>>> g_cpu = torch.Generator()
>>> g_cuda = torch.Generator(device='cuda')

clone_state() → torch.Generator

克隆生成器的当前状态，并返回一个指向该克隆状态的新生成器。此方法有利于保存生成器的特定状态，以便稍后恢复。

返回

指向新克隆状态的生成器。

返回类型

torch.Generator

示例

>>> g_cuda = torch.Generator(device='cuda')
>>> cloned_state = g_cuda.clone_state()

device

Generator.device -> device

获取生成器的当前设备。

示例

>>> g_cpu = torch.Generator()
>>> g_cpu.device
device(type='cpu')

get_state() → Tensor

将生成器状态作为 torch.ByteTensor 返回。

返回

一个 torch.ByteTensor，其中包含将生成器恢复到特定时间点的所有必要位。

返回类型

张量

示例

>>> g_cpu = torch.Generator()
>>> g_cpu.get_state()

graphsafe_get_state() → torch.Generator

以一种对图捕获安全的方式检索生成器的当前状态。此方法对于确保生成器的状态可以被 CUDA 图捕获至关重要。

返回

指向生成器当前状态的生成器

返回类型

torch.Generator

示例

>>> g_cuda = torch.Generator(device='cuda')
>>> current_state = g_cuda.graphsafe_get_state()

graphsafe_set_state(state) → None

以一种对图捕获安全的方式将生成器的状态设置为指定状态。此方法对于确保生成器的状态可以被 CUDA 图捕获至关重要。

参数

state (torch.Generator) – 指向生成器新状态的生成器，通常从 graphsafe_get_state 获取。

示例

>>> g_cuda = torch.Generator(device='cuda')
>>> g_cuda_other = torch.Generator(device='cuda')
>>> current_state = g_cuda_other.graphsafe_get_state()
>>> g_cuda.graphsafe_set_state(current_state)

initial_seed() → int

返回用于生成随机数的初始种子。

示例

>>> g_cpu = torch.Generator()
>>> g_cpu.initial_seed()
2147483647

manual_seed(seed) → Generator

设置用于生成随机数的种子。返回一个 torch.Generator 对象。任何 32 位整数都是有效的种子。

参数

seed (int) – The desired seed. Value must be within the inclusive range [-0x8000_0000_0000_0000, 0xffff_ffff_ffff_ffff]. Otherwise, a RuntimeError is raised. Negative inputs are remapped to positive values with the formula 0xffff_ffff_ffff_ffff + seed.

返回

一个 torch.Generator 对象。

返回类型

生成器

示例

>>> g_cpu = torch.Generator()
>>> g_cpu.manual_seed(2147483647)

seed() → int

从 std::random_device 或当前时间获取一个非确定性随机数，并用它来播种生成器。

示例

>>> g_cpu = torch.Generator()
>>> g_cpu.seed()
1516516984916

set_state(new_state) → void

设置生成器的状态。

参数

new_state (torch.ByteTensor) – 期望的状态。

示例

>>> g_cpu = torch.Generator()
>>> g_cpu_other = torch.Generator()
>>> g_cpu.set_state(g_cpu_other.get_state())