Skip to content

Commit c0017c0

Browse files
committed
Generate Python docs from pytorch/pytorch@d8f8e6a
1 parent ddc4548 commit c0017c0

File tree

2,778 files changed

+10580
-10446
lines changed

Some content is hidden

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

2,778 files changed

+10580
-10446
lines changed

main/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: f43de878b71665916c7a71e880c3fdcc
3+
config: 2f4e5cf59b8c570e3613bf46cd93154c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

main/_images/RReLU.png

85 Bytes
Loading

main/_images/ReduceLROnPlateau.png

-43 Bytes
Loading

main/_sources/community/persons_of_interest.rst.txt

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,9 @@ TorchVision
376376
~~~~~~~~~~~
377377

378378
- Nicolas Hug (`NicolasHug <https://github.com/NicolasHug>`__)
379-
- Philip Meier (`pmeier <https://github.com/pmeier>`__)
380-
- Victor Fomin (`vfdev-5 <https://github.com/vfdev-5>`__)
379+
- Antoine Simoulin (`AntoineSimoulin <https://github.com/AntoineSimoulin>`__)
380+
- (emeritus) Philip Meier (`pmeier <https://github.com/pmeier>`__)
381+
- (emeritus) Victor Fomin (`vfdev-5 <https://github.com/vfdev-5>`__)
381382
- (emeritus) Francisco Massa (`fmassa <https://github.com/fmassa>`__)
382383
- (emeritus) Vasilis Vryniotis (`datumbox <https://github.com/datumbox>`__)
383384
- (emeritus) Yosua Michael Maranatha (`YosuaMichael <https://github.com/YosuaMichael>`__)
@@ -418,8 +419,11 @@ TorchX
418419
TorchData
419420
~~~~~~~~~~~~~~~~~~~~~~
420421

421-
- Andrew Ho (`andrewkho <https://github.com/andrewkho>`__)
422422
- Divyansh Khanna (`divyanshk <https://github.com/divyanshk>`__)
423+
- Ramanish Singh (`ramanishsingh <https://github.com/ramanishsingh>`__)
424+
- Lavender (`aelavender <https://github.com/aelavender>`__)
425+
- Scott Schneider (`scotts <https://github.com/scotts>`__)
426+
- (emeritus) Andrew Ho (`andrewkho <https://github.com/andrewkho>`__)
423427

424428
TorchArrow
425429
~~~~~~~~~~~~~~~~~~~~~~
@@ -452,6 +456,6 @@ TorchChat
452456
TorchCodec
453457
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
454458

455-
- Nicolas Hug (`nicolashug <https://github.com/nicolashug>`__)
456-
- Ahmad Sharif (`ahmadsharif1 <https://github.com/ahmadsharif1>`__)
459+
- Nicolas Hug (`NicolasHug <https://github.com/NicolasHug>`__)
457460
- Scott Schneider (`scotts <https://github.com/scotts>`__)
461+
- (emeritus) Ahmad Sharif (`ahmadsharif1 <https://github.com/ahmadsharif1>`__)

main/_sources/data.md.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -337,11 +337,16 @@ GPUs.
337337
Since workers rely on Python {py:mod}`multiprocessing`, worker launch behavior is
338338
different on Windows compared to Unix.
339339

340-
- On Unix, {func}`fork()` is the default {py:mod}`multiprocessing` start method.
340+
- On Unix, The default {py:mod}`multiprocessing` start method is {func}`forkserver`
341+
for Python >= 3.14; {func}`fork` for Python < 3.14.
341342
Using {func}`fork`, child workers typically can access the {attr}`dataset` and
342-
Python argument functions directly through the cloned address space.
343-
- On Windows or MacOS, {func}`spawn()` is the default {py:mod}`multiprocessing` start method.
344-
Using {func}`spawn()`, another interpreter is launched which runs your main script,
343+
Python argument functions directly through the cloned address space. This can have a fast start up,
344+
but can lead to problems with multi-threaded applications. On Unix platforms that support it, {func}`forkserver`
345+
starts a separate server process first, and all new worker processes are then spawned by that server,
346+
providing safer isolation than {func}`fork` (especially with threads)
347+
while avoiding some of the overhead of pure {func}`spawn`.
348+
- On Windows and MacOS, {func}`spawn` is the default {py:mod}`multiprocessing` start method.
349+
Using {func}`spawn`, another interpreter is launched which runs your main script,
345350
followed by the internal worker function that receives the {attr}`dataset`,
346351
{attr}`collate_fn` and other arguments through {py:mod}`pickle` serialization.
347352

main/_sources/distributed.tensor.md.txt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,12 @@ DTensor supports the following types of {class}`Placement` on each {class}`Devic
8787
:undoc-members:
8888
```
8989

