This repository was archived by the owner on Jul 10, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 579
Updated "optional arguments" section. #250
Open
dynamicwebpaige
wants to merge
2
commits into
master
Choose a base branch
from
dynamicwebpaige-patch-3
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -151,13 +151,18 @@ imperfections into new APIs for the sake of consistency with old APIs. | |
|
||
### Optional arguments with default values | ||
|
||
Many APIs have optional arguments with a default value. Our recommendation is to | ||
use `None` as the default value of any optional arguments and have the | ||
implementation be responsible for handling it as opposed to using a default | ||
value that directly represents the behavior (e.g. `aggregate='sum'`). The | ||
latter prevents the implementation from distinguishing between the caller not | ||
setting the argument vs. the caller setting the argument to the default value, | ||
which may be needed when the default behavior is changing. | ||
Many APIs have optional arguments that assign a default value (for example, `activation = None` | ||
in [`tf.keras.layers.Dense`](https://www.tensorflow.org/api_docs/python/tf/keras/layers/Dense)). | ||
|
||
Our recommendation is to use `None` as the default value for _any optional arguments | ||
that may be adjusted or changed over time_, and have the implementation be responsible | ||
for handling the value, as opposed to using a default value that directly represents | ||
the behavior (e.g. `aggregate='sum'`). The latter prevents the implementation from | ||
distinguishing between the caller not setting the argument vs. the caller setting the | ||
argument to the default value, which may be needed when the default behavior is changing. | ||
|
||
If the optional argument is _backwards incompatible to change_, however, its default should | ||
reflect the actual default value when possible. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we include @fchollet 's Milk example as well? I rather like that as a way to differentiate the two. In code would be ideal, so we can show what we mean by letting the implementation set the value. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The activation function or aggregation is a good example of something backwards incompatible and should be here |
||
|
||
### Does it belong in TF at all? | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe mention num_threads=10 instead of aggregate=sum? That's more in keeping with stuff that can obviously change (changing the aggregation is incompatible)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed!