Skip to content

Commit fd27f0b

Browse files
sync changes.
2 parents 748ef92 + 40dde0b commit fd27f0b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2491
-861
lines changed

docs/api_docs/python/tfds/_api_cache.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,7 @@
462462
"tfds.features.FeatureConnector.save_metadata": true,
463463
"tfds.features.FeatureConnector.shape": true,
464464
"tfds.features.FeaturesDict": false,
465+
"tfds.features.FeaturesDict.__contains__": true,
465466
"tfds.features.FeaturesDict.__getitem__": true,
466467
"tfds.features.FeaturesDict.__init__": true,
467468
"tfds.features.FeaturesDict.__iter__": true,

docs/api_docs/python/tfds/core/SplitBase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ There are three parts to the composition:
4545
to define which files to read and how to skip examples within file.
4646

4747
```
48-
files_to_read = read_instruction.split_info_list
48+
files_to_read = read_instruction.split_info
4949
slice_per_file = read_instruction.slice_list
5050
```
5151

docs/api_docs/python/tfds/features/FeaturesDict.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<meta itemprop="path" content="Stable" />
44
<meta itemprop="property" content="dtype"/>
55
<meta itemprop="property" content="shape"/>
6+
<meta itemprop="property" content="__contains__"/>
67
<meta itemprop="property" content="__getitem__"/>
78
<meta itemprop="property" content="__init__"/>
89
<meta itemprop="property" content="__iter__"/>
@@ -24,11 +25,8 @@
2425

2526
Composite `FeatureConnector`; each feature in `dict` has its own connector.
2627

27-
Inherits From: [`FeatureConnector`](../../tfds/features/FeatureConnector.md)
28-
29-
30-
31-
Defined in [`core/features/feature.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/feature.py).
28+
Defined in
29+
[`core/features/features_dict.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/features_dict.py).
3230

3331
<!-- Placeholder for "Used in" -->
3432

@@ -126,6 +124,12 @@ Return the shape (or dict of shape) of this FeatureConnector.
126124

127125
## Methods
128126

127+
<h3 id="__contains__"><code>__contains__</code></h3>
128+
129+
```python
130+
__contains__(k)
131+
```
132+
129133
<h3 id="__getitem__"><code>__getitem__</code></h3>
130134

131135
``` python
@@ -149,10 +153,18 @@ __len__()
149153
<h3 id="decode_example"><code>decode_example</code></h3>
150154

151155
```python
152-
decode_example(example_dict)
156+
decode_example(serialized_example)
153157
```
154158

155-
See base class for details.
159+
Decode the serialize examples.
160+
161+
#### Args:
162+
163+
* <b>`serialized_example`</b>: Nested `dict` of `tf.Tensor`
164+
165+
#### Returns:
166+
167+
* <b>`example`</b>: Nested `dict` containing the decoded nested examples.
156168

157169
<h3 id="encode_example"><code>encode_example</code></h3>
158170

docs/api_docs/python/tfds/features/Sequence.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@
2020

2121
Composite `FeatureConnector` for a `dict` where each value is a list.
2222

23-
Inherits From: [`FeatureConnector`](../../tfds/features/FeatureConnector.md)
24-
25-
26-
2723
Defined in [`core/features/sequence_feature.py`](https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/features/sequence_feature.py).
2824

2925
<!-- Placeholder for "Used in" -->
@@ -109,9 +105,19 @@ Convenience method to access the underlying features.
109105
<h3 id="decode_example"><code>decode_example</code></h3>
110106

111107
```python
112-
decode_example(tfexample_dict)
108+
decode_example(serialized_example)
113109
```
114110

111+
Decode the serialize examples.
112+
113+
#### Args:
114+
115+
* <b>`serialized_example`</b>: Nested `dict` of `tf.Tensor`
116+
117+
#### Returns:
118+
119+
* <b>`example`</b>: Nested `dict` containing the decoded nested examples.
120+
115121
<h3 id="encode_example"><code>encode_example</code></h3>
116122

117123
```python

docs/api_docs/python/tfds/features/TensorInfo.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Defined in [`core/features/feature.py`](https://github.com/tensorflow/datasets/t
2222
__init__(
2323
shape,
2424
dtype,
25-
default_value=None
25+
default_value=None,
26+
sequence_rank=None
2627
)
2728
```
2829

@@ -34,6 +35,9 @@ Constructor.
3435
* <b>`dtype`</b>: Tensor dtype
3536
* <b>`default_value`</b>: Used for retrocompatibility with previous files if a
3637
new field is added to provide a default value when reading the file.
38+
* <b>`sequence_rank`</b>: `int`, Number of
39+
<a href="../../tfds/features/Sequence.md"><code>tfds.features.Sequence</code></a>
40+
dimension.
3741

3842
## Methods
3943

docs/api_docs/python/tfds/features/Video.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,19 @@ Convenience method to access the underlying features.
105105
<h3 id="decode_example"><code>decode_example</code></h3>
106106

107107
```python
108-
decode_example(tfexample_dict)
108+
decode_example(serialized_example)
109109
```
110110

111+
Decode the serialize examples.
112+
113+
#### Args:
114+
115+
* <b>`serialized_example`</b>: Nested `dict` of `tf.Tensor`
116+
117+
#### Returns:
118+
119+
* <b>`example`</b>: Nested `dict` containing the decoded nested examples.
120+
111121
<h3 id="encode_example"><code>encode_example</code></h3>
112122

113123
``` python

0 commit comments

Comments
 (0)