Lightning-AI / Lightning-AI/pytorch-lightning
LightningModule -Inference in Research- phrasing issue
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.4k
- Forks
- 3.8k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 6
Description
### 📚 Documentation
In lightning_module.rst (https://github.com/Lightning-AI/pytorch-lightning/blob/master/docs/source-pytorch/common/lightning_module.rst#inference-in-research), the sentence:
“you can add a forward method to the LightningModule”
is misleading because LightningModule requires forward to be implemented.
cc @lantiga
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/source-pytorch/common/lightning_module.rst at the “Inference in Research” section and read the surrounding explanation of LightningModule.forward. Update the misleading wording so it accurately reflects the requirement, then review the rendered section for clear phrasing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, pytorch
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100