Skip to content

Commit

Permalink
Update plugins doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kaushikb11 committed Mar 29, 2022
1 parent de8ed15 commit 426cb06
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/source/extensions/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ There are three types of Plugins in Lightning with different responsibilities:

- Precision Plugins
- CheckpointIO Plugins
- Cluster Environments (e.g. customized access to the cluster's environment interface)
- Cluster Environments


Precision Plugins
Expand All @@ -27,7 +27,7 @@ We provide precision plugins for the users so that they can benefit from numeric

.. code-block:: python
# precision: FP16Plugin
# Training with 16-bit precision
trainer = Trainer(precision=16)
The full list of built-in precision plugins is listed below.
Expand All @@ -50,6 +50,7 @@ The full list of built-in precision plugins is listed below.
FullyShardedNativeMixedPrecisionPlugin
IPUPrecisionPlugin

More information regarding precision with Lightning can be found :doc:`here <../advanced/precision>`

CheckpointIO Plugins
--------------------
Expand All @@ -74,7 +75,7 @@ You could learn more about custom checkpointing with Lightning :ref:`here <../co
Cluster Environments
--------------------

Clusters (e.g. customized access to the cluster's environment interface)
Users can define the interface of their own cluster environment based on the requirements of their infrastructure.

.. currentmodule:: pytorch_lightning.plugins.environments

Expand Down

0 comments on commit 426cb06

Please sign in to comment.