Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simple reproducibility with minimum boilerplate train_cli #4492

Merged
merged 46 commits into from
Apr 6, 2021
Merged
Changes from 1 commit
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
b04b515
Added new trainer_cli that reduces boilerplate
mauvilsa Nov 3, 2020
186b6d8
- Converted trainer_cli function into a class that can be more easily…
mauvilsa Nov 18, 2020
c7cf9aa
Merge branch 'master' into config_files_argparse
mauvilsa Nov 18, 2020
d286f49
- Fixes required by pep8speaks in trainer_cli.py.
mauvilsa Nov 18, 2020
ed64f31
Renamed class to LightningCLI and other minor fixes
mauvilsa Nov 19, 2020
35d3aa3
- Fixed bug in testcode of trainer_cli.rst.
mauvilsa Nov 30, 2020
6a4ae27
- Renamed files to reflect new class name LightningCLI.
mauvilsa Dec 2, 2020
6f0f2a0
Work on LightningCLI:
mauvilsa Jan 8, 2021
69794a1
Merge branch 'release/1.2-dev' into config_files_argparse
mauvilsa Jan 8, 2021
e91a351
Work on LightningCLI:
mauvilsa Jan 8, 2021
7a76ea6
Work on LightningCLI:
mauvilsa Jan 8, 2021
03be5c4
Swap instantiation of datamodule and model in LightningCLI.
mauvilsa Jan 11, 2021
69904d7
Changed LightningArgumentParser add args methods to a single one add_…
mauvilsa Jan 12, 2021
a726c3f
Made pytorch_lightning.utilities.cli importable even when jsonargpars…
mauvilsa Jan 15, 2021
e498c33
Merge branch 'release/1.2-dev' into config_files_argparse
mauvilsa Jan 15, 2021
2cd09d5
- Fix "Check valid import formatting with isort".
mauvilsa Jan 15, 2021
04fdd5a
Fix "Check valid import formatting with isort"
mauvilsa Jan 15, 2021
a4a4a55
Fix "Check valid import formatting with isort"
mauvilsa Jan 15, 2021
4d2e796
Merge branch 'release/1.2-dev' into config_files_argparse
Borda Jan 19, 2021
1403501
Fix "Check valid import formatting with isort"
mauvilsa Jan 21, 2021
dcbd3d7
Fix "Check valid import formatting with isort"
mauvilsa Jan 21, 2021
2635775
Merge branch 'release/1.2-dev' into config_files_argparse
mauvilsa Feb 1, 2021
4d7f5b9
Update to reflect change in structure in docs/sources
mauvilsa Feb 1, 2021
e4f219a
Merge branch 'master' into config_files_argparse
carmocca Feb 15, 2021
a4da435
Update to latest changes
carmocca Feb 16, 2021
f4e0fbb
Better formatting
carmocca Feb 16, 2021
93f5e75
Merge branch 'master' into config_files_argparse
carmocca Feb 21, 2021
36a578b
Merge branch 'master' into config_files_argparse
Borda Mar 1, 2021
e682a80
Merge branch 'master' into config_files_argparse
carmocca Mar 9, 2021
9c4fc7f
- Change wrapping size to 120 in lightning_cli.rst.
mauvilsa Mar 9, 2021
ebc4944
- Fix missing space around operator.
mauvilsa Mar 9, 2021
aa0a129
- Added trainer_defaults callbacks to unit tests
mauvilsa Mar 9, 2021
c9fc74e
Merge branch 'master' into config_files_argparse
carmocca Mar 30, 2021
05e460c
Merge branch 'master' into config_files_argparse
Borda Mar 30, 2021
1750266
Added unit test for LightningCLI with callbacks as argument
mauvilsa Mar 31, 2021
08b3e5c
Added to LightningCLI documentation the need for the 'all' extras req…
mauvilsa Mar 31, 2021
4e93200
Fixed PEP8 issue in test_lightning_cli.py
mauvilsa Mar 31, 2021
bac68b5
Add beta warnings
carmocca Apr 6, 2021
ee0ff21
Rename test file
carmocca Apr 6, 2021
7475b9f
Refactor callback test. Fix missing log_dir
carmocca Apr 6, 2021
c5b0cec
Typing
carmocca Apr 6, 2021
ff43a8b
Move test file to utilities. Use dict constructor which plays nicer w…
carmocca Apr 6, 2021
c2f0b86
Refactor fn
carmocca Apr 6, 2021
35f5d0d
Use trainer.log_dir
carmocca Apr 6, 2021
9562061
Fix docs
carmocca Apr 6, 2021
5604c04
Minor docs change
carmocca Apr 6, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added to LightningCLI documentation the need for the 'all' extras req…
…uire
  • Loading branch information
mauvilsa committed Mar 31, 2021
commit 08b3e5cd6ecd60b9327d66879af868498a74dc67
4 changes: 4 additions & 0 deletions docs/source/common/lightning_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ are described in the docstrings, then the help of the training tool will display
LightningCLI
^^^^^^^^^^^^

The implementation of training command line tools is done via the :class:`~pytorch_lightning.utilities.cli.LightningCLI`
class. The minimal installation of pytorch-lightning does not include this support. To enable it either install
lightning with the :code:`all` extras require or install the package :code:`jsonargparse[signatures]`.

The case in which the user's :class:`~pytorch_lightning.core.lightning.LightningModule` class implements all required
:code:`*_dataloader` methods, a :code:`trainer.py` tool can be as simple as:

Expand Down