Skip to content

Commit cf61ed6

Browse files
Conchylicultorcopybara-github
authored andcommitted
Automated documentation update
PiperOrigin-RevId: 291761833
1 parent 1987f10 commit cf61ed6

File tree

143 files changed

+9487
-501
lines changed

Some content is hidden

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

143 files changed

+9487
-501
lines changed

docs/api_docs/python/tfds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ from an image classification dataset.
8080

8181
## Other Members
8282

83-
* `__version__ = '1.3.2'` <a id="__version__"></a>
83+
* `__version__ = '2.0.0'` <a id="__version__"></a>

docs/api_docs/python/tfds/download/GenerateMode.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ source</a>
2020

2121
`Enum` for how to treat pre-existing downloads and data.
2222

23-
**Aliases**: `tfds.GenerateMode`
23+
<section class="expandable">
24+
<h4 class="showalways"><b>View aliases</b></h4>
25+
<p>
26+
<b>Main aliases</b>
27+
<p>`tfds.GenerateMode`</p>
28+
</p>
29+
</section>
2430

2531
<!-- Placeholder for "Used in" -->
2632

docs/api_docs/python/tfds/testing/DatasetBuilderTestCase.md

Lines changed: 74 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -303,10 +303,13 @@ their own type equality functions to provide nicer error messages.
303303

304304
<h3 id="assertAllClose"><code>assertAllClose</code></h3>
305305

306-
``` python
306+
```python
307307
assertAllClose(
308-
*args,
309-
**kwds
308+
a,
309+
b,
310+
rtol=1e-06,
311+
atol=1e-06,
312+
msg=None
310313
)
311314
```
312315

@@ -336,10 +339,19 @@ structure can be a `dict`, `namedtuple`, `tuple` or `list`.
336339

337340
<h3 id="assertAllCloseAccordingToType"><code>assertAllCloseAccordingToType</code></h3>
338341

339-
``` python
342+
```python
340343
assertAllCloseAccordingToType(
341-
*args,
342-
**kwds
344+
a,
345+
b,
346+
rtol=1e-06,
347+
atol=1e-06,
348+
float_rtol=1e-06,
349+
float_atol=1e-06,
350+
half_rtol=0.001,
351+
half_atol=0.001,
352+
bfloat16_rtol=0.01,
353+
bfloat16_atol=0.01,
354+
msg=None
343355
)
344356
```
345357

@@ -366,8 +378,9 @@ one of the arguments is of type float16.
366378

367379
```python
368380
assertAllEqual(
369-
*args,
370-
**kwds
381+
a,
382+
b,
383+
msg=None
371384
)
372385
```
373386

@@ -395,10 +408,10 @@ Same as assertAllEqual but compatible with nested dict.
395408

396409
<h3 id="assertAllGreater"><code>assertAllGreater</code></h3>
397410

398-
``` python
411+
```python
399412
assertAllGreater(
400-
*args,
401-
**kwds
413+
a,
414+
comparison_target
402415
)
403416
```
404417

@@ -412,10 +425,10 @@ Assert element values are all greater than a target value.
412425

413426
<h3 id="assertAllGreaterEqual"><code>assertAllGreaterEqual</code></h3>
414427

415-
``` python
428+
```python
416429
assertAllGreaterEqual(
417-
*args,
418-
**kwds
430+
a,
431+
comparison_target
419432
)
420433
```
421434

@@ -429,10 +442,13 @@ Assert element values are all greater than or equal to a target value.
429442

430443
<h3 id="assertAllInRange"><code>assertAllInRange</code></h3>
431444

432-
``` python
445+
```python
433446
assertAllInRange(
434-
*args,
435-
**kwds
447+
target,
448+
lower_bound,
449+
upper_bound,
450+
open_lower_bound=False,
451+
open_upper_bound=False
436452
)
437453
```
438454

@@ -457,10 +473,10 @@ Assert that elements in a Tensor are all in a given range.
457473

458474
<h3 id="assertAllInSet"><code>assertAllInSet</code></h3>
459475

460-
``` python
476+
```python
461477
assertAllInSet(
462-
*args,
463-
**kwds
478+
target,
479+
expected_set
464480
)
465481
```
466482

@@ -480,10 +496,10 @@ Assert that elements of a Tensor are all in a given closed set.
480496

481497
<h3 id="assertAllLess"><code>assertAllLess</code></h3>
482498

