Skip to content

Commit d41f62b

Browse files
abhinav-TBsvekars
authored andcommitted
Fixes pytorch#155027 Converted RST files to Markdown Pull Request resolved: pytorch#155252 Approved by: https://github.com/svekars Co-authored-by: Svetlana Karslioglu <[email protected]>
1 parent 3d82a1d commit d41f62b

File tree

5 files changed

+322
-269
lines changed

5 files changed

+322
-269
lines changed

docs/source/mps.rst renamed to docs/source/mps.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
torch.mps
2-
===================================
1+
# torch.mps
2+
3+
```{eval-rst}
34
.. automodule:: torch.mps
5+
```
6+
7+
```{eval-rst}
48
.. currentmodule:: torch.mps
9+
```
510

11+
```{eval-rst}
612
.. autosummary::
713
:toctree: generated
814
:nosignatures:
@@ -19,9 +25,11 @@ torch.mps
1925
driver_allocated_memory
2026
recommended_max_memory
2127
compile_shader
28+
```
2229

23-
MPS Profiler
24-
------------
30+
## MPS Profiler
31+
32+
```{eval-rst}
2533
.. autosummary::
2634
:toctree: generated
2735
:nosignatures:
@@ -33,17 +41,27 @@ MPS Profiler
3341
profiler.is_capturing_metal
3442
profiler.is_metal_capture_enabled
3543
profiler.metal_capture
44+
```
45+
46+
## MPS Event
3647

37-
MPS Event
38-
------------
48+
```{eval-rst}
3949
.. autosummary::
4050
:toctree: generated
4151
:nosignatures:
4252
4353
event.Event
4454
55+
```
4556

46-
.. This module needs to be documented. Adding here in the meantime
47-
.. for tracking purposes
57+
% This module needs to be documented. Adding here in the meantime
58+
59+
% for tracking purposes
60+
61+
```{eval-rst}
4862
.. py:module:: torch.mps.event
63+
```
64+
65+
```{eval-rst}
4966
.. py:module:: torch.mps.profiler
67+
```

docs/source/mtia.rst renamed to docs/source/mtia.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
torch.mtia
2-
===================================
1+
# torch.mtia
32

43
The MTIA backend is implemented out of the tree, only interfaces are be defined here.
54

5+
```{eval-rst}
66
.. automodule:: torch.mtia
7+
```
8+
9+
```{eval-rst}
710
.. currentmodule:: torch.mtia
11+
```
812

13+
```{eval-rst}
914
.. autosummary::
1015
:toctree: generated
1116
:nosignatures:
@@ -32,12 +37,15 @@ The MTIA backend is implemented out of the tree, only interfaces are be defined
3237
set_rng_state
3338
get_rng_state
3439
DeferredMtiaCallError
40+
```
41+
42+
## Streams and events
3543

36-
Streams and events
37-
------------------
44+
```{eval-rst}
3845
.. autosummary::
3946
:toctree: generated
4047
:nosignatures:
4148
4249
Event
4350
Stream
51+
```
Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1-
torch.mtia.memory
2-
===================================
1+
# torch.mtia.memory
32

43
The MTIA backend is implemented out of the tree, only interfaces are be defined here.
54

5+
```{eval-rst}
66
.. automodule:: torch.mtia.memory
7+
```
8+
9+
```{eval-rst}
710
.. currentmodule:: torch.mtia.memory
11+
```
812

13+
```{eval-rst}
914
.. autosummary::
1015
:toctree: generated
1116
:nosignatures:
1217
1318
memory_stats
19+
```

0 commit comments

Comments
 (0)