From 868c94c13729fea6430fc720a61e30f1befabf2d Mon Sep 17 00:00:00 2001
From: Mauricio Villegas <mauricio_ville@yahoo.com>
Date: Thu, 7 Apr 2022 15:07:03 +0300
Subject: [PATCH] Clarification on omegaconf's interpolation support in
 LightningCLI (#12571)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 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>
---
 docs/source/common/lightning_cli.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/source/common/lightning_cli.rst b/docs/source/common/lightning_cli.rst
index a75c77058e..1a61b56e3c 100644
--- a/docs/source/common/lightning_cli.rst
+++ b/docs/source/common/lightning_cli.rst
@@ -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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^