90+
```{eval-rst}
91+
.. autoclass:: _StridedShard
92+
:members:
93+
:undoc-members:
94+
```
95+
9096
```{eval-rst}
9197
.. autoclass:: Replicate
9298
:members:
@@ -100,7 +106,7 @@ DTensor supports the following types of {class}`Placement` on each {class}`Devic
100106
```
101107

102108
```{eval-rst}
103-
.. autoclass:: MaskPartial
109+
.. autoclass:: _MaskPartial
104110
:members:
105111
:undoc-members:
106112
```

main/_sources/generated/exportdb/index.rst.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ support in export please create an issue in the pytorch/pytorch repo with a modu
1919
:caption: Tags
2020

2121
torch.escape-hatch
22-
torch.dynamic-shape
2322
torch.cond
23+
torch.dynamic-shape
2424
python.closure
2525
torch.dynamic-value
2626
python.data-structure
@@ -235,7 +235,7 @@ cond_branch_class_method
235235

236236
.. note::
237237

238-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
238+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
239239

240240
Support Level: SUPPORTED
241241

@@ -317,7 +317,7 @@ cond_branch_nested_function
317317

318318
.. note::
319319

320-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
320+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
321321

322322
Support Level: SUPPORTED
323323

@@ -396,7 +396,7 @@ cond_branch_nonlocal_variables
396396

397397
.. note::
398398

399-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
399+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
400400

401401
Support Level: SUPPORTED
402402

@@ -500,7 +500,7 @@ cond_closed_over_variable
500500

501501
.. note::
502502

503-
Tags: :doc:`python.closure <python.closure>`, :doc:`torch.cond <torch.cond>`
503+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`python.closure <python.closure>`
504504

505505
Support Level: SUPPORTED
506506

@@ -576,7 +576,7 @@ cond_operands
576576

577577
.. note::
578578

579-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
579+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
580580

581581
Support Level: SUPPORTED
582582

@@ -668,7 +668,7 @@ cond_predicate
668668

669669
.. note::
670670

671-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
671+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
672672

673673
Support Level: SUPPORTED
674674

@@ -1099,7 +1099,7 @@ dynamic_shape_if_guard
10991099

11001100
.. note::
11011101

1102-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.control-flow <python.control-flow>`
1102+
Tags: :doc:`python.control-flow <python.control-flow>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
11031103

11041104
Support Level: SUPPORTED
11051105

@@ -1156,7 +1156,7 @@ dynamic_shape_map
11561156

11571157
.. note::
11581158

1159-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.map <torch.map>`
1159+
Tags: :doc:`torch.map <torch.map>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
11601160

11611161
Support Level: SUPPORTED
11621162

main/_sources/generated/exportdb/python.closure.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ cond_closed_over_variable
55

66
.. note::
77

8-
Tags: :doc:`python.closure <python.closure>`, :doc:`torch.cond <torch.cond>`
8+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`python.closure <python.closure>`
99

1010
Support Level: SUPPORTED
1111

main/_sources/generated/exportdb/python.control-flow.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ dynamic_shape_if_guard
55

66
.. note::
77

8-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.control-flow <python.control-flow>`
8+
Tags: :doc:`python.control-flow <python.control-flow>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
99

1010
Support Level: SUPPORTED
1111

main/_sources/generated/exportdb/torch.cond.rst.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ cond_branch_class_method
55

66
.. note::
77

8-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
8+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
99

1010
Support Level: SUPPORTED
1111

@@ -87,7 +87,7 @@ cond_branch_nested_function
8787

8888
.. note::
8989

90-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
90+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
9191

9292
Support Level: SUPPORTED
9393

@@ -166,7 +166,7 @@ cond_branch_nonlocal_variables
166166

167167
.. note::
168168

169-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
169+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
170170

171171
Support Level: SUPPORTED
172172

@@ -270,7 +270,7 @@ cond_closed_over_variable
270270

271271
.. note::
272272

273-
Tags: :doc:`python.closure <python.closure>`, :doc:`torch.cond <torch.cond>`
273+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`python.closure <python.closure>`
274274

275275
Support Level: SUPPORTED
276276

@@ -346,7 +346,7 @@ cond_operands
346346

347347
.. note::
348348

349-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
349+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
350350

351351
Support Level: SUPPORTED
352352

@@ -438,7 +438,7 @@ cond_predicate
438438

439439
.. note::
440440

441-
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`torch.cond <torch.cond>`
441+
Tags: :doc:`torch.cond <torch.cond>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
442442

443443
Support Level: SUPPORTED
444444

0 commit comments

Comments
 (0)