Skip to content

Commit 557b040

Browse files
Conchylicultorcopybara-github
authored andcommitted
Automated documentation update
PiperOrigin-RevId: 289974328
1 parent 6db487c commit 557b040

File tree

1,068 files changed

+131046
-3603
lines changed

Some content is hidden

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

1,068 files changed

+131046
-3603
lines changed

docs/api_docs/python/tfds/ReadConfig.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
source</a>
2222

2323
<!-- Equality marker -->
24-
2524
## Class `ReadConfig`
2625

2726
Configures input reading pipeline.
@@ -61,6 +60,8 @@ __init__(
6160
)
6261
```
6362

63+
Initialize self. See help(type(self)) for accurate signature.
64+
6465
## Methods
6566

6667
<h3 id="__eq__"><code>__eq__</code></h3>
@@ -69,6 +70,8 @@ __init__(
6970
__eq__(other)
7071
```
7172

73+
Return self==value.
74+
7275
<h3 id="__ge__"><code>__ge__</code></h3>
7376

7477
```python

docs/api_docs/python/tfds/Split.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
source</a>
2020

2121
<!-- Equality marker -->
22-
2322
## Class `Split`
2423

2524
`Enum` for dataset splits.

docs/api_docs/python/tfds/_api_cache.json

Lines changed: 2399 additions & 1462 deletions
Large diffs are not rendered by default.

docs/api_docs/python/tfds/as_numpy.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
source</a>
1515

1616
<!-- Equality marker -->
17-
1817
Converts a `tf.data.Dataset` to an iterable of NumPy arrays.
1918

2019
``` python

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@
1212
<meta itemprop="property" content="as_dataset"/>
1313
<meta itemprop="property" content="download_and_prepare"/>
1414
<meta itemprop="property" content="BUILDER_CONFIGS"/>
15-
<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
1615
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
17-
<meta itemprop="property" content="VERSION"/>
1816
<meta itemprop="property" content="builder_configs"/>
1917
<meta itemprop="property" content="name"/>
2018
</div>
@@ -30,7 +28,6 @@
3028
source</a>
3129

3230
<!-- Equality marker -->
33-
3431
## Class `BeamBasedBuilder`
3532

3633
Beam based Builder.
@@ -50,6 +47,25 @@ __init__(
5047
)
5148
```
5249

50+
Constructs a DatasetBuilder.
51+
52+
Callers must pass arguments as keyword arguments.
53+
54+
#### Args:
55+
56+
* <b>`data_dir`</b>: `str`, directory to read/write data. Defaults to
57+
datasets are stored.
58+
* <b>`config`</b>:
59+
<a href="../../tfds/core/BuilderConfig.md"><code>tfds.core.BuilderConfig</code></a>
60+
or `str` name, optional configuration for the dataset that affects the data
61+
generated on disk. Different `builder_config`s will have their own
62+
subdirectories and versions.
63+
* <b>`version`</b>: `str`. Optional version at which to load the dataset. An
64+
error is raised if specified version cannot be satisfied. Eg: '1.2.3',
65+
'1.2.*'. The special value "experimental_latest" will use the highest
66+
version, even if not default. This is not recommended unless you know what
67+
you are doing, as the version could be broken.
68+
5369
## Properties
5470

5571
<h3 id="builder_config"><code>builder_config</code></h3>
@@ -205,9 +221,6 @@ Downloads and prepares dataset for reading.
205221
## Class Members
206222

207223
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
208-
* `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
209-
<a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
210224
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
211-
* `VERSION = None` <a id="VERSION"></a>
212225
* `builder_configs` <a id="builder_configs"></a>
213226
* `name = 'beam_based_builder'` <a id="name"></a>

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

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
<div itemscope itemtype="http://developers.google.com/ReferenceObject">
22
<meta itemprop="name" content="tfds.core.BeamMetadataDict" />
33
<meta itemprop="path" content="Stable" />
4+
<meta itemprop="property" content="__contains__"/>
5+
<meta itemprop="property" content="__eq__"/>
6+
<meta itemprop="property" content="__ge__"/>
7+
<meta itemprop="property" content="__gt__"/>
48
<meta itemprop="property" content="__init__"/>
9+
<meta itemprop="property" content="__iter__"/>
10+
<meta itemprop="property" content="__le__"/>
11+
<meta itemprop="property" content="__len__"/>
12+
<meta itemprop="property" content="__lt__"/>
13+
<meta itemprop="property" content="__ne__"/>
14+
<meta itemprop="property" content="__new__"/>
15+
<meta itemprop="property" content="fromkeys"/>
516
<meta itemprop="property" content="load_metadata"/>
617
<meta itemprop="property" content="save_metadata"/>
718
</div>
@@ -17,7 +28,6 @@
1728
source</a>
1829

