Clarification on omegaconf's interpolation support in LightningCLI (#12571)

* Clarification on omegaconf's interpolation support in LightningCLI.

* Update docs/source/common/lightning_cli.rst

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
Co-authored-by: Akihiro Nitta <nitta@akihironitta.com>
This commit is contained in:
Mauricio Villegas 2022-04-07 15:07:03 +03:00 committed by GitHub
parent 6aa8e26a4e
commit 868c94c137
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions

View File

@ -813,6 +813,12 @@ With the encoder-decoder example model above a possible YAML that uses variable
- ${model.encoder_layers}
- 4
.. note::
OmegaConf's interpolation only works within a single config file. Trying to interpolate across command line
arguments or using it in `parser.set_defaults` will not work. More up to date information about the interpolation
support can be found `here <https://jsonargparse.readthedocs.io/en/stable/#variable-interpolation>__`.
Optimizers and learning rate schedulers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^