Fix LayerTag docstring: remove misleading 'with the given name'#403
Open
Muneerali199 wants to merge 1 commit into
Open
Fix LayerTag docstring: remove misleading 'with the given name'#403Muneerali199 wants to merge 1 commit into
Muneerali199 wants to merge 1 commit into
Conversation
The __init__ docstring for LayerTag said it initializes 'with the given name', but the constructor takes no arguments and hardcodes the name to 'layer_tag'. This caused confusion for users who tried to pass a name argument. Remove the misleading phrase.
|
It'd be nice to know how to migrate old code to the new system. I am trying to update some code that had import kfac_jax
repeated_dense_tag = kfac_jax.LayerTag("repeated_dense_tag", 1, 1)to use the new system, but I'm unfamiliar with the correct way to register a tag now. It's especially difficult since the documentation has not been re-built in over 2 years. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #401
The
__init__docstring forLayerTagsaid it initializes a primitive"with the given name", implying a
nameparameter. The constructor takesno arguments and hardcodes the name to
"layer_tag".This caused confusion for users who tried to pass a name argument (e.g.,
LayerTag("my_tag")).