Skip to content

Commit a1be621

Browse files
author
Sean Naren
authored
Expand the use cases, move them up for discoverability (#8692)
1 parent 08ac079 commit a1be621

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

docs/source/_templates/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
{% block footer %}
55
{{ super() }}
66
<script script type="text/javascript">
7-
var collapsedSections = ['Best practices', 'Lightning API', 'Optional extensions', 'Tutorials', 'API References', 'Bolts', 'Examples', 'Common Use Cases', 'Partner Domain Frameworks', 'Community'];
7+
var collapsedSections = ['Best practices', 'Lightning API', 'Optional extensions', 'Tutorials', 'API References', 'Bolts', 'Examples', 'Partner Domain Frameworks', 'Community'];
88
</script>
99

1010
{% endblock %}

docs/source/index.rst

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,35 @@ PyTorch Lightning Documentation
3636
common/lightning_module
3737
common/trainer
3838

39+
.. toctree::
40+
:maxdepth: 1
41+
:name: Common Use Cases
42+
:caption: Common Use Cases
43+
44+
clouds/cloud_training
45+
clouds/cluster
46+
common/child_modules
47+
common/debugging
48+
common/early_stopping
49+
common/hyperparameters
50+
common/production_inference
51+
advanced/ipu
52+
common/lightning_cli
53+
advanced/lr_finder
54+
common/loggers
55+
advanced/multi_gpu
56+
advanced/advanced_gpu
57+
common/weights_loading
58+
common/optimizers
59+
advanced/profiler
60+
advanced/sequences
61+
common/single_gpu
62+
advanced/training_tricks
63+
advanced/pruning_quantization
64+
advanced/transfer_learning
65+
advanced/tpu
66+
common/test_set
67+
3968
.. toctree::
4069
:maxdepth: 2
4170
:name: docs
@@ -96,35 +125,6 @@ PyTorch Lightning Documentation
96125
SimCLR <https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#simclr>
97126
VAE <https://lightning-bolts.readthedocs.io/en/latest/autoencoders.html#basic-vae>
98127

99-
.. toctree::
100-
:maxdepth: 1
101-
:name: Common Use Cases
102-
:caption: Common Use Cases
103-
104-
clouds/cloud_training
105-
clouds/cluster
106-
common/child_modules
107-
common/debugging
108-
common/early_stopping
109-
common/hyperparameters
110-
common/production_inference
111-
advanced/ipu
112-
common/lightning_cli
113-
advanced/lr_finder
114-
common/loggers
115-
advanced/multi_gpu
116-
advanced/advanced_gpu
117-
common/weights_loading
118-
common/optimizers
119-
advanced/profiler
120-
advanced/sequences
121-
common/single_gpu
122-
advanced/training_tricks
123-
advanced/pruning_quantization
124-
advanced/transfer_learning
125-
advanced/tpu
126-
common/test_set
127-
128128
.. toctree::
129129
:maxdepth: 1
130130
:name: Partner Domain Frameworks

0 commit comments

Comments
 (0)