Skip to content

Commit 94b402b

Browse files
committed
Generate Python docs from pytorch/pytorch@2a397d3
1 parent c0017c0 commit 94b402b

File tree

2,925 files changed

+747522
-14185
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,925 files changed

+747522
-14185
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: 2f4e5cf59b8c570e3613bf46cd93154c
3+
config: 87aef9cc55b950f9db1a66b7ef79d6e9
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

main/_images/RReLU.png

-292 Bytes
Loading

main/_images/ReduceLROnPlateau.png

50 Bytes
Loading

main/_sources/fx.experimental.md.txt

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,68 @@ These APIs are experimental and subject to change without notice.
164164
snapshot_fake
165165
```
166166

167+
## torch.fx.experimental.optimization
168+
169+
```{eval-rst}
170+
.. currentmodule:: torch.fx.experimental.optimization
171+
```
172+
173+
```{eval-rst}
174+
.. automodule:: torch.fx.experimental.optimization
175+
```
176+
177+
```{eval-rst}
178+
.. autosummary::
179+
:toctree: generated
180+
:nosignatures:
181+
182+
extract_subgraph
183+
modules_to_mkldnn
184+
optimize_for_inference
185+
remove_dropout
186+
replace_node_module
187+
reset_modules
188+
use_mkl_length
189+
```
190+
191+
## torch.fx.experimental.recording
192+
193+
```{eval-rst}
194+
.. currentmodule:: torch.fx.experimental.recording
195+
```
196+
197+
```{eval-rst}
198+
.. automodule:: torch.fx.experimental.recording
199+
```
200+
201+
```{eval-rst}
202+
.. autosummary::
203+
:toctree: generated
204+
:nosignatures:
205+
206+
record_shapeenv_event
207+
replay_shape_env_events
208+
shape_env_check_state_equal
209+
```
210+
211+
## torch.fx.experimental.unification.core
212+
213+
```{eval-rst}
214+
.. currentmodule:: torch.fx.experimental.unification.core
215+
```
216+
217+
```{eval-rst}
218+
.. automodule:: torch.fx.experimental.unification.core
219+
```
220+
221+
```{eval-rst}
222+
.. autosummary::
223+
:toctree: generated
224+
:nosignatures:
225+
226+
reify
227+
```
228+
167229
## torch.fx.experimental.unification.unification_tools
168230

169231
```{eval-rst}
@@ -215,4 +277,151 @@ These APIs are experimental and subject to change without notice.
215277
transform_dimension
216278
transform_to_z3
217279
transform_var
280+
evaluate_conditional_with_constraints
281+
```
282+
283+
## torch.fx.experimental.migrate_gradual_types.constraint
284+
285+
```{eval-rst}
286+
.. currentmodule:: torch.fx.experimental.migrate_gradual_types.constraint
287+
```
288+
289+
```{eval-rst}
290+
.. automodule:: torch.fx.experimental.migrate_gradual_types.constraint
291+
```
292+
293+
```{eval-rst}
294+
.. autosummary::
295+
:toctree: generated
296+
:nosignatures:
297+
298+
is_algebraic_expression
299+
is_bool_expr
300+
is_dim
301+
```
302+
303+
## torch.fx.experimental.migrate_gradual_types.constraint_generator
304+
305+
```{eval-rst}
306+
.. currentmodule:: torch.fx.experimental.migrate_gradual_types.constraint_generator
307+
```
308+
309+
```{eval-rst}
310+
.. automodule:: torch.fx.experimental.migrate_gradual_types.constraint_generator
311+
```
312+
313+
```{eval-rst}
314+
.. autosummary::
315+
:toctree: generated
316+
:nosignatures:
317+
318+
adaptive_inference_rule
319+
assert_inference_rule
320+
batchnorm_inference_rule
321+
bmm_inference_rule
322+
embedding_inference_rule
323+
embedding_inference_rule_functional
324+
eq_inference_rule
325+
equality_inference_rule
326+
expand_inference_rule
327+
full_inference_rule
328+
gt_inference_rule
329+
lt_inference_rule
330+
masked_fill_inference_rule
331+
neq_inference_rule
332+
tensor_inference_rule
333+
torch_dim_inference_rule
334+
torch_linear_inference_rule
335+
type_inference_rule
336+
view_inference_rule
337+
register_inference_rule
338+
transpose_inference_rule
339+
```
340+
341+
## torch.fx.experimental.migrate_gradual_types.constraint_transformation
342+
343+
```{eval-rst}
344+
.. currentmodule:: torch.fx.experimental.migrate_gradual_types.constraint_transformation
345+
```
346+
347+
```{eval-rst}
348+
.. automodule:: torch.fx.experimental.migrate_gradual_types.constraint_transformation
349+
```
350+
351+
```{eval-rst}
352+
.. autosummary::
353+
:toctree: generated
354+
:nosignatures:
355+
356+
apply_padding
357+
calc_last_two_dims
358+
create_equality_constraints_for_broadcasting
359+
is_target_div_by_dim
360+
no_broadcast_dim_with_index
361+
register_transformation_rule
362+
transform_constraint
363+
transform_get_item
364+
transform_get_item_tensor
365+
transform_index_select
366+
transform_transpose
367+
valid_index
368+
valid_index_tensor
369+
is_dim_div_by_target
370+
```
371+
372+
## torch.fx.experimental.graph_gradual_typechecker
373+
374+
```{eval-rst}
375+
.. currentmodule:: torch.fx.experimental.graph_gradual_typechecker
376+
```
377+
378+
```{eval-rst}
379+
.. automodule:: torch.fx.experimental.graph_gradual_typechecker
380+
```
381+
382+
```{eval-rst}
383+
.. autosummary::
384+
:toctree: generated
385+
:nosignatures:
386+
387+
adaptiveavgpool2d_check
388+
adaptiveavgpool2d_inference_rule
389+
all_eq
390+
bn2d_inference_rule
391+
calculate_out_dimension
392+
conv_refinement_rule
393+
conv_rule
394+
element_wise_eq
395+
expand_to_tensor_dim
396+
first_two_eq
397+
register_algebraic_expressions_inference_rule
398+
register_inference_rule
399+
register_refinement_rule
400+
transpose_inference_rule
401+
```
402+
403+
## torch.fx.experimental.meta_tracer
404+
405+
```{eval-rst}
406+
.. currentmodule:: torch.fx.experimental.meta_tracer
407+
```
408+
409+
```{eval-rst}
410+
.. automodule:: torch.fx.experimental.meta_tracer
411+
```
412+
413+
```{eval-rst}
414+
.. autosummary::
415+
:toctree: generated
416+
:nosignatures:
417+
418+
embedding_override
419+
functional_relu_override
420+
nn_layernorm_override
421+
proxys_to_metas
422+
symbolic_trace
423+
torch_abs_override
424+
torch_nn_relu_override
425+
torch_relu_override
426+
torch_where_override
218427
```

main/_sources/fx.md.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1121,23 +1121,15 @@ The set of leaf modules can be customized by overriding
11211121
.. py:module:: torch.fx.experimental.accelerator_partitioner
11221122
.. py:module:: torch.fx.experimental.const_fold
11231123
.. py:module:: torch.fx.experimental.debug
1124-
.. py:module:: torch.fx.experimental.graph_gradual_typechecker
11251124
.. py:module:: torch.fx.experimental.merge_matmul
1126-
.. py:module:: torch.fx.experimental.meta_tracer
1127-
.. py:module:: torch.fx.experimental.migrate_gradual_types.constraint
1128-
.. py:module:: torch.fx.experimental.migrate_gradual_types.constraint_generator
1129-
.. py:module:: torch.fx.experimental.migrate_gradual_types.constraint_transformation
11301125
.. py:module:: torch.fx.experimental.migrate_gradual_types.operation
11311126
.. py:module:: torch.fx.experimental.migrate_gradual_types.util
11321127
.. py:module:: torch.fx.experimental.migrate_gradual_types.z3_types
11331128
.. py:module:: torch.fx.experimental.normalize
1134-
.. py:module:: torch.fx.experimental.optimization
11351129
.. py:module:: torch.fx.experimental.partitioner_utils
1136-
.. py:module:: torch.fx.experimental.recording
11371130
.. py:module:: torch.fx.experimental.refinement_types
11381131
.. py:module:: torch.fx.experimental.rewriter
11391132
.. py:module:: torch.fx.experimental.schema_type_annotation
1140-
.. py:module:: torch.fx.experimental.unification.core
11411133
.. py:module:: torch.fx.experimental.unification.dispatch
11421134
.. py:module:: torch.fx.experimental.unification.match
11431135
.. py:module:: torch.fx.experimental.unification.more

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,7 +1099,7 @@ dynamic_shape_if_guard
10991099

11001100
.. note::
11011101

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

11041104
Support Level: SUPPORTED
11051105

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

11571157
.. note::
11581158

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

11611161
Support Level: SUPPORTED
11621162

@@ -1416,7 +1416,7 @@ list_contains
14161416

14171417
.. note::
14181418

1419-
Tags: :doc:`python.data-structure <python.data-structure>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.assert <python.assert>`
1419+
Tags: :doc:`python.assert <python.assert>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.data-structure <python.data-structure>`
14201420

14211421
Support Level: SUPPORTED
14221422

@@ -2277,7 +2277,7 @@ dynamic_shape_round
22772277

22782278
.. note::
22792279

2280-
Tags: :doc:`python.builtin <python.builtin>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
2280+
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.builtin <python.builtin>`
22812281

22822282
Support Level: NOT_SUPPORTED_YET
22832283

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ list_contains
6060

6161
.. note::
6262

63-
Tags: :doc:`python.data-structure <python.data-structure>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.assert <python.assert>`
63+
Tags: :doc:`python.assert <python.assert>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.data-structure <python.data-structure>`
6464

6565
Support Level: SUPPORTED
6666

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

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

66
.. note::
77

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

1010
Support Level: NOT_SUPPORTED_YET
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:`python.control-flow <python.control-flow>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`
8+
Tags: :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.control-flow <python.control-flow>`
99

1010
Support Level: SUPPORTED
1111

main/_sources/generated/exportdb/python.data-structure.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ list_contains
147147

148148
.. note::
149149

150-
Tags: :doc:`python.data-structure <python.data-structure>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.assert <python.assert>`
150+
Tags: :doc:`python.assert <python.assert>`, :doc:`torch.dynamic-shape <torch.dynamic-shape>`, :doc:`python.data-structure <python.data-structure>`
151151

152152
Support Level: SUPPORTED
153153

0 commit comments

Comments
 (0)