Merge pull request #573 from mit-ll-responsible-ai/more-docs

move scikit and PL how-to -> tutorial
mit-ll-responsible-ai · Nov 8, 2023 · 5e152bf · 5e152bf
2 parents 6b81770 + 8d8ffd1
commit 5e152bf
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@
     Check out our <a href="https://mit-ll-responsible-ai.github.io/hydra-zen/">documentation</a> for more information.
   </p>
   <p align="center">
-    Interested in machine learning? Check out our guide <a href="https://mit-ll-responsible-ai.github.io/hydra-zen/how_to/pytorch_lightning.html">for using PyTorch Lightning with hydra-zen.⚡</a>
+    Interested in machine learning? Check out our guide <a href="https://mit-ll-responsible-ai.github.io/hydra-zen/tutorials/pytorch_lightning.html">for using PyTorch Lightning with hydra-zen.⚡</a>
   </p>
 </p>
 

diff --git a/docs/source/changes.rst b/docs/source/changes.rst
@@ -236,7 +236,7 @@ The following How-To guides were added:
 
 - `How to configure multiple experiments <https://mit-ll-responsible-ai.github.io/hydra-zen/how_to/configuring_experiments.html>`_
 - `How to customize Hydra's configuration <https://mit-ll-responsible-ai.github.io/hydra-zen/how_to/configure_hydra.html>`_
-- `How to configure and run scikit-learn's "Classier Comparison" example <https://mit-ll-responsible-ai.github.io/hydra-zen/how_to/using_scikit_learn.html>`_
+- `How to configure and run scikit-learn's "Classier Comparison" example <https://mit-ll-responsible-ai.github.io/hydra-zen/tutorials/using_scikit_learn.html>`_
 
 
 

diff --git a/docs/source/how_tos.rst b/docs/source/how_tos.rst
@@ -27,5 +27,3 @@ objectives.
    how_to/configure_hydra
    how_to/partial_config
    how_to/beartype
-   how_to/using_scikit_learn
-   how_to/pytorch_lightning
diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst
@@ -28,6 +28,8 @@ application that is configurable, reproducible, and scalable.
    tutorials/hierarchy
    tutorials/config_groups
    tutorials/inject_wrapper
+   tutorials/using_scikit_learn
+   tutorials/pytorch_lightning
 
 
 .. tip::

diff --git a/docs/source/how_to/pytorch_lightning.rst → docs/source/tutorials/pytorch_lightning.rst b/docs/source/how_to/pytorch_lightning.rst → docs/source/tutorials/pytorch_lightning.rst
@@ -7,7 +7,7 @@
 
    Your must install `PyTorch <https://pytorch.org/>`_ and `PyTorch Lightning <https://
    www.pytorchlightning.ai/>`_ in your Python environment in order to follow this 
-   How-To guide.
+   tutorial.
 
 .. tip::
 
@@ -26,7 +26,7 @@ single-layer neural networks without any boilerplate code**. For the sake of
 simplicity, we will train it to simply fit :math:`\cos{x}` on 
 :math:`x \in [-2\pi, 2\pi]`.
 
-In this "How-To" we will do the following:
+In this tutorial we will do the following:
 
 1. Define a simple neural network and `lightning module <https://pytorch-lightning.readthedocs.io/en/latest/common/lightning_module.html>`_.
 2. Create configs for our lighting module, data loader, optimizer, and trainer.

diff --git a/docs/source/how_to/scikit_learn.png → docs/source/tutorials/scikit_learn.png b/docs/source/how_to/scikit_learn.png → docs/source/tutorials/scikit_learn.png
diff --git a/docs/source/how_to/using_scikit_learn.rst → docs/source/tutorials/using_scikit_learn.rst b/docs/source/how_to/using_scikit_learn.rst → docs/source/tutorials/using_scikit_learn.rst
@@ -8,12 +8,12 @@ Configure and Run scikit-learn's Classifier Comparison Example
 
 .. admonition:: Note
 
-   This How-To guide closely mirrors scikit-learn's `Classifier Comparison <https://scikit-learn.org/stable/auto_examples/classification/plot_classifier_comparison.html#sphx-glr-auto-examples-classification-plot-classifier-comparison-py>`_  example.
+   This tutorial section closely mirrors scikit-learn's `Classifier Comparison <https://scikit-learn.org/stable/auto_examples/classification/plot_classifier_comparison.html#sphx-glr-auto-examples-classification-plot-classifier-comparison-py>`_  example.
 
-This guide will demonstrate how to hydra-zen with `scikit-learn <https://scikit-learn.org/stable/index.html>`_ to configure and run reproducible experiments.
-Specifically, we will demonstrate how to configure multiple scikit-learn datasets and classifiers, and how to launch multiple classifer-fitting experiments using Hydra's CLI.
+This tutorial will use hydra-zen with `scikit-learn <https://scikit-learn.org/stable/index.html>`_ to configure and run reproducible experiments.
+Specifically, we will demonstrate how to configure multiple scikit-learn datasets and classifiers, and how to launch multiple classifier-fitting experiments using Hydra's CLI.
 
-This How-To consists of the following steps:
+This tutorial consists of the following steps:
 
 1. Configure multiple scikit-learn datasets and classifiers.
 2. Create a task function to load data, fit a classifier, and visualize the fit.