Skip to content

Errors in documentation generated from lightning.py #5436

@thepooons

Description

@thepooons

📚 Documentation

For typos and doc fixes, please go ahead and:

  1. Create an issue.
  2. Fix the typo.
  3. Submit a PR.

Thanks!

I encountered some doc errors while going through the documentation here:

  • Under test_step section:
    • I believe the statement "If you pass in multiple validation datasets, test_step() will have an additional argument." should be "If you pass in multiple test datasets, test_step() will have an additional argument."
    • I believe the statement "If you don’t need to validate you don’t need to implement this method." should be "If you don’t need to test you don’t need to implement this method."
  • Under the validation_step section:
    • The indentation of a line in pseudocode wrongly implies validation_epoch_end is called for each batch in validation dataset.
    • The statement "If you pass in multiple val datasets, validation_step will have an additional argument." doesn't syntax-highlight validation_step, i.e. validation_step -> validation_step.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation related

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions