Docs & Rules

Lightning-AI/pytorch-lightningGitHubLast refreshed Oct 2, 2026

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

1 name in these docs no longer matches the code.

master84df182listed 17h ago

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

1 stale4

30 docs, listed Oct 2

Lightning-AI/pytorch-lightningOpen repository

Names these docs write that the code no longer has1

Each sentence below names a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

Gonelightning.pytorch.strategies.SingleXLAStrategy
- :class:~lightning.pytorch.strategies.SingleXLAStrategy
lightning.pytorch.strategies declares nothing by this name. Closest name there: SingleDeviceStrategy.
View on GitHub

Lightning-AI/pytorch-lightning — documented rules

7 of 7 rules, printed October 3, 2026.

	The sentence in your docs
Read Oct 2	class LightningTransformer(L.LightningModule): def __init__(self, vocab_size): super().__init__() self.model = Transformer(vocab_size=vocab_size)	LightningTransformer depends on Transformer	Holds
Read Oct 2	This includes metrics logged via :meth:`~lightning.pytorch.core.LightningModule.log`.	LightningModule has `log`	Holds
Read Oct 2	If you want to terminate the training during ``.fit, you can set` `trainer.should_stop=True`` to terminate the training as soon as possible.	Trainer has `should_stop`	Holds
Read Oct 2	Strategy controls the model distribution across training, evaluation, and prediction to be used by the :doc:`Trainer <../common/trainer>`.	Trainer depends on Strategy	Holds
Read Oct 2	Strategy is a composition of one :doc:`Accelerator <../extensions/accelerator>`, one :ref:`Precision Plugin <extensions/plugins:Precision Plugins>`, a :ref:`CheckpointIO <extensions/plugins:CheckpointIO Plugins>` plugin and other optional plugins such as the :ref:`ClusterEnvironment <extensions/plugins:Cluster Environments>`.	Strategy depends on Accelerator	Holds
Read Oct 2	Strategy is a composition of one :doc:`Accelerator <../extensions/accelerator>`, one :ref:`Precision Plugin <extensions/plugins:Precision Plugins>`, a :ref:`CheckpointIO <extensions/plugins:CheckpointIO Plugins>` plugin and other optional plugins such as the :ref:`ClusterEnvironment <extensions/plugins:Cluster Environments>`.	Strategy depends on Precision	Holds
Read Oct 2	Strategy is a composition of one :doc:`Accelerator <../extensions/accelerator>`, one :ref:`Precision Plugin <extensions/plugins:Precision Plugins>`, a :ref:`CheckpointIO <extensions/plugins:CheckpointIO Plugins>` plugin and other optional plugins such as the :ref:`ClusterEnvironment <extensions/plugins:Cluster Environments>`.	Strategy depends on CheckpointIO	Holds

7 rules from 3 docs

See these where the change is. The browser extension puts a pull request's doc findings, and a diagram of what it changed, on the GitHub page itself, so the code and what your docs say about it are side by side.