Skip to content

Commit 0a59bea

Browse files
authored
[docs] Use autodoc2 and remove automodule (NVIDIA#2542)
1 parent 1c6f6eb commit 0a59bea

19 files changed

+21
-603
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ runs/
1818
**/dist/
1919

2020
# Sphinx documentation
21-
docs/_build
21+
docs/_build
22+
docs/apidocs

docs/api-guide/datasets.md

Lines changed: 0 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -3,101 +3,3 @@
33
```{include} datasets_readme.md
44
```
55

6-
## Submodules
7-
8-
### datasets.blended_megatron_dataset_config module
9-
10-
```{automodule} core.datasets.blended_megatron_dataset_config
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
14-
```
15-
16-
### datasets.blended_megatron_dataset_builder module
17-
18-
```{automodule} core.datasets.blended_megatron_dataset_builder
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
```
23-
24-
### datasets.megatron_tokenizer module
25-
26-
```{automodule} core.datasets.megatron_tokenizer
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
```
31-
32-
### datasets.indexed_dataset module
33-
34-
```{automodule} core.datasets.indexed_dataset
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
38-
```
39-
40-
### datasets.megatron_dataset module
41-
42-
```{automodule} core.datasets.megatron_dataset
43-
:members:
44-
:undoc-members:
45-
:show-inheritance:
46-
```
47-
48-
### datasets.gpt_dataset module
49-
50-
```{automodule} core.datasets.gpt_dataset
51-
:members:
52-
:undoc-members:
53-
:show-inheritance:
54-
```
55-
56-
### datasets.masked_dataset module
57-
58-
```{automodule} core.datasets.masked_dataset
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:
62-
```
63-
64-
### datasets.bert_dataset module
65-
66-
```{automodule} core.datasets.bert_dataset
67-
:members:
68-
:undoc-members:
69-
:show-inheritance:
70-
```
71-
72-
### datasets.t5_dataset module
73-
74-
```{automodule} core.datasets.t5_dataset
75-
:members:
76-
:undoc-members:
77-
:show-inheritance:
78-
```
79-
80-
### datasets.blended_dataset module
81-
82-
```{automodule} core.datasets.blended_dataset
83-
:members:
84-
:undoc-members:
85-
:show-inheritance:
86-
```
87-
88-
### datasets.utils module
89-
90-
```{automodule} core.datasets.utils
91-
:members:
92-
:undoc-members:
93-
:show-inheritance:
94-
```
95-
96-
## Module contents
97-
98-
```{automodule} core.datasets
99-
:members:
100-
:undoc-members:
101-
:show-inheritance:
102-
```
103-

docs/api-guide/dist_checkpointing.md

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -80,61 +80,3 @@ You can combine formats to optimize both flexibility and performance:
8080
dist_checkpointing.strategies
8181
```
8282

83-
## Submodules
84-
85-
### dist_checkpointing.serialization module
86-
87-
```{automodule} core.dist_checkpointing.serialization
88-
:members:
89-
:undoc-members:
90-
:show-inheritance:
91-
```
92-
93-
### dist_checkpointing.mapping module
94-
95-
```{automodule} core.dist_checkpointing.mapping
96-
:members:
97-
:undoc-members:
98-
:show-inheritance:
99-
```
100-
101-
### dist_checkpointing.optimizer module
102-
103-
```{automodule} core.dist_checkpointing.optimizer
104-
:members:
105-
:undoc-members:
106-
:show-inheritance:
107-
```
108-
109-
### dist_checkpointing.core module
110-
111-
```{automodule} core.dist_checkpointing.core
112-
:members:
113-
:undoc-members:
114-
:show-inheritance:
115-
```
116-
117-
### dist_checkpointing.dict_utils module
118-
119-
```{automodule} core.dist_checkpointing.dict_utils
120-
:members:
121-
:undoc-members:
122-
:show-inheritance:
123-
```
124-
125-
### dist_checkpointing.utils module
126-
127-
```{automodule} core.dist_checkpointing.utils
128-
:members:
129-
:undoc-members:
130-
:show-inheritance:
131-
```
132-
133-
## Module contents
134-
135-
```{automodule} core.dist_checkpointing
136-
:members:
137-
:undoc-members:
138-
:show-inheritance:
139-
```
140-

docs/api-guide/dist_checkpointing.strategies.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,3 @@ Package defining different checkpoint formats (backends) and saving/loading algo
55
Strategies can be used for implementing new checkpoint formats or implementing new (more optimal for a given use case) ways of saving/loading of existing formats.
66
Strategies are passed to `dist_checkpointing.load` and `dist_checkpointing.save` functions and control the actual saving/loading procedure.
77

8-
## Submodules
9-
10-
### dist_checkpointing.strategies.base module
11-
12-
```{automodule} core.dist_checkpointing.strategies.base
13-
:members:
14-
:undoc-members:
15-
:show-inheritance:
16-
```
17-
18-
### dist_checkpointing.strategies.tensorstore module
19-
20-
```{automodule} core.dist_checkpointing.strategies.tensorstore
21-
:members:
22-
:undoc-members:
23-
:show-inheritance:
24-
```
25-
26-
### dist_checkpointing.strategies.two_stage module
27-
28-
```{automodule} core.dist_checkpointing.strategies.two_stage
29-
:members:
30-
:undoc-members:
31-
:show-inheritance:
32-
```
33-
34-
## Module contents
35-
36-
```{automodule} core.dist_checkpointing.strategies
37-
:members:
38-
:undoc-members:
39-
:show-inheritance:
40-
```
41-

docs/api-guide/distributed.md

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,44 +8,3 @@ synchronize gradients across different parallelism modes (e.g., 'tied'
88
layers on different pipeline stages, or gradients for experts in a MoE on
99
different ranks due to expert parallelism).
1010

11-
## Submodules
12-
13-
### distributed.distributed_data_parallel
14-
15-
Model wrapper for distributed data parallelism. Stores gradients in a
16-
contiguous buffer, and supports the option of overlapping communication
17-
(all-reduce or reduce-scatter) with backprop computation by breaking up
18-
full model's gradients into smaller buckets and running all-reduce /
19-
reduce-scatter on each bucket asynchronously.
20-
21-
```{automodule} core.distributed.distributed_data_parallel
22-
:members:
23-
:undoc-members:
24-
:show-inheritance:
25-
```
26-
27-
### distributed.finalize_model_grads
28-
29-
Finalize model gradients for optimizer step across all used parallelism modes.
30-
Synchronizes the all-reduce / reduce-scatter of model gradients across DP replicas,
31-
all-reduces the layernorm gradients for sequence parallelism, embedding gradients
32-
across first and last pipeline stages (if not tied), and expert gradients for expert
33-
parallelism.
34-
35-
```{automodule} core.distributed.finalize_model_grads
36-
:members:
37-
:undoc-members:
38-
:show-inheritance:
39-
```
40-
41-
## Module contents
42-
43-
Contains functionality to synchronize gradients across different ranks before
44-
optimizer step.
45-
46-
```{automodule} core.distributed
47-
:members:
48-
:undoc-members:
49-
:show-inheritance:
50-
```
51-

docs/api-guide/fusions.md

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -9,55 +9,3 @@ functionality for doing just-in-time compilation
99
in recent versions), or call into custom kernels in external libraries
1010
such as Apex or TransformerEngine.
1111

12-
## Submodules
13-
14-
### fusions.fused_bias_dropout module
15-
16-
This module uses PyTorch JIT to fuse the bias add and dropout operations. Since dropout is not used during inference, different functions are used when in train mode and when in inference mode.
17-
18-
```{automodule} core.fusions.fused_bias_dropout
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
```
23-
24-
### fusions.fused_bias_gelu module
25-
26-
This module uses PyTorch JIT to fuse the bias add and GeLU nonlinearity operations.
27-
28-
```{automodule} core.fusions.fused_bias_gelu
29-
:members:
30-
:undoc-members:
31-
:show-inheritance:
32-
```
33-
34-
### fusions.fused_layer_norm module
35-
36-
This module provides a wrapper around various fused LayerNorm implementation in Apex.
37-
38-
```{automodule} core.fusions.fused_layer_norm
39-
:members:
40-
:undoc-members:
41-
:show-inheritance:
42-
```
43-
44-
### fusions.fused_softmax module
45-
46-
This module provides wrappers around variations of Softmax in Apex.
47-
48-
```{automodule} core.fusions.fused_softmax
49-
:members:
50-
:undoc-members:
51-
:show-inheritance:
52-
```
53-
54-
### fusions.fused_cross_entropy_loss module
55-
56-
This module uses PyTorch JIT to fuse the cross entropy loss calculation and batches communication calls.
57-
58-
```{automodule} core.fusions.fused_cross_entropy
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:
62-
```
63-

docs/api-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# API Guide
22

33
```{toctree}
4-
:maxdepth: 4
4+
:maxdepth: 2
55
66
models
77
tensor_parallel

docs/api-guide/models.bert.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,3 @@
22

33
Useful package for training bert and bert like encoder only models. It optionally comes with a binary head that can be used for classification tasks .
44

5-
## Submodules
6-
7-
### models.bert.bert_model module
8-
9-
```{automodule} core.models.bert.bert_model
10-
:members:
11-
:undoc-members:
12-
:show-inheritance:
13-
```
14-
15-
## Module contents
16-
17-
```{automodule} core.models.bert
18-
:members:
19-
:undoc-members:
20-
:show-inheritance:
21-
```
22-

docs/api-guide/models.gpt.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,3 @@
22

33
This is the implementation of the popular GPT model. It supports several features like model parallelization (Tensor Parallel, Pipeline Parallel, Data Parallel) , mixture of experts, FP8 , Distributed optimizer etc. We are constantly adding new features. So be on the lookout or raise an issue if you want to have something added.
44

5-
## Submodules
6-
7-
### models.gpt.gpt_model module
8-
9-
```{automodule} core.models.gpt.gpt_model
10-
:members:
11-
:undoc-members:
12-
:show-inheritance:
13-
```
14-
15-
## Module contents
16-
17-
```{automodule} core.models.gpt
18-
:members:
19-
:undoc-members:
20-
:show-inheritance:
21-
```
22-

docs/api-guide/models.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,3 @@ models.t5
1212
models.bert
1313
```
1414

15-
## Module contents
16-
17-
```{automodule} core.models
18-
:members:
19-
:undoc-members:
20-
:show-inheritance:
21-
```
22-

0 commit comments

Comments
 (0)