1930
<!-- Equality marker -->
20-
2131
## Class `BeamMetadataDict`
2232

2333
A <a href="../../tfds/core/Metadata.md"><code>tfds.core.Metadata</code></a>
@@ -36,8 +46,84 @@ source</a>
3646
__init__()
3747
```
3848

49+
Initialize self. See help(type(self)) for accurate signature.
50+
51+
<h2 id="__new__"><code>__new__</code></h2>
52+
53+
```python
54+
__new__(
55+
type,
56+
*args,
57+
**kwargs
58+
)
59+
```
60+
3961
## Methods
4062

63+
<h3 id="__contains__"><code>__contains__</code></h3>
64+
65+
```python
66+
__contains__(key)
67+
```
68+
69+
<h3 id="__eq__"><code>__eq__</code></h3>
70+
71+
```python
72+
__eq__(value)
73+
```
74+
75+
<h3 id="__ge__"><code>__ge__</code></h3>
76+
77+
```python
78+
__ge__(value)
79+
```
80+
81+
<h3 id="__gt__"><code>__gt__</code></h3>
82+
83+
```python
84+
__gt__(value)
85+
```
86+
87+
<h3 id="__iter__"><code>__iter__</code></h3>
88+
89+
```python
90+
__iter__()
91+
```
92+
93+
<h3 id="__le__"><code>__le__</code></h3>
94+
95+
```python
96+
__le__(value)
97+
```
98+
99+
<h3 id="__len__"><code>__len__</code></h3>
100+
101+
```python
102+
__len__()
103+
```
104+
105+
<h3 id="__lt__"><code>__lt__</code></h3>
106+
107+
```python
108+
__lt__(value)
109+
```
110+
111+
<h3 id="__ne__"><code>__ne__</code></h3>
112+
113+
```python
114+
__ne__(value)
115+
```
116+
117+
<h3 id="fromkeys"><code>fromkeys</code></h3>
118+
119+
```python
120+
fromkeys(
121+
type,
122+
iterable,
123+
value
124+
)
125+
```
126+
41127
<h3 id="load_metadata"><code>load_metadata</code></h3>
42128

43129
<a target="_blank" href="https://github.com/tensorflow/datasets/tree/master/tensorflow_datasets/core/dataset_info.py">View

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
source</a>
2020

2121
<!-- Equality marker -->
22-
2322
## Class `BuilderConfig`
2423

2524
Base class for `DatasetBuilder` data configuration.

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@
1212
<meta itemprop="property" content="as_dataset"/>
1313
<meta itemprop="property" content="download_and_prepare"/>
1414
<meta itemprop="property" content="BUILDER_CONFIGS"/>
15-
<meta itemprop="property" content="MANUAL_DOWNLOAD_INSTRUCTIONS"/>
1615
<meta itemprop="property" content="SUPPORTED_VERSIONS"/>
17-
<meta itemprop="property" content="VERSION"/>
1816
<meta itemprop="property" content="builder_configs"/>
1917
<meta itemprop="property" content="name"/>
2018
</div>
@@ -30,7 +28,6 @@
3028
source</a>
3129

3230
<!-- Equality marker -->
33-
3431
## Class `DatasetBuilder`
3532

3633
Abstract base class for all datasets.
@@ -256,9 +253,6 @@ Downloads and prepares dataset for reading.
256253
## Class Members
257254

258255
* `BUILDER_CONFIGS` <a id="BUILDER_CONFIGS"></a>
259-
* `MANUAL_DOWNLOAD_INSTRUCTIONS = None`
260-
<a id="MANUAL_DOWNLOAD_INSTRUCTIONS"></a>
261256
* `SUPPORTED_VERSIONS` <a id="SUPPORTED_VERSIONS"></a>
262-
* `VERSION = None` <a id="VERSION"></a>
263257
* `builder_configs` <a id="builder_configs"></a>
264258
* `name = 'dataset_builder'` <a id="name"></a>

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
source</a>
3636

3737
<!-- Equality marker -->
38-
3938
## Class `DatasetInfo`
4039

4140
Information about a dataset.

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
source</a>
1717

1818
<!-- Equality marker -->
19-
2019
## Class `Experiment`
2120

2221
Experiments which can be enabled/disabled on a per version basis.

0 commit comments

Comments
 (0)