Skip to content

Commit

Permalink
Expand the use cases, move them up for discoverability (#8692)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Naren committed Aug 3, 2021
1 parent 08ac079 commit a1be621
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/source/_templates/layout.html
Expand Up @@ -4,7 +4,7 @@
{% block footer %}
{{ super() }}
<script script type="text/javascript">
var collapsedSections = ['Best practices', 'Lightning API', 'Optional extensions', 'Tutorials', 'API References', 'Bolts', 'Examples', 'Common Use Cases', 'Partner Domain Frameworks', 'Community'];
var collapsedSections = ['Best practices', 'Lightning API', 'Optional extensions', 'Tutorials', 'API References', 'Bolts', 'Examples', 'Partner Domain Frameworks', 'Community'];
</script>

{% endblock %}
58 changes: 29 additions & 29 deletions docs/source/index.rst
Expand Up @@ -36,6 +36,35 @@ PyTorch Lightning Documentation
common/lightning_module
common/trainer

.. toctree::
:maxdepth: 1
:name: Common Use Cases
:caption: Common Use Cases

clouds/cloud_training
clouds/cluster
common/child_modules
common/debugging
common/early_stopping
common/hyperparameters
common/production_inference
advanced/ipu
common/lightning_cli
advanced/lr_finder
common/loggers
advanced/multi_gpu
advanced/advanced_gpu
common/weights_loading
common/optimizers
advanced/profiler
advanced/sequences
common/single_gpu
advanced/training_tricks
advanced/pruning_quantization
advanced/transfer_learning
advanced/tpu
common/test_set

.. toctree::
:maxdepth: 2
:name: docs
Expand Down Expand Up @@ -96,35 +125,6 @@ PyTorch Lightning Documentation
SimCLR <https://lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#simclr>
VAE <https://lightning-bolts.readthedocs.io/en/latest/autoencoders.html#basic-vae>

.. toctree::
:maxdepth: 1
:name: Common Use Cases
:caption: Common Use Cases

clouds/cloud_training
clouds/cluster
common/child_modules
common/debugging
common/early_stopping
common/hyperparameters
common/production_inference
advanced/ipu
common/lightning_cli
advanced/lr_finder
common/loggers
advanced/multi_gpu
advanced/advanced_gpu
common/weights_loading
common/optimizers
advanced/profiler
advanced/sequences
common/single_gpu
advanced/training_tricks
advanced/pruning_quantization
advanced/transfer_learning
advanced/tpu
common/test_set

.. toctree::
:maxdepth: 1
:name: Partner Domain Frameworks
Expand Down

0 comments on commit a1be621

Please sign in to comment.