Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[keras/testing_infra] Standardise docstring usage of "Default to" #17979

Merged
merged 1 commit into from
May 16, 2023
Merged

[keras/testing_infra] Standardise docstring usage of "Default to" #17979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions keras/testing_infra/test_combinations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def test_foo(self):
test or class.
exclude_formats: A collection of Keras saved model formats to not run.
(May also be a single format not wrapped in a collection).
Defaults to None.
Defaults to `None`.

Returns:
Returns a decorator that will run the decorated test method multiple
Expand Down Expand Up @@ -258,7 +258,7 @@ def test_foo(self):
test or class.
exclude_models: A collection of Keras model types to not run.
(May also be a single model type not wrapped in a collection).
Defaults to None.
Defaults to `None`.

Returns:
Returns a decorator that will run the decorated test method multiple
Expand Down Expand Up @@ -497,12 +497,13 @@ def keras_mode_combinations(mode=None, run_eagerly=None):

Args:
mode: List of modes to run the tests. The valid options are 'graph' and
'eager'. Default to ['graph', 'eager'] if not specified. If a empty list
is provide, then the test will run under the context based on tf's
version, eg graph for v1 and eager for v2.
'eager'. If None, uses ['graph', 'eager']. If an empty
list is provided, then the test will run under the context based on
tensorflow's version, e.g., graph for v1 and eager for v2. Defaults to
`None`.
run_eagerly: List of `run_eagerly` value to be run with the tests.
Default to [True, False] if not specified. Note that for `graph` mode,
run_eagerly value will only be False.
When None, uses [True, False]. Note that for `graph` mode,
SamuelMarks marked this conversation as resolved.
Show resolved Hide resolved
run_eagerly value will only be False. Defaults to `None`.

Returns:
A list contains all the combinations to be used to generate test cases.
Expand Down
5 changes: 3 additions & 2 deletions keras/testing_infra/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,10 +880,11 @@ def get_multi_io_model(
shared_input_branch: An optional sequence of layers to apply to a single
input, before applying both branches to that intermediate result. If
set, the model will take only one input instead of two. Defaults to
None.
`None`.
shared_output_branch: An optional sequence of layers to merge the
intermediate results produced by branch a and branch b. If set,
the model will produce only one output instead of two. Defaults to None.
the model will produce only one output instead of two.
Defaults to `None`.

Returns:
A multi-io model of the type specified by `get_model_type`, specified
Expand Down