Docs changes

This commit is contained in:
Alec Helbling
2023-04-07 00:20:54 -04:00
parent 39fa15e22e
commit 2a50124ae2
21 changed files with 18 additions and 13 deletions

View File

@ -1,5 +1,4 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.

BIN
docs/build/.DS_Store vendored

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

0
docs/build/html/.nojekyll vendored Normal file
View File

View File

@ -26,12 +26,12 @@ The topics of other tutorials will include:
2. Creating custom animations of neural networks
=========================================
Visualizing a Feed Forward Neural Network
Visualizing a Feed Forward Neural Network Test
=========================================
.. manim:: FeedForwardNetworkScene
:save_last_frame:
class FeedForwardNetworkScene(Scene):
def construct(self):

File diff suppressed because one or more lines are too long

View File

@ -216,8 +216,8 @@ This tutorial goes over several simple topics:</p>
<li><p>Creating custom neural network layers</p></li>
<li><p>Creating custom animations of neural networks</p></li>
</ol>
<section id="visualizing-a-feed-forward-neural-network">
<h2>Visualizing a Feed Forward Neural Network<a class="headerlink" href="#visualizing-a-feed-forward-neural-network" title="Permalink to this heading">#</a></h2>
<section id="visualizing-a-feed-forward-neural-network-test">
<h2>Visualizing a Feed Forward Neural Network Test<a class="headerlink" href="#visualizing-a-feed-forward-neural-network-test" title="Permalink to this heading">#</a></h2>
<div id="feedforwardnetworkscene" class="admonition admonition-manim-example">
<p class="admonition-title">Example: FeedForwardNetworkScene <a class="headerlink" href="#feedforwardnetworkscene"></a></p><img alt="_images/FeedForwardNetworkScene-1.png" class="align-center" src="_images/FeedForwardNetworkScene-1.png" />
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">manim</span> <span class="kn">import</span> <span class="o">*</span>
@ -278,7 +278,7 @@ This tutorial goes over several simple topics:</p>
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Visualizing Neural Networks with ManimML</a><ul>
<li><a class="reference internal" href="#visualizing-a-feed-forward-neural-network">Visualizing a Feed Forward Neural Network</a></li>
<li><a class="reference internal" href="#visualizing-a-feed-forward-neural-network-test">Visualizing a Feed Forward Neural Network Test</a></li>
</ul>
</li>
</ul>

View File

@ -13,7 +13,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath("../../manim_ml"))
# sys.path.insert(0, os.path.abspath("../../manim_ml"))
# -- Project information -----------------------------------------------------
@ -28,7 +28,11 @@ author = "Alec Helbling"
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"manim.utils.docbuild.manim_directive",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

View File

@ -26,16 +26,18 @@ The topics of other tutorials will include:
2. Creating custom animations of neural networks
=========================================
Visualizing a Feed Forward Neural Network
Visualizing a Feed Forward Neural Network Test
=========================================
.. manim:: FeedForwardNetworkScene
from manim_ml.neural_network.neural_network import NeuralNetwork
from manim_ml.neural_network.layers import FeedForwardLayer
:save_last_frame:
class FeedForwardNetworkScene(Scene):
def construct(self):
from manim_ml.neural_network import NeuralNetwork
from manim_ml.neural_network.layers import FeedForwardLayer
neural_network = NeuralNetwork([
FeedForwardLayer(3),
FeedForwardLayer(5),