Shortcuts

SingleDevicePlugin

class pytorch_lightning.plugins.training_type.SingleDevicePlugin(device)[source]

Bases: pytorch_lightning.plugins.training_type.training_type_plugin.TrainingTypePlugin

Plugin that handles communication on a single device.

all_gather(tensor, group=None, sync_grads=False)[source]

Perform a all_gather on all processes

Return type

Tensor

barrier(*args, **kwargs)[source]

Forces all possibly joined processes to wait for each other

Return type

None

broadcast(obj, src=0)[source]

Broadcasts an object to all processes

Return type

object

model_to_device()[source]

Moves the model to the correct device

Return type

None

reduce(tensor, *args, **kwargs)[source]

Reduces a tensor from several distributed processes to one aggregated tensor. As this plugin only operates with a single device, the reduction is simply the identity.

Parameters
  • tensor (Union[Any, Tensor]) – the tensor to sync and reduce

  • *args – ignored

  • **kwargs – ignored

Return type

Union[Any, Tensor]

Returns

the unmodified input as reduction is not needed for single process operation

setup(model)[source]

Called by the accelerator to finish setup.

Return type

Module

teardown()[source]

This method is called to teardown the training process. It is the right place to release memory and free other resources.

Return type

None

property is_global_zero: bool

Whether the current process is the rank zero process not only on the local node, but for all nodes.

Return type

bool

property on_gpu: bool

Returns whether the current process is done on GPU

Return type

bool

property on_tpu: bool

Returns whether the current process is done on TPU

Return type

bool

property root_device: torch.device

Returns the root device

Return type

device

Read the Docs v: 1.4.3
Versions
latest
stable
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.10
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.10.0
0.9.0
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.6
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.0
0.5.3
0.4.9
ipynb-update
docs-search
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.