Shortcuts

rank_zero

Functions

rank_zero_debug

Function used to log debug-level messages only on global rank 0.

rank_zero_info

Function used to log info-level messages only on global rank 0.

rank_zero_only

Function that can be used as a decorator to enable a function/method being called only on global rank 0.

rank_zero_warn

Function used to log warn-level messages only on global rank 0.

Exceptions

LightningDeprecationWarning

Deprecation warnings raised by PyTorch Lightning.

Utilities that can be used for calling functions on a particular rank.

exception pytorch_lightning.utilities.rank_zero.LightningDeprecationWarning[source]

Bases: DeprecationWarning

Deprecation warnings raised by PyTorch Lightning.

pytorch_lightning.utilities.rank_zero.rank_zero_debug(*args, stacklevel=4, **kwargs)[source]

Function used to log debug-level messages only on global rank 0.

Return type

None

pytorch_lightning.utilities.rank_zero.rank_zero_deprecation(message: Union[str, Warning], stacklevel: int = 4, **kwargs: Any) None

Function used to log warn-level messages only on global rank 0.

pytorch_lightning.utilities.rank_zero.rank_zero_info(*args, stacklevel=4, **kwargs)[source]

Function used to log info-level messages only on global rank 0.

Return type

None

pytorch_lightning.utilities.rank_zero.rank_zero_only(fn)[source]

Function that can be used as a decorator to enable a function/method being called only on global rank 0.

Return type

Callable

pytorch_lightning.utilities.rank_zero.rank_zero_warn(message, stacklevel=4, **kwargs)[source]

Function used to log warn-level messages only on global rank 0.

Return type

None

Read the Docs v: latest
Versions
latest
stable
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
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
future-structure
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.