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

Jump to bottom

Update the docstring of @tf.exports methods in tf.nest. #36186

Merged
merged 15 commits into from Feb 19, 2020
Merged

Update the docstring of @tf.exports methods in tf.nest. #36186

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3b8e7c0
Update the documentation
punndcoder28 Jan 24, 2020
7cff0c6
Update Line 246
punndcoder28 Jan 25, 2020
55ac908
Defined structure in module overview
punndcoder28 Jan 26, 2020
e585cc8
Changed scalar to atom
punndcoder28 Jan 26, 2020
acf7733
Change IsMappingHelper to IsNestCompatibleMappingHelper
punndcoder28 Jan 26, 2020
0d36503
Updated module overview
punndcoder28 Jan 27, 2020
fe9a545
Updated util.cc
punndcoder28 Jan 27, 2020
0d9f813
Changed util.cc
Feb 6, 2020
40442b4
Updated util.py
Feb 7, 2020
4c73481
Modified _sequence_like
Feb 8, 2020
052408c
Added mutable mapping support
Feb 8, 2020
5234f66
Added support for MutableMapping
Feb 10, 2020
bc05c61
Updated util.py
Feb 11, 2020
b5b2599
Updated nest.py
Feb 11, 2020
54457e5
Fixed code for pylint
Feb 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 12 additions & 5 deletions tensorflow/python/util/nest.py
View file
Open in desktop
Expand Up @@ -260,8 +260,9 @@ def flatten(structure, expand_composites=False):
running.

Args:
structure: an arbitrarily nested structure or a scalar object. Note, numpy
arrays are considered scalars.
structure: an arbitrarily nested structure which can be a scalar, or
tuple or dict or list of constructed scalars and/or other tuples/lists, or
a scalar object. Note, numpy arrays are considered scalars.
punndcoder28 marked this conversation as resolved.
Show resolved Hide resolved
expand_composites: If true, then composite tensors such as tf.SparseTensor
and tf.RaggedTensor are expanded into their component tensors.

Expand Down Expand Up @@ -306,8 +307,14 @@ def nt(a, b):
```

Args:
nest1: an arbitrarily nested structure.
nest2: an arbitrarily nested structure.
nest1: an arbitrarily nested structure which can be a scalar, or
tuple or dict or list of constructed scalars and/or other
tuples/lists, or a scalar object. Note, numpy arrays are considered
scalars.
nest2: an arbitrarily nested structure which can be a scalar, or
tuple or dict or list of constructed scalars and/or other
tuples/lists, or a scalar object. Note, numpy arrays are considered
scalars.
check_types: if `True` (default) types of sequences are checked as well,
including the keys of dictionaries. If set to `False`, for example a
list and a tuple of objects will look the same if they have the same
Expand Down Expand Up @@ -514,7 +521,7 @@ def map_structure(func, *structure, **kwargs):

Args:
func: A callable that accepts as many arguments as there are structures.
*structure: scalar, or tuple or list of constructed scalars and/or other
*structure: scalar, or tuple or dict or list of constructed scalars and/or other
tuples/lists, or scalars. Note: numpy arrays are considered as scalars.
**kwargs: Valid keyword args are:

Expand Down