How-to for Rules, Composites and Canonizers

- how-to file for composites and canonizers now include rules - move the how-to file to reflect the change - updated reference in how-to/index.rst and getting-started.rst - updated docstring typo in types.py
chr5tphr · Dec 15, 2021 · 37f30ec · 37f30ec
1 parent 6251a9e
commit 37f30ec
Show file tree

Hide file tree

Showing 5 changed files with 422 additions and 10 deletions.
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
@@ -83,11 +83,11 @@ The following computes LRP relevance using the ``EpsilonPlusFlat`` composite:
 
 The context created by :py:func:`zennit.core.Composite.context` registers the
 composite, which means that all rules are applied according to the composite's
-mapping. See :doc:`/how-to/use-composites-and-canonizers` for information on
+mapping. See :doc:`/how-to/use-rules-composites-and-canonizers` for information on
 using composites, :py:mod:`zennit.composites` for an API reference and
 :doc:`/how-to/write-custom-compositors` for writing new compositors. Available
-``Rules`` can be found in :py:func:`zennit.rules`, their use is described in
-:doc:`/how-to/write-custom-rules` and how to add new ones is described in
+``Rules`` can be found in :py:mod:`zennit.rules`, their use is described in
+:doc:`/how-to/use-rules-composites-and-canonizers` and how to add new ones is described in
 :doc:`/how-to/write-custom-rules`.
 
 Attributors
@@ -165,7 +165,7 @@ which may be used when ``BatchNorm`` is used in sequential models. Note that for
 ``SequentialMergeBatchNorm`` to work, all functions (linear layers, activations,
 ...) must be modules and assigned to their parent module in the order they are
 visited (see :py:class:`zennit.canonizers.SequentialMergeBatchNorm`). For more
-information on canonizers see :doc:`/how-to/use-composites-and-canonizers` and
+information on canonizers see :doc:`/how-to/use-rules-composites-and-canonizers` and
 :doc:`/how-to/write-custom-canonizers`.
 
 

diff --git a/docs/source/how-to/index.rst b/docs/source/how-to/index.rst
@@ -8,7 +8,7 @@ These How-Tos give more detailed information on how to use Zennit.
 .. toctree::
     :maxdepth: 1
 
-    use-composites-and-canonizers
+    use-rules-composites-and-canonizers
     use-attributors
     visualize-results
     write-custom-compositors

diff --git a/docs/source/how-to/use-composites-and-canonizers.rst b/docs/source/how-to/use-composites-and-canonizers.rst