MPIEnvironment¶
- class lightning.pytorch.plugins.environments.MPIEnvironment[source]¶
Bases:
lightning.fabric.plugins.environments.cluster_environment.ClusterEnvironment
An environment for running on clusters with processes created through MPI.
Requires the installation of the mpi4py package. See also: https://github.com/mpi4py/mpi4py
- static detect()[source]¶
Returns
True
if the mpi4py package is installed and MPI returns a world size greater than 1.- Return type
- global_rank()[source]¶
The rank (index) of the currently running process across all nodes and devices.
- Return type
- local_rank()[source]¶
The rank (index) of the currently running process inside of the current node.
- Return type
- property creates_processes_externally: bool¶
Whether the environment creates the subprocesses or not.
- Return type