483-
``` python
499+
```python
484500
assertAllLess(
485-
*args,
486-
**kwds
501+
a,
502+
comparison_target
487503
)
488504
```
489505

@@ -497,10 +513,10 @@ Assert element values are all less than a target value.
497513

498514
<h3 id="assertAllLessEqual"><code>assertAllLessEqual</code></h3>
499515

500-
``` python
516+
```python
501517
assertAllLessEqual(
502-
*args,
503-
**kwds
518+
a,
519+
comparison_target
504520
)
505521
```
506522

@@ -546,10 +562,12 @@ assertAlmostEquals(
546562

547563
<h3 id="assertArrayNear"><code>assertArrayNear</code></h3>
548564

549-
``` python
565+
```python
550566
assertArrayNear(
551-
*args,
552-
**kwds
567+
farray1,
568+
farray2,
569+
err,
570+
msg=None
553571
)
554572
```
555573

@@ -730,10 +748,10 @@ unequal.
730748

731749
<h3 id="assertDTypeEqual"><code>assertDTypeEqual</code></h3>
732750

733-
``` python
751+
```python
734752
assertDTypeEqual(
735-
*args,
736-
**kwds
753+
target,
754+
expected_dtype
737755
)
738756
```
739757

@@ -1103,10 +1121,12 @@ Asserts that two multi-line strings are equal.
11031121

11041122
<h3 id="assertNDArrayNear"><code>assertNDArrayNear</code></h3>
11051123

1106-
``` python
1124+
```python
11071125
assertNDArrayNear(
1108-
*args,
1109-
**kwds
1126+
ndarray1,
1127+
ndarray2,
1128+
err,
1129+
msg=None
11101130
)
11111131
```
11121132

@@ -1121,10 +1141,12 @@ Asserts that two numpy arrays have near values.
11211141

11221142
<h3 id="assertNear"><code>assertNear</code></h3>
11231143

1124-
``` python
1144+
```python
11251145
assertNear(
1126-
*args,
1127-
**kwds
1146+
f1,
1147+
f2,
1148+
err,
1149+
msg=None
11281150
)
11291151
```
11301152

@@ -1154,10 +1176,11 @@ Checks whether actual iterable and expected iterable are disjoint.
11541176

11551177
<h3 id="assertNotAllClose"><code>assertNotAllClose</code></h3>
11561178

1157-
``` python
1179+
```python
11581180
assertNotAllClose(
1159-
*args,
1160-
**kwds
1181+
a,
1182+
b,
1183+
**kwargs
11611184
)
11621185
```
11631186

@@ -1178,8 +1201,9 @@ Assert that two numpy arrays, or Tensors, do not have near values.
11781201

11791202
```python
11801203
assertNotAllEqual(
1181-
*args,
1182-
**kwds
1204+
a,
1205+
b,
1206+
msg=None
11831207
)
11841208
```
11851209

@@ -2525,7 +2549,8 @@ Hook method for deconstructing the test fixture after testing it.
25252549

25262550
<h3 id="tearDownClass"><code>tearDownClass</code></h3>
25272551

2528-
``` python
2552+
```python
2553+
@classmethod
25292554
tearDownClass(cls)
25302555
```
25312556

@@ -2574,10 +2599,12 @@ test_registered()
25742599

25752600
<h3 id="test_session"><code>test_session</code></h3>
25762601

2577-
``` python
2602+
```python
25782603
test_session(
2579-
*args,
2580-
**kwds
2604+
graph=None,
2605+
config=None,
2606+
use_gpu=False,
2607+
force_gpu=False
25812608
)
25822609
```
25832610

docs/api_docs/python/tfds/testing/DatasetBuilderTestCase/failureException.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,13 @@
1616

1717
Assertion failed.
1818

19-
**Aliases**: `tfds.testing.FeatureExpectationsTestCase.failureException`,
20-
`tfds.testing.SubTestCase.failureException`,
21-
`tfds.testing.TestCase.failureException`
19+
<section class="expandable">
20+
<h4 class="showalways"><b>View aliases</b></h4>
21+
<p>
22+
<b>Main aliases</b>
23+
<p>`tfds.testing.FeatureExpectationsTestCase.failureException`, `tfds.testing.SubTestCase.failureException`, `tfds.testing.TestCase.failureException`</p>
24+
</p>
25+
</section>
2226

2327
<!-- Placeholder for "Used in" -->
2428

0 commit comments

Comments
 (0)