From 88915e454f58b3b0eef55b6dc6bebabf3db7a5b7 Mon Sep 17 00:00:00 2001 From: Gin-Config Team Date: Wed, 4 Dec 2024 00:06:09 -0800 Subject: [PATCH] Clarify documentation around scope hierarchy and inheriting. PiperOrigin-RevId: 702609505 --- README.md | 4 +++- docs/walkthrough.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 77f3c8a..20d0a22 100644 --- 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 index 77f3c8a..20d0a22 100644 --- 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}