Clarify documentation around scope hierarchy and inheriting.

PiperOrigin-RevId: 700991340
google · Nov 28, 2024 · 416fbff · 416fbff
1 parent a966a40
commit 416fbff
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -232,7 +232,9 @@ output.
 
 Any parameters set on the "root" (unscoped) function name are inherited by
 scoped variants (unless explicitly overridden), so in the above example both the
-generator and the discriminator use the `tf.nn.tanh` activation function.
+generator and the discriminator use the `tf.nn.tanh` activation function.  This
+works in general for a hierarchy of scopes, e.g., if we are in a scope named
+`a/b` the config will inherit all the values from scope `a`.
 
 ### 5. Full hierarchical configuration {#full-hierarchical}
 

diff --git a/docs/walkthrough.md b/docs/walkthrough.md
@@ -232,7 +232,9 @@ output.
 
 Any parameters set on the "root" (unscoped) function name are inherited by
 scoped variants (unless explicitly overridden), so in the above example both the
-generator and the discriminator use the `tf.nn.tanh` activation function.
+generator and the discriminator use the `tf.nn.tanh` activation function.  This
+works in general for a hierarchy of scopes, e.g., if we are in a scope named
+`a/b` the config will inherit all the values from scope `a`.
 
 ### 5. Full hierarchical configuration {#full-hierarchical}