Docs changes

This commit is contained in:
Alec Helbling
2023-01-31 10:49:35 -05:00
parent e515861b50
commit 60bd02b22f
34 changed files with 1324 additions and 1768 deletions

BIN
docs/.DS_Store vendored Normal file

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.

BIN
docs/build/doctrees/test.doctree vendored Normal file

Binary file not shown.

Binary file not shown.

View File

@ -0,0 +1,7 @@
Getting Started
===============
This tutorial shows you how to install ManimML and generate
your first machine learning animation.
Adding to

View File

@ -3,15 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ManimML's documentation!
===================================
Welcome to ManimML's documentation! (Testing differences)
=========================================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================

View File

@ -0,0 +1,32 @@
Design Doc: Neural Network Rendering Pipeline
=============================================
=======
Neural Network Layer Scope and Mobject Ownership
=======
An important consideration when designing this pipeline
was to figure out a consistent design philosophy answering the
following questions:
1. What content is owned by an individual layer?
2. Does a layer describe an operation, a piece of data, or both?
=======
Constructing More Elaborate Animations
=======
Sometimes we want to construct custom animations that span more
than a single central layer and its two surrounding layers.
One possible solution to this is to allow for the passing
of neural networks into larger neural networks and treating them as layers.
This way a person can make a class that extends NeuralNetwork, which then
can implement its own forward pass animation, and then that neural network
can then be passed into a larger neural network and treated as its own
individual layer.
This may be a good workaround in certain situations, but this does not
solve the problem of allowing for multiple animations that each require
the context of multiple layers.

0
docs/build/html/_sources/test.rst.txt vendored Normal file
View File

View File

@ -0,0 +1,47 @@
Visualizing Neural Networks with ManimML
========================================
This is a tutorial on how to make neural network architecture visualizations
and animate common algorithms like the forward pass of a neural network.
Neural networks are a ubiquitous class of machine learning techniques.
One of the primary usecases for ManimML is for generating animations of neural network architectures.
We have attempted to construct a simple API for defining neural network architectures
that should feel native to anyone who has used popular deep learning libraries like Pytorch, Tensorflow, and Keras.
User's can define a sequence of layers and we prove a system for automatically generating various
animations of concepts like a forward pass. We also allow the user to change the style of rendered
architectures and algorithm animations.
For this tutorial we assume that you have already followed the :doc:`Getting Started <getting_started>` tutorial.
This tutorial goes over several simple topics:
1. Generating a simple feed forward neural network diagram
2. Animating the forward pass of a feed forward neural network
3. Generating a diagram of a convolutional neural network
4. Modifying the default style of a neural network
The topics of other tutorials will include:
1. Creating custom neural network layers
2. Creating custom animations of neural networks
=========================================
Visualizing a Feed Forward Neural Network
=========================================
.. manim:: FeedForwardNetworkScene
from manim_ml.neural_network.neural_network import NeuralNetwork
from manim_ml.neural_network.layers import FeedForwardLayer
class FeedForwardNetworkScene(Scene):
def construct(self):
neural_network = NeuralNetwork([
FeedForwardLayer(3),
FeedForwardLayer(5),
FeedForwardLayer(2),
FeedForwardLayer(4)
])
self.add(neural_network)

View File

@ -186,355 +186,17 @@
<section class="genindex-section">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a></div>
<div class="genindex-jumpbox"><a href="#M"><strong>M</strong></a> | <a href="#O"><strong>O</strong></a></div>
</section>
<section id="A" class="genindex-section">
<h2>A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.add">add() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.add_gaussian_distribution">add_gaussian_distribution() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject.animation_overrides">animation_overrides (manim_ml.image.GrayscaleImageMobject attribute)</a>
<ul>
<li><a href="manim_ml.html#manim_ml.image.LabeledColorImage.animation_overrides">(manim_ml.image.LabeledColorImage attribute)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.animation_overrides">(manim_ml.list_group.ListGroup attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.animation_overrides">(manim_ml.neural_network.layers.convolutional.ConvolutionalLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.animation_overrides">(manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.animation_overrides">(manim_ml.neural_network.layers.embedding.EmbeddingLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.animation_overrides">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.animation_overrides">(manim_ml.neural_network.layers.feed_forward.FeedForwardLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.animation_overrides">(manim_ml.neural_network.layers.image.ImageLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.animation_overrides">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.animation_overrides">(manim_ml.neural_network.layers.paired_query.PairedQueryLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.animation_overrides">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.BlankConnective.animation_overrides">(manim_ml.neural_network.layers.parent_layers.BlankConnective attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.animation_overrides">(manim_ml.neural_network.layers.parent_layers.ConnectiveLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.animation_overrides">(manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.animation_overrides">(manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.animation_overrides">(manim_ml.neural_network.layers.triplet.TripletLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.animation_overrides">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer.animation_overrides">(manim_ml.neural_network.layers.vector.VectorLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork.animation_overrides">(manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork attribute)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.animation_overrides">(manim_ml.neural_network.neural_network.NeuralNetwork attribute)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.animation_overrides">(manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder attribute)</a>
</li>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.animation_overrides">(manim_ml.probability.GaussianDistribution attribute)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="B" class="genindex-section">
<h2>B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.BlankConnective">BlankConnective (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="C" class="genindex-section">
<h2>C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.compute_covariance_rotation_and_scale">compute_covariance_rotation_and_scale() (manim_ml.probability.GaussianDistribution method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer">ConnectiveLayer (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene.construct">construct() (manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.construct_edges">construct_edges() (manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.construct_gaussian_distribution">construct_gaussian_distribution() (manim_ml.probability.GaussianDistribution method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.construct_gaussian_point_cloud">construct_gaussian_point_cloud() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.construct_simple_gaussian_ellipse">construct_simple_gaussian_ellipse() (manim_ml.probability.GaussianDistribution method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer">ConvolutionalLayer (class in manim_ml.neural_network.layers.convolutional)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional">ConvolutionalToConvolutional (class in manim_ml.neural_network.layers.convolutional_to_convolutional)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject.create">create() (manim_ml.image.GrayscaleImageMobject method)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="E" class="genindex-section">
<h2>E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer">EmbeddingLayer (class in manim_ml.neural_network.layers.embedding)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward">EmbeddingToFeedForward (class in manim_ml.neural_network.layers.embedding_to_feed_forward)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="F" class="genindex-section">
<h2>F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer">FeedForwardLayer (class in manim_ml.neural_network.layers.feed_forward)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork">FeedForwardNeuralNetwork (class in manim_ml.neural_network.neural_network)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding">FeedForwardToEmbedding (class in manim_ml.neural_network.layers.feed_forward_to_embedding)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward">FeedForwardToFeedForward (class in manim_ml.neural_network.layers.feed_forward_to_feed_forward)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage">FeedForwardToImage (class in manim_ml.neural_network.layers.feed_forward_to_image)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector">FeedForwardToVector (class in manim_ml.neural_network.layers.feed_forward_to_vector)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject.from_path">from_path() (manim_ml.image.GrayscaleImageMobject class method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.from_path">(manim_ml.neural_network.layers.image.ImageLayer class method)</a>
</li>
</ul></li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.from_paths">from_paths() (manim_ml.neural_network.layers.paired_query.PairedQueryLayer class method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.from_paths">(manim_ml.neural_network.layers.triplet.TripletLayer class method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="G" class="genindex-section">
<h2>G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution">GaussianDistribution (class in manim_ml.probability)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.get">get() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.util.get_connective_layer">get_connective_layer() (in module manim_ml.neural_network.layers.util)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.get_connective_layer_widths">get_connective_layer_widths() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.get_connective_layers">get_connective_layers() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.get_distribution_location">get_distribution_location() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.get_right">get_right() (manim_ml.neural_network.layers.image.ImageLayer method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject">GrayscaleImageMobject (class in manim_ml.image)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="H" class="genindex-section">
<h2>H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.height">height (manim_ml.neural_network.layers.image.ImageLayer property)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="I" class="genindex-section">
<h2>I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer">ImageLayer (class in manim_ml.neural_network.layers.image)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward">ImageToFeedForward (class in manim_ml.neural_network.layers.image_to_feed_forward)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.index_of">index_of() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.input_class">input_class (manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional attribute)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.input_class">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.input_class">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.input_class">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.input_class">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.input_class">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.input_class">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.input_class">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.input_class">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.insert">insert() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.insert_layer">insert_layer() (manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer">InsertLayer (class in manim_ml.neural_network.neural_network_transformations)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="L" class="genindex-section">
<h2>L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.image.LabeledColorImage">LabeledColorImage (class in manim_ml.image)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup">ListGroup (class in manim_ml.list_group)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="M" class="genindex-section">
<h2>M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_assets">make_assets() (manim_ml.neural_network.layers.paired_query.PairedQueryLayer method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.make_assets">(manim_ml.neural_network.layers.triplet.TripletLayer method)</a>
</li>
</ul></li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_connective_layers_animation">make_create_connective_layers_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_layer_animation">make_create_layer_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_filter_corner_lines">make_filter_corner_lines() (manim_ml.neural_network.layers.convolutional.ConvolutionalLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_forward_pass_animation">make_forward_pass_animation() (manim_ml.neural_network.layers.convolutional.ConvolutionalLayer method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_forward_pass_animation">(manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward.FeedForwardLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.image.ImageLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.paired_query.PairedQueryLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.BlankConnective.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.BlankConnective method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.ConnectiveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.triplet.TripletLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.vector.VectorLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.make_forward_pass_animation">(manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
</ul></li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_image_forward_pass">make_image_forward_pass() (manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_lines">make_lines() (manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_move_animation">make_move_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_move_layers_animation">make_move_layers_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_new_connective_animation">make_new_connective_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_animation">make_remove_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_connective_layers_animation">make_remove_connective_layers_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_layer_animation">make_remove_layer_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_triplet_forward_pass">make_triplet_forward_pass() (manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer.make_vector">make_vector() (manim_ml.neural_network.layers.vector.VectorLayer method)</a>
</li>
<li>
manim_ml
<ul>
<li><a href="manim_ml.html#module-manim_ml">module</a>
</li>
</ul></li>
<li>
manim_ml.image
<ul>
<li><a href="manim_ml.html#module-manim_ml.image">module</a>
</li>
</ul></li>
<li>
manim_ml.list_group
<ul>
<li><a href="manim_ml.html#module-manim_ml.list_group">module</a>
</li>
</ul></li>
<li>
@ -542,169 +204,6 @@
<ul>
<li><a href="manim_ml.html#module-manim_ml.manifold">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.convolutional
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.convolutional_to_convolutional
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.embedding
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.embedding_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward_to_embedding
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
manim_ml.neural_network.layers.feed_forward_to_image
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward_to_vector
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.image
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.image_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.paired_query
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.paired_query_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.parent_layers
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.triplet
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.triplet_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.util
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.vector
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.neural_network
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.neural_network_transformations
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.variational_autoencoder
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">module</a>
</li>
</ul></li>
<li>
@ -714,221 +213,28 @@
<li><a href="manim_ml.html#module-manim_ml.one_to_one_sync">module</a>
</li>
</ul></li>
<li>
manim_ml.probability
<ul>
<li><a href="manim_ml.html#module-manim_ml.probability">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
module
<ul>
<li><a href="manim_ml.html#module-manim_ml">manim_ml</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.image">manim_ml.image</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.list_group">manim_ml.list_group</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.manifold">manim_ml.manifold</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network">manim_ml.neural_network</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">manim_ml.neural_network.layers</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">manim_ml.neural_network.layers.convolutional</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">manim_ml.neural_network.layers.convolutional_to_convolutional</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">manim_ml.neural_network.layers.embedding</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">manim_ml.neural_network.layers.embedding_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">manim_ml.neural_network.layers.feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">manim_ml.neural_network.layers.feed_forward_to_embedding</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">manim_ml.neural_network.layers.feed_forward_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">manim_ml.neural_network.layers.feed_forward_to_image</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">manim_ml.neural_network.layers.feed_forward_to_vector</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">manim_ml.neural_network.layers.image</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">manim_ml.neural_network.layers.image_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">manim_ml.neural_network.layers.paired_query</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">manim_ml.neural_network.layers.paired_query_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">manim_ml.neural_network.layers.parent_layers</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">manim_ml.neural_network.layers.triplet</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">manim_ml.neural_network.layers.triplet_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">manim_ml.neural_network.layers.util</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">manim_ml.neural_network.layers.vector</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">manim_ml.neural_network.neural_network</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">manim_ml.neural_network.neural_network_transformations</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">manim_ml.neural_network.variational_autoencoder</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.one_to_one_sync">manim_ml.one_to_one_sync</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.probability">manim_ml.probability</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="N" class="genindex-section">
<h2>N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork">NeuralNetwork (class in manim_ml.neural_network.neural_network)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene">NeuralNetworkEmbeddingTestScene (class in manim_ml.neural_network.layers.embedding)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer">NeuralNetworkLayer (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="O" class="genindex-section">
<h2>O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.one_to_one_sync.OneToOneSync">OneToOneSync (class in manim_ml.one_to_one_sync)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.output_class">output_class (manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional attribute)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.output_class">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.output_class">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.output_class">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.output_class">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.output_class">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.output_class">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.output_class">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.output_class">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward attribute)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="P" class="genindex-section">
<h2>P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer">PairedQueryLayer (class in manim_ml.neural_network.layers.paired_query)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward">PairedQueryToFeedForward (class in manim_ml.neural_network.layers.paired_query_to_feed_forward)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="R" class="genindex-section">
<h2>R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.remove">remove() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.remove_at_index">remove_at_index() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.remove_at_indices">remove_at_indices() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.remove_connective_layer_animation">remove_connective_layer_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.remove_gaussian_distribution">remove_gaussian_distribution() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.remove_layer">remove_layer() (manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer">RemoveLayer (class in manim_ml.neural_network.neural_network_transformations)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.replace">replace() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.replace_layer">replace_layer() (manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="S" class="genindex-section">
<h2>S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.sample_point_location_from_distribution">sample_point_location_from_distribution() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.set_z_index">set_z_index() (manim_ml.list_group.ListGroup method)</a>
<ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.set_z_index">(manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="T" class="genindex-section">
<h2>T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer">TripletLayer (class in manim_ml.neural_network.layers.triplet)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward">TripletToFeedForward (class in manim_ml.neural_network.layers.triplet_to_feed_forward)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="V" class="genindex-section">
<h2>V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder">VariationalAutoencoder (class in manim_ml.neural_network.variational_autoencoder)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer">VectorLayer (class in manim_ml.neural_network.layers.vector)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer">VGroupNeuralNetworkLayer (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="W" class="genindex-section">
<h2>W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.width">width (manim_ml.neural_network.layers.image.ImageLayer property)</a>
</li>
</ul></td>
</tr></table>

234
docs/build/html/getting_started.html vendored Normal file
View File

@ -0,0 +1,234 @@
<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Getting Started - ManimML documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">ManimML documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">ManimML documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">#</a></h1>
<p>This tutorial shows you how to install ManimML and generate
your first machine learning animation.</p>
<p>Adding to</p>
</section>
</article>
</div>
<footer>
<div class="related-pages">
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022, Alec Helbling
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer no-toc">
</aside>
</div>
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
</body>
</html>

View File

@ -185,8 +185,8 @@
</label>
</div>
<article role="main">
<section id="welcome-to-manimml-s-documentation">
<h1>Welcome to ManimMLs documentation!<a class="headerlink" href="#welcome-to-manimml-s-documentation" title="Permalink to this headline">#</a></h1>
<section id="welcome-to-manimml-s-documentation-testing-differences">
<h1>Welcome to ManimMLs documentation! (Testing differences)<a class="headerlink" href="#welcome-to-manimml-s-documentation-testing-differences" title="Permalink to this headline">#</a></h1>
<div class="toctree-wrapper compound">
</div>
</section>
@ -238,7 +238,7 @@
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Welcome to ManimMLs documentation!</a></li>
<li><a class="reference internal" href="#">Welcome to ManimMLs documentation! (Testing differences)</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>

View File

@ -195,34 +195,34 @@
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manim_ml.neural_network.layers.html">manim_ml.neural_network.layers package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">manim_ml.neural_network.layers.convolutional module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">manim_ml.neural_network.layers.embedding module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">manim_ml.neural_network.layers.feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">manim_ml.neural_network.layers.image module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">manim_ml.neural_network.layers.paired_query module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">manim_ml.neural_network.layers.parent_layers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">manim_ml.neural_network.layers.triplet module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">manim_ml.neural_network.layers.util module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">manim_ml.neural_network.layers.vector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">Module contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-convolutional-module">manim_ml.neural_network.layers.convolutional module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-convolutional-to-convolutional-module">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-embedding-module">manim_ml.neural_network.layers.embedding module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-embedding-to-feed-forward-module">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-module">manim_ml.neural_network.layers.feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-embedding-module">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-feed-forward-module">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-image-module">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-vector-module">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-image-module">manim_ml.neural_network.layers.image module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-image-to-feed-forward-module">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-paired-query-module">manim_ml.neural_network.layers.paired_query module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-paired-query-to-feed-forward-module">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-parent-layers-module">manim_ml.neural_network.layers.parent_layers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-triplet-module">manim_ml.neural_network.layers.triplet module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-triplet-to-feed-forward-module">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-util-module">manim_ml.neural_network.layers.util module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-vector-module">manim_ml.neural_network.layers.vector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-contents">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">manim_ml.neural_network.neural_network module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">manim_ml.neural_network.neural_network_transformations module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">manim_ml.neural_network.variational_autoencoder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network">Module contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#manim-ml-neural-network-neural-network-module">manim_ml.neural_network.neural_network module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#manim-ml-neural-network-neural-network-transformations-module">manim_ml.neural_network.neural_network_transformations module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#manim-ml-neural-network-variational-autoencoder-module">manim_ml.neural_network.variational_autoencoder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-contents">Module contents</a></li>
</ul>
</li>
</ul>
@ -231,95 +231,11 @@
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.image">
<span id="manim-ml-image-module"></span><h2>manim_ml.image module<a class="headerlink" href="#module-manim_ml.image" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.image.</span></span><span class="sig-name descname"><span class="pre">GrayscaleImageMobject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">numpy_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.types.image_mobject.ImageMobject</span></code></p>
<p>Mobject for creating images in Manim from numpy arrays</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">GrayscaleImageMobject.create&gt;}</span></em><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject.create" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject.from_path">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject.from_path" title="Permalink to this definition">#</a></dt>
<dd><p>Loads image from path</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.image.LabeledColorImage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.image.</span></span><span class="sig-name descname"><span class="pre">LabeledColorImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Positive'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">24</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.LabeledColorImage" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.mobject.Group</span></code></p>
<p>Labeled Color Image</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.image.LabeledColorImage.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#manim_ml.image.LabeledColorImage.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<section id="manim-ml-image-module">
<h2>manim_ml.image module<a class="headerlink" href="#manim-ml-image-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.list_group">
<span id="manim-ml-list-group-module"></span><h2>manim_ml.list_group module<a class="headerlink" href="#module-manim_ml.list_group" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.list_group.</span></span><span class="sig-name descname"><span class="pre">ListGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">layers</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.mobject.Mobject</span></code></p>
<p>Indexable Group with traditional list operations</p>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.add" title="Permalink to this definition">#</a></dt>
<dd><p>Adds to end</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#manim_ml.list_group.ListGroup.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.get" title="Permalink to this definition">#</a></dt>
<dd><p>Gets item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.index_of">
<span class="sig-name descname"><span class="pre">index_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.index_of" title="Permalink to this definition">#</a></dt>
<dd><p>Returns index of item if it exists</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.insert">
<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.insert" title="Permalink to this definition">#</a></dt>
<dd><p>Inserts item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.remove" title="Permalink to this definition">#</a></dt>
<dd><p>Removes first instance of item</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.remove_at_index">
<span class="sig-name descname"><span class="pre">remove_at_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.remove_at_index" title="Permalink to this definition">#</a></dt>
<dd><p>Removes item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.remove_at_indices">
<span class="sig-name descname"><span class="pre">remove_at_indices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.remove_at_indices" title="Permalink to this definition">#</a></dt>
<dd><p>Removes items at indices</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.replace">
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.replace" title="Permalink to this definition">#</a></dt>
<dd><p>Replaces item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.set_z_index">
<span class="sig-name descname"><span class="pre">set_z_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">z_index_value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.set_z_index" title="Permalink to this definition">#</a></dt>
<dd><p>Sets z index of all values in ListGroup</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-list-group-module">
<h2>manim_ml.list_group module<a class="headerlink" href="#manim-ml-list-group-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.manifold">
<span id="manim-ml-manifold-module"></span><h2>manim_ml.manifold module<a class="headerlink" href="#module-manim_ml.manifold" title="Permalink to this headline">#</a></h2>
@ -338,32 +254,8 @@ views of the same concept and visualize them at the same time.</p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
</dd></dl>
</section>
<section id="module-manim_ml.probability">
<span id="manim-ml-probability-module"></span><h2>manim_ml.probability module<a class="headerlink" href="#module-manim_ml.probability" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.probability.</span></span><span class="sig-name descname"><span class="pre">GaussianDistribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cov</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dist_theme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'gaussian'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.types.vectorized_mobject.VGroup</span></code></p>
<p>Object for drawing a Gaussian distribution</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.compute_covariance_rotation_and_scale">
<span class="sig-name descname"><span class="pre">compute_covariance_rotation_and_scale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.compute_covariance_rotation_and_scale" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.construct_gaussian_distribution">
<span class="sig-name descname"><span class="pre">construct_gaussian_distribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mean</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_ellipses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.construct_gaussian_distribution" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a 2d Gaussian distribution object with given mean and covariance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.construct_simple_gaussian_ellipse">
<span class="sig-name descname"><span class="pre">construct_simple_gaussian_ellipse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mean</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.construct_simple_gaussian_ellipse" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a 2d Gaussian distribution object with given mean and covariance</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-probability-module">
<h2>manim_ml.probability module<a class="headerlink" href="#manim-ml-probability-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-manim_ml" title="Permalink to this headline">#</a></h2>
@ -412,11 +304,11 @@ views of the same concept and visualize them at the same time.</p>
<li><a class="reference internal" href="#">manim_ml package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-manim_ml.image">manim_ml.image module</a></li>
<li><a class="reference internal" href="#module-manim_ml.list_group">manim_ml.list_group module</a></li>
<li><a class="reference internal" href="#manim-ml-image-module">manim_ml.image module</a></li>
<li><a class="reference internal" href="#manim-ml-list-group-module">manim_ml.list_group module</a></li>
<li><a class="reference internal" href="#module-manim_ml.manifold">manim_ml.manifold module</a></li>
<li><a class="reference internal" href="#module-manim_ml.one_to_one_sync">manim_ml.one_to_one_sync module</a></li>
<li><a class="reference internal" href="#module-manim_ml.probability">manim_ml.probability module</a></li>
<li><a class="reference internal" href="#manim-ml-probability-module">manim_ml.probability module</a></li>
<li><a class="reference internal" href="#module-manim_ml">Module contents</a></li>
</ul>
</li>

View File

@ -193,25 +193,25 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="manim_ml.neural_network.layers.html">manim_ml.neural_network.layers package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">manim_ml.neural_network.layers.convolutional module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">manim_ml.neural_network.layers.embedding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">manim_ml.neural_network.layers.feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">manim_ml.neural_network.layers.image module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">manim_ml.neural_network.layers.paired_query module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">manim_ml.neural_network.layers.parent_layers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">manim_ml.neural_network.layers.triplet module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">manim_ml.neural_network.layers.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">manim_ml.neural_network.layers.vector module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">Module contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-convolutional-module">manim_ml.neural_network.layers.convolutional module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-convolutional-to-convolutional-module">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-embedding-module">manim_ml.neural_network.layers.embedding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-embedding-to-feed-forward-module">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-module">manim_ml.neural_network.layers.feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-embedding-module">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-feed-forward-module">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-image-module">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-feed-forward-to-vector-module">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-image-module">manim_ml.neural_network.layers.image module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-image-to-feed-forward-module">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-paired-query-module">manim_ml.neural_network.layers.paired_query module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-paired-query-to-feed-forward-module">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-parent-layers-module">manim_ml.neural_network.layers.parent_layers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-triplet-module">manim_ml.neural_network.layers.triplet module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-triplet-to-feed-forward-module">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-util-module">manim_ml.neural_network.layers.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#manim-ml-neural-network-layers-vector-module">manim_ml.neural_network.layers.vector module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-contents">Module contents</a></li>
</ul>
</li>
</ul>
@ -220,166 +220,17 @@
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.neural_network">
<span id="manim-ml-neural-network-neural-network-module"></span><h2>manim_ml.neural_network.neural_network module<a class="headerlink" href="#module-manim_ml.neural_network.neural_network" title="Permalink to this headline">#</a></h2>
<p>Neural Network Manim Visualization</p>
<p>This module is responsible for generating a neural network visualization with
manim, specifically a fully connected neural network diagram.</p>
<p class="rubric">Example</p>
<p># Specify how many nodes are in each node layer
layer_node_count = [5, 3, 5]
# Create the object with default style settings
NeuralNetwork(layer_node_count)</p>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.neural_network.</span></span><span class="sig-name descname"><span class="pre">FeedForwardNeuralNetwork</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_node_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#58C4DD'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.neural_network.NeuralNetwork" title="manim_ml.neural_network.neural_network.NeuralNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.neural_network.NeuralNetwork</span></code></a></p>
<p>NeuralNetwork with just feed forward layers</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">NeuralNetwork._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.neural_network.</span></span><span class="sig-name descname"><span class="pre">NeuralNetwork</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edge_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FFFFFF'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_spacing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edge_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.03</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.mobject.Group</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">NeuralNetwork._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork.insert_layer">
<span class="sig-name descname"><span class="pre">insert_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">insert_index</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork.insert_layer" title="Permalink to this definition">#</a></dt>
<dd><p>Inserts a layer at the given index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passing_flash</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Generates an animation for feed forward propagation</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork.remove_layer">
<span class="sig-name descname"><span class="pre">remove_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork.remove_layer" title="Permalink to this definition">#</a></dt>
<dd><p>Removes layer object if it exists</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork.replace_layer">
<span class="sig-name descname"><span class="pre">replace_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_layer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork.replace_layer" title="Permalink to this definition">#</a></dt>
<dd><p>Replaces given layer object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network.NeuralNetwork.set_z_index">
<span class="sig-name descname"><span class="pre">set_z_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">z_index_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network.NeuralNetwork.set_z_index" title="Permalink to this definition">#</a></dt>
<dd><p>Overriden set_z_index</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-neural-network-module">
<h2>manim_ml.neural_network.neural_network module<a class="headerlink" href="#manim-ml-neural-network-neural-network-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.neural_network_transformations">
<span id="manim-ml-neural-network-neural-network-transformations-module"></span><h2>manim_ml.neural_network.neural_network_transformations module<a class="headerlink" href="#module-manim_ml.neural_network.neural_network_transformations" title="Permalink to this headline">#</a></h2>
<p>Transformations for manipulating a neural network object.</p>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.InsertLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.neural_network_transformations.</span></span><span class="sig-name descname"><span class="pre">InsertLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mobject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_override</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.InsertLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.animation.composition.AnimationGroup</span></code></p>
<p>Animation for inserting layer at given index</p>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.InsertLayer.get_connective_layer_widths">
<span class="sig-name descname"><span class="pre">get_connective_layer_widths</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.InsertLayer.get_connective_layer_widths" title="Permalink to this definition">#</a></dt>
<dd><p>Gets the widths of the connective layers</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_connective_layers_animation">
<span class="sig-name descname"><span class="pre">make_create_connective_layers_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_connective</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after_connective</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_connective_layers_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Create connective layers</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_layer_animation">
<span class="sig-name descname"><span class="pre">make_create_layer_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_layer_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Animates the creation of the layer</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.InsertLayer.make_move_layers_animation">
<span class="sig-name descname"><span class="pre">make_move_layers_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_move_layers_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Shifts layers before and after</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.InsertLayer.remove_connective_layer_animation">
<span class="sig-name descname"><span class="pre">remove_connective_layer_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.InsertLayer.remove_connective_layer_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Removes the connective layer before the insertion index</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.neural_network_transformations.</span></span><span class="sig-name descname"><span class="pre">RemoveLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mobject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_override</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.animation.composition.AnimationGroup</span></code></p>
<p>Animation for removing a layer from a neural network.</p>
<p>Note: I needed to do something strange for creating the new connective layer.
The issue with creating it intially is that the positions of the sides of the
connective layer depend upon the location of the moved layers <strong>after</strong> the
move animations are performed. However, all of these animations are performed
after the animations have been created. This means that the animation depends upon
the state of the neural network layers after previous animations have been run.
To fix this issue I needed to use an UpdateFromFunc.</p>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer.get_connective_layers">
<span class="sig-name descname"><span class="pre">get_connective_layers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer.get_connective_layers" title="Permalink to this definition">#</a></dt>
<dd><p>Gets the connective layers before and after self.layer</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_move_animation">
<span class="sig-name descname"><span class="pre">make_move_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_move_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Collapses layers</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_new_connective_animation">
<span class="sig-name descname"><span class="pre">make_new_connective_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_new_connective_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes new connective layer</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_animation">
<span class="sig-name descname"><span class="pre">make_remove_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Removes layer and the surrounding connective layers</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_connective_layers_animation">
<span class="sig-name descname"><span class="pre">make_remove_connective_layers_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_connective_layers_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Removes the connective layers before and after layer if they exist</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_layer_animation">
<span class="sig-name descname"><span class="pre">make_remove_layer_animation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_layer_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Removes the layer</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-neural-network-transformations-module">
<h2>manim_ml.neural_network.neural_network_transformations module<a class="headerlink" href="#manim-ml-neural-network-neural-network-transformations-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.variational_autoencoder">
<span id="manim-ml-neural-network-variational-autoencoder-module"></span><h2>manim_ml.neural_network.variational_autoencoder module<a class="headerlink" href="#module-manim_ml.neural_network.variational_autoencoder" title="Permalink to this headline">#</a></h2>
<p>Variational Autoencoder Manim Visualizations</p>
<p>In this module I define Manim visualizations for Variational Autoencoders
and Traditional Autoencoders.</p>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.variational_autoencoder.</span></span><span class="sig-name descname"><span class="pre">VariationalAutoencoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encoder_nodes_per_layer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[5,</span> <span class="pre">3]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decoder_nodes_per_layer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[3,</span> <span class="pre">5]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">point_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#58C4DD'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ellipse_stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_spacing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.types.vectorized_mobject.VGroup</span></code></p>
<p>Variational Autoencoder Manim Visualization</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">VariationalAutoencoder._create_vae&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_image_forward_pass">
<span class="sig-name descname"><span class="pre">make_image_forward_pass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_image_forward_pass" title="Permalink to this definition">#</a></dt>
<dd><p>Override forward pass animation specific to a VAE</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_triplet_forward_pass">
<span class="sig-name descname"><span class="pre">make_triplet_forward_pass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">triplet</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_triplet_forward_pass" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-variational-autoencoder-module">
<h2>manim_ml.neural_network.variational_autoencoder module<a class="headerlink" href="#manim-ml-neural-network-variational-autoencoder-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-manim_ml.neural_network" title="Permalink to this headline">#</a></h2>
<section id="module-contents">
<h2>Module contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">#</a></h2>
</section>
</section>
@ -425,10 +276,10 @@ and Traditional Autoencoders.</p>
<li><a class="reference internal" href="#">manim_ml.neural_network package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.neural_network">manim_ml.neural_network.neural_network module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.neural_network_transformations">manim_ml.neural_network.neural_network_transformations module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.variational_autoencoder">manim_ml.neural_network.variational_autoencoder module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network">Module contents</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-neural-network-module">manim_ml.neural_network.neural_network module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-neural-network-transformations-module">manim_ml.neural_network.neural_network_transformations module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-variational-autoencoder-module">manim_ml.neural_network.variational_autoencoder module</a></li>
<li><a class="reference internal" href="#module-contents">Module contents</a></li>
</ul>
</li>
</ul>

View File

@ -190,582 +190,62 @@
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.convolutional">
<span id="manim-ml-neural-network-layers-convolutional-module"></span><h2>manim_ml.neural_network.layers.convolutional module<a class="headerlink" href="#module-manim_ml.neural_network.layers.convolutional" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional.ConvolutionalLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.convolutional.</span></span><span class="sig-name descname"><span class="pre">ConvolutionalLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_filters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_spacing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pulse_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer</span></code></a></p>
<p>Handles rendering a convolutional layer for a nn</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">ConvolutionalLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_filter_corner_lines">
<span class="sig-name descname"><span class="pre">make_filter_corner_lines</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_filter_corner_lines" title="Permalink to this definition">#</a></dt>
<dd><p>Make filter corner lines</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Convolution forward pass animation</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-convolutional-module">
<h2>manim_ml.neural_network.layers.convolutional module<a class="headerlink" href="#manim-ml-neural-network-layers-convolutional-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.convolutional_to_convolutional">
<span id="manim-ml-neural-network-layers-convolutional-to-convolutional-module"></span><h2>manim_ml.neural_network.layers.convolutional_to_convolutional module<a class="headerlink" href="#module-manim_ml.neural_network.layers.convolutional_to_convolutional" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.convolutional_to_convolutional.</span></span><span class="sig-name descname"><span class="pre">ConvolutionalToConvolutional</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FFFFFF'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pulse_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Feed Forward to Embedding Layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">ConvolutionalToConvolutional._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer" title="manim_ml.neural_network.layers.convolutional.ConvolutionalLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.convolutional.ConvolutionalLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Forward pass animation from conv to conv</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_lines">
<span class="sig-name descname"><span class="pre">make_lines</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_lines" title="Permalink to this definition">#</a></dt>
<dd><p>Make lines connecting the input and output layers</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer" title="manim_ml.neural_network.layers.convolutional.ConvolutionalLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.convolutional.ConvolutionalLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-convolutional-to-convolutional-module">
<h2>manim_ml.neural_network.layers.convolutional_to_convolutional module<a class="headerlink" href="#manim-ml-neural-network-layers-convolutional-to-convolutional-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.embedding">
<span id="manim-ml-neural-network-layers-embedding-module"></span><h2>manim_ml.neural_network.layers.embedding module<a class="headerlink" href="#module-manim_ml.neural_network.layers.embedding" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.embedding.</span></span><span class="sig-name descname"><span class="pre">EmbeddingLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">point_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.02</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">array([0,</span> <span class="pre">0])</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">covariance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">array([[1.,</span> <span class="pre">0.],</span> <span class="pre">[0.,</span> <span class="pre">1.]])</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dist_theme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'gaussian'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paired_query_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer</span></code></a></p>
<p>NeuralNetwork embedding object that can show probability distributions</p>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.add_gaussian_distribution">
<span class="sig-name descname"><span class="pre">add_gaussian_distribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gaussian_distribution</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.add_gaussian_distribution" title="Permalink to this definition">#</a></dt>
<dd><p>Adds given GaussianDistribution to the list</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">EmbeddingLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.construct_gaussian_point_cloud">
<span class="sig-name descname"><span class="pre">construct_gaussian_point_cloud</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mean</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">point_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FFFFFF'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_points</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">400</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.construct_gaussian_point_cloud" title="Permalink to this definition">#</a></dt>
<dd><p>Plots points sampled from a Gaussian with the given mean and covariance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.get_distribution_location">
<span class="sig-name descname"><span class="pre">get_distribution_location</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.get_distribution_location" title="Permalink to this definition">#</a></dt>
<dd><p>Returns mean of latent distribution in axes frame</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Forward pass animation</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.remove_gaussian_distribution">
<span class="sig-name descname"><span class="pre">remove_gaussian_distribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gaussian_distribution</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.remove_gaussian_distribution" title="Permalink to this definition">#</a></dt>
<dd><p>Removes the given gaussian distribution from the embedding</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.EmbeddingLayer.sample_point_location_from_distribution">
<span class="sig-name descname"><span class="pre">sample_point_location_from_distribution</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer.sample_point_location_from_distribution" title="Permalink to this definition">#</a></dt>
<dd><p>Samples from the current latent distribution</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.embedding.</span></span><span class="sig-name descname"><span class="pre">NeuralNetworkEmbeddingTestScene</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">renderer=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_class=&lt;class</span> <span class="pre">'manim.camera.camera.Camera'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">always_update_mobjects=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">random_seed=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_animations=False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.scene.scene.Scene</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene.construct">
<span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene.construct" title="Permalink to this definition">#</a></dt>
<dd><p>Add content to the Scene.</p>
<p>From within <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.construct()</span></code>, display mobjects on screen by calling
<code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.add()</span></code> and remove them from screen by calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.remove()</span></code>.
All mobjects currently on screen are kept in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Scene.mobjects</span></code>. Play
animations by calling <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.play()</span></code>.</p>
<p class="rubric">Notes</p>
<p>Initialization code should go in <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.setup()</span></code>. Termination code should
go in <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.tear_down()</span></code>.</p>
<p class="rubric">Examples</p>
<p>A typical manim script includes a class derived from <code class="xref py py-class docutils literal notranslate"><span class="pre">Scene</span></code> with an
overridden <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.contruct()</span></code> method:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyScene</span><span class="p">(</span><span class="n">Scene</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">construct</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">play</span><span class="p">(</span><span class="n">Write</span><span class="p">(</span><span class="n">Text</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)))</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.setup()</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.render()</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">Scene.tear_down()</span></code></p>
</div>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-embedding-module">
<h2>manim_ml.neural_network.layers.embedding module<a class="headerlink" href="#manim-ml-neural-network-layers-embedding-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.embedding_to_feed_forward">
<span id="manim-ml-neural-network-layers-embedding-to-feed-forward-module"></span><h2>manim_ml.neural_network.layers.embedding_to_feed_forward module<a class="headerlink" href="#module-manim_ml.neural_network.layers.embedding_to_feed_forward" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.embedding_to_feed_forward.</span></span><span class="sig-name descname"><span class="pre">EmbeddingToFeedForward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.03</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Feed Forward to Embedding Layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">EmbeddingToFeedForward._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer" title="manim_ml.neural_network.layers.embedding.EmbeddingLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.embedding.EmbeddingLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots diverge from the given location and move the decoder</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-embedding-to-feed-forward-module">
<h2>manim_ml.neural_network.layers.embedding_to_feed_forward module<a class="headerlink" href="#manim-ml-neural-network-layers-embedding-to-feed-forward-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.feed_forward">
<span id="manim-ml-neural-network-layers-feed-forward-module"></span><h2>manim_ml.neural_network.layers.feed_forward module<a class="headerlink" href="#module-manim_ml.neural_network.layers.feed_forward" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.feed_forward.</span></span><span class="sig-name descname"><span class="pre">FeedForwardLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_nodes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_buffer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#58C4DD'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_outline_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FFFFFF'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rectangle_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FFFFFF'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_spacing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rectangle_fill_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#000000'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node_stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rectangle_stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer</span></code></a></p>
<p>Handles rendering a layer for a neural network</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">FeedForwardLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-feed-forward-module">
<h2>manim_ml.neural_network.layers.feed_forward module<a class="headerlink" href="#manim-ml-neural-network-layers-feed-forward-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.feed_forward_to_embedding">
<span id="manim-ml-neural-network-layers-feed-forward-to-embedding-module"></span><h2>manim_ml.neural_network.layers.feed_forward_to_embedding module<a class="headerlink" href="#module-manim_ml.neural_network.layers.feed_forward_to_embedding" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.feed_forward_to_embedding.</span></span><span class="sig-name descname"><span class="pre">FeedForwardToEmbedding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.03</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Feed Forward to Embedding Layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">FeedForwardToEmbedding._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots converge on a specific location</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.embedding.EmbeddingLayer" title="manim_ml.neural_network.layers.embedding.EmbeddingLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.embedding.EmbeddingLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-feed-forward-to-embedding-module">
<h2>manim_ml.neural_network.layers.feed_forward_to_embedding module<a class="headerlink" href="#manim-ml-neural-network-layers-feed-forward-to-embedding-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">
<span id="manim-ml-neural-network-layers-feed-forward-to-feed-forward-module"></span><h2>manim_ml.neural_network.layers.feed_forward_to_feed_forward module<a class="headerlink" href="#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.feed_forward_to_feed_forward.</span></span><span class="sig-name descname"><span class="pre">FeedForwardToFeedForward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passing_flash</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edge_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FFFFFF'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edge_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Layer for connecting FeedForward layer to FeedForwardLayer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">FeedForwardToFeedForward._create_override&gt;,</span> <span class="pre">&lt;class</span> <span class="pre">'manim.animation.fading.FadeOut'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">FeedForwardToFeedForward._fadeout_animation&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.construct_edges">
<span class="sig-name descname"><span class="pre">construct_edges</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.construct_edges" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Animation for passing information from one FeedForwardLayer to the next</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-feed-forward-to-feed-forward-module">
<h2>manim_ml.neural_network.layers.feed_forward_to_feed_forward module<a class="headerlink" href="#manim-ml-neural-network-layers-feed-forward-to-feed-forward-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.feed_forward_to_image">
<span id="manim-ml-neural-network-layers-feed-forward-to-image-module"></span><h2>manim_ml.neural_network.layers.feed_forward_to_image module<a class="headerlink" href="#module-manim_ml.neural_network.layers.feed_forward_to_image" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.feed_forward_to_image.</span></span><span class="sig-name descname"><span class="pre">FeedForwardToImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Image Layer to FeedForward layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">FeedForwardToImage._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots diverge from the given location and move to the feed forward nodes decoder</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.image.ImageLayer" title="manim_ml.neural_network.layers.image.ImageLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.image.ImageLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-feed-forward-to-image-module">
<h2>manim_ml.neural_network.layers.feed_forward_to_image module<a class="headerlink" href="#manim-ml-neural-network-layers-feed-forward-to-image-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.feed_forward_to_vector">
<span id="manim-ml-neural-network-layers-feed-forward-to-vector-module"></span><h2>manim_ml.neural_network.layers.feed_forward_to_vector module<a class="headerlink" href="#module-manim_ml.neural_network.layers.feed_forward_to_vector" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.feed_forward_to_vector.</span></span><span class="sig-name descname"><span class="pre">FeedForwardToVector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Image Layer to FeedForward layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">FeedForwardToVector._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots diverge from the given location and move to the feed forward nodes decoder</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.vector.VectorLayer" title="manim_ml.neural_network.layers.vector.VectorLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.vector.VectorLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-feed-forward-to-vector-module">
<h2>manim_ml.neural_network.layers.feed_forward_to_vector module<a class="headerlink" href="#manim-ml-neural-network-layers-feed-forward-to-vector-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.image">
<span id="manim-ml-neural-network-layers-image-module"></span><h2>manim_ml.neural_network.layers.image module<a class="headerlink" href="#module-manim_ml.neural_network.layers.image" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.image.</span></span><span class="sig-name descname"><span class="pre">ImageLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">numpy_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_image_on_create</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer</span></code></a></p>
<p>Single Image Layer for Neural Network</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">ImageLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer.from_path">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">grayscale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer.from_path" title="Permalink to this definition">#</a></dt>
<dd><p>Creates a query using the paths</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer.get_right">
<span class="sig-name descname"><span class="pre">get_right</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer.get_right" title="Permalink to this definition">#</a></dt>
<dd><p>Override get right</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer.height">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">height</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer.height" title="Permalink to this definition">#</a></dt>
<dd><p>The height of the mobject.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><code class="xref py py-meth docutils literal notranslate"><span class="pre">length_over_dim()</span></code></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image.ImageLayer.width">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">width</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.image.ImageLayer.width" title="Permalink to this definition">#</a></dt>
<dd><p>The width of the mobject.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><code class="xref py py-meth docutils literal notranslate"><span class="pre">length_over_dim()</span></code></p>
</div>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-image-module">
<h2>manim_ml.neural_network.layers.image module<a class="headerlink" href="#manim-ml-neural-network-layers-image-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.image_to_feed_forward">
<span id="manim-ml-neural-network-layers-image-to-feed-forward-module"></span><h2>manim_ml.neural_network.layers.image_to_feed_forward module<a class="headerlink" href="#module-manim_ml.neural_network.layers.image_to_feed_forward" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.image_to_feed_forward.</span></span><span class="sig-name descname"><span class="pre">ImageToFeedForward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Image Layer to FeedForward layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">ImageToFeedForward._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.image.ImageLayer" title="manim_ml.neural_network.layers.image.ImageLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.image.ImageLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots diverge from the given location and move to the feed forward nodes decoder</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-image-to-feed-forward-module">
<h2>manim_ml.neural_network.layers.image_to_feed_forward module<a class="headerlink" href="#manim-ml-neural-network-layers-image-to-feed-forward-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.paired_query">
<span id="manim-ml-neural-network-layers-paired-query-module"></span><h2>manim_ml.neural_network.layers.paired_query module<a class="headerlink" href="#module-manim_ml.neural_network.layers.paired_query" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query.PairedQueryLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.paired_query.</span></span><span class="sig-name descname"><span class="pre">PairedQueryLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">positive</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negative</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">18</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spacing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query.PairedQueryLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer</span></code></a></p>
<p>Paired Query Layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query.PairedQueryLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">PairedQueryLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query.PairedQueryLayer.from_paths">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_paths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">positive_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negative_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">grayscale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.from_paths" title="Permalink to this definition">#</a></dt>
<dd><p>Creates a query using the paths</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_assets">
<span class="sig-name descname"><span class="pre">make_assets</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_assets" title="Permalink to this definition">#</a></dt>
<dd><p>Constructs the assets needed for a query layer</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Forward pass for query</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-paired-query-module">
<h2>manim_ml.neural_network.layers.paired_query module<a class="headerlink" href="#manim-ml-neural-network-layers-paired-query-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.paired_query_to_feed_forward">
<span id="manim-ml-neural-network-layers-paired-query-to-feed-forward-module"></span><h2>manim_ml.neural_network.layers.paired_query_to_feed_forward module<a class="headerlink" href="#module-manim_ml.neural_network.layers.paired_query_to_feed_forward" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.paired_query_to_feed_forward.</span></span><span class="sig-name descname"><span class="pre">PairedQueryToFeedForward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.02</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>PairedQuery layer to FeedForward layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">PairedQueryToFeedForward._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.paired_query.PairedQueryLayer" title="manim_ml.neural_network.layers.paired_query.PairedQueryLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.paired_query.PairedQueryLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots diverge from the given location and move to the feed forward nodes decoder</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-paired-query-to-feed-forward-module">
<h2>manim_ml.neural_network.layers.paired_query_to_feed_forward module<a class="headerlink" href="#manim-ml-neural-network-layers-paired-query-to-feed-forward-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.parent_layers">
<span id="manim-ml-neural-network-layers-parent-layers-module"></span><h2>manim_ml.neural_network.layers.parent_layers module<a class="headerlink" href="#module-manim_ml.neural_network.layers.parent_layers" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.BlankConnective">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.parent_layers.</span></span><span class="sig-name descname"><span class="pre">BlankConnective</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.BlankConnective" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>Connective layer to be used when the given pair of layers is undefined</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.BlankConnective.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">BlankConnective._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.BlankConnective.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.BlankConnective.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.BlankConnective.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.parent_layers.</span></span><span class="sig-name descname"><span class="pre">ConnectiveLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer</span></code></a></p>
<p>Forward pass animation for a given pair of layers</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">ConnectiveLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.make_forward_pass_animation">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.parent_layers.</span></span><span class="sig-name descname"><span class="pre">NeuralNetworkLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.mobject.Group</span></code></p>
<p>Abstract Neural Network Layer class</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">NeuralNetworkLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.make_forward_pass_animation">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.parent_layers.</span></span><span class="sig-name descname"><span class="pre">VGroupNeuralNetworkLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">VGroupNeuralNetworkLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.make_forward_pass_animation">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-parent-layers-module">
<h2>manim_ml.neural_network.layers.parent_layers module<a class="headerlink" href="#manim-ml-neural-network-layers-parent-layers-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.triplet">
<span id="manim-ml-neural-network-layers-triplet-module"></span><h2>manim_ml.neural_network.layers.triplet module<a class="headerlink" href="#module-manim_ml.neural_network.layers.triplet" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet.TripletLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.triplet.</span></span><span class="sig-name descname"><span class="pre">TripletLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">anchor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">positive</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negative</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">22</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet.TripletLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer</span></code></a></p>
<p>Shows triplet images</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet.TripletLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">TripletLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.triplet.TripletLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet.TripletLayer.from_paths">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_paths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">anchor_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">positive_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negative_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">grayscale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">22</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet.TripletLayer.from_paths" title="Permalink to this definition">#</a></dt>
<dd><p>Creates a triplet using the anchor paths</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet.TripletLayer.make_assets">
<span class="sig-name descname"><span class="pre">make_assets</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet.TripletLayer.make_assets" title="Permalink to this definition">#</a></dt>
<dd><p>Constructs the assets needed for a triplet layer</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet.TripletLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet.TripletLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Forward pass for triplet</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-triplet-module">
<h2>manim_ml.neural_network.layers.triplet module<a class="headerlink" href="#manim-ml-neural-network-layers-triplet-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.triplet_to_feed_forward">
<span id="manim-ml-neural-network-layers-triplet-to-feed-forward-module"></span><h2>manim_ml.neural_network.layers.triplet_to_feed_forward module<a class="headerlink" href="#module-manim_ml.neural_network.layers.triplet_to_feed_forward" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.triplet_to_feed_forward.</span></span><span class="sig-name descname"><span class="pre">TripletToFeedForward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">animation_dot_color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dot_radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.02</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer" title="manim_ml.neural_network.layers.parent_layers.ConnectiveLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.ConnectiveLayer</span></code></a></p>
<p>TripletLayer to FeedForward layer</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">TripletToFeedForward._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.input_class">
<span class="sig-name descname"><span class="pre">input_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.input_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.triplet.TripletLayer" title="manim_ml.neural_network.layers.triplet.TripletLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.triplet.TripletLayer</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd><p>Makes dots diverge from the given location and move to the feed forward nodes decoder</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.output_class">
<span class="sig-name descname"><span class="pre">output_class</span></span><a class="headerlink" href="#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.output_class" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer" title="manim_ml.neural_network.layers.feed_forward.FeedForwardLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.feed_forward.FeedForwardLayer</span></code></a></p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-triplet-to-feed-forward-module">
<h2>manim_ml.neural_network.layers.triplet_to_feed_forward module<a class="headerlink" href="#manim-ml-neural-network-layers-triplet-to-feed-forward-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.util">
<span id="manim-ml-neural-network-layers-util-module"></span><h2>manim_ml.neural_network.layers.util module<a class="headerlink" href="#module-manim_ml.neural_network.layers.util" title="Permalink to this headline">#</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.util.get_connective_layer">
<span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.util.</span></span><span class="sig-name descname"><span class="pre">get_connective_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_layer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_layer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.util.get_connective_layer" title="Permalink to this definition">#</a></dt>
<dd><p>Deduces the relevant connective layer</p>
</dd></dl>
<section id="manim-ml-neural-network-layers-util-module">
<h2>manim_ml.neural_network.layers.util module<a class="headerlink" href="#manim-ml-neural-network-layers-util-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers.vector">
<span id="manim-ml-neural-network-layers-vector-module"></span><h2>manim_ml.neural_network.layers.vector module<a class="headerlink" href="#module-manim_ml.neural_network.layers.vector" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.vector.VectorLayer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.neural_network.layers.vector.</span></span><span class="sig-name descname"><span class="pre">VectorLayer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_func=&lt;function</span> <span class="pre">VectorLayer.&lt;lambda&gt;&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.vector.VectorLayer" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer" title="manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer"><code class="xref py py-class docutils literal notranslate"><span class="pre">manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer</span></code></a></p>
<p>Shows a vector</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.vector.VectorLayer.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">VectorLayer._create_override&gt;}</span></em><a class="headerlink" href="#manim_ml.neural_network.layers.vector.VectorLayer.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.vector.VectorLayer.make_forward_pass_animation">
<span class="sig-name descname"><span class="pre">make_forward_pass_animation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.vector.VectorLayer.make_forward_pass_animation" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.neural_network.layers.vector.VectorLayer.make_vector">
<span class="sig-name descname"><span class="pre">make_vector</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.neural_network.layers.vector.VectorLayer.make_vector" title="Permalink to this definition">#</a></dt>
<dd><p>Makes the vector</p>
</dd></dl>
</dd></dl>
<section id="manim-ml-neural-network-layers-vector-module">
<h2>manim_ml.neural_network.layers.vector module<a class="headerlink" href="#manim-ml-neural-network-layers-vector-module" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.neural_network.layers">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-manim_ml.neural_network.layers" title="Permalink to this headline">#</a></h2>
<section id="module-contents">
<h2>Module contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">#</a></h2>
</section>
</section>
@ -810,25 +290,25 @@ overridden <code class="xref py py-meth docutils literal notranslate"><span clas
<ul>
<li><a class="reference internal" href="#">manim_ml.neural_network.layers package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.convolutional">manim_ml.neural_network.layers.convolutional module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.convolutional_to_convolutional">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.embedding">manim_ml.neural_network.layers.embedding module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.embedding_to_feed_forward">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.feed_forward">manim_ml.neural_network.layers.feed_forward module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.feed_forward_to_embedding">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.feed_forward_to_image">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.feed_forward_to_vector">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.image">manim_ml.neural_network.layers.image module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.image_to_feed_forward">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.paired_query">manim_ml.neural_network.layers.paired_query module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.parent_layers">manim_ml.neural_network.layers.parent_layers module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.triplet">manim_ml.neural_network.layers.triplet module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.triplet_to_feed_forward">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.util">manim_ml.neural_network.layers.util module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers.vector">manim_ml.neural_network.layers.vector module</a></li>
<li><a class="reference internal" href="#module-manim_ml.neural_network.layers">Module contents</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-convolutional-module">manim_ml.neural_network.layers.convolutional module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-convolutional-to-convolutional-module">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-embedding-module">manim_ml.neural_network.layers.embedding module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-embedding-to-feed-forward-module">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-feed-forward-module">manim_ml.neural_network.layers.feed_forward module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-feed-forward-to-embedding-module">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-feed-forward-to-feed-forward-module">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-feed-forward-to-image-module">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-feed-forward-to-vector-module">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-image-module">manim_ml.neural_network.layers.image module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-image-to-feed-forward-module">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-paired-query-module">manim_ml.neural_network.layers.paired_query module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-paired-query-to-feed-forward-module">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-parent-layers-module">manim_ml.neural_network.layers.parent_layers module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-triplet-module">manim_ml.neural_network.layers.triplet module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-triplet-to-feed-forward-module">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-util-module">manim_ml.neural_network.layers.util module</a></li>
<li><a class="reference internal" href="#manim-ml-neural-network-layers-vector-module">manim_ml.neural_network.layers.vector module</a></li>
<li><a class="reference internal" href="#module-contents">Module contents</a></li>
</ul>
</li>
</ul>

View File

@ -194,20 +194,20 @@
<li class="toctree-l3"><a class="reference internal" href="manim_ml.neural_network.html">manim_ml.neural_network package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">manim_ml.neural_network.neural_network module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">manim_ml.neural_network.neural_network_transformations module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">manim_ml.neural_network.variational_autoencoder module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network">Module contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#manim-ml-neural-network-neural-network-module">manim_ml.neural_network.neural_network module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#manim-ml-neural-network-neural-network-transformations-module">manim_ml.neural_network.neural_network_transformations module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#manim-ml-neural-network-variational-autoencoder-module">manim_ml.neural_network.variational_autoencoder module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.html#module-contents">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#module-manim_ml.image">manim_ml.image module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#module-manim_ml.list_group">manim_ml.list_group module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#manim-ml-image-module">manim_ml.image module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#manim-ml-list-group-module">manim_ml.list_group module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#module-manim_ml.manifold">manim_ml.manifold module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#module-manim_ml.one_to_one_sync">manim_ml.one_to_one_sync module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#module-manim_ml.probability">manim_ml.probability module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#manim-ml-probability-module">manim_ml.probability module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.html#module-manim_ml">Module contents</a></li>
</ul>
</li>

View File

@ -0,0 +1,275 @@
<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Design Doc: Neural Network Rendering Pipeline - ManimML documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">ManimML documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">ManimML documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="design-doc-neural-network-rendering-pipeline">
<h1>Design Doc: Neural Network Rendering Pipeline<a class="headerlink" href="#design-doc-neural-network-rendering-pipeline" title="Permalink to this headline">#</a></h1>
<section id="neural-network-layer-scope-and-mobject-ownership">
<h2>Neural Network Layer Scope and Mobject Ownership<a class="headerlink" href="#neural-network-layer-scope-and-mobject-ownership" title="Permalink to this headline">#</a></h2>
<p>An important consideration when designing this pipeline
was to figure out a consistent design philosophy answering the
following questions:</p>
<ol class="arabic simple">
<li><p>What content is owned by an individual layer?</p></li>
<li><p>Does a layer describe an operation, a piece of data, or both?</p></li>
</ol>
</section>
<section id="constructing-more-elaborate-animations">
<h2>Constructing More Elaborate Animations<a class="headerlink" href="#constructing-more-elaborate-animations" title="Permalink to this headline">#</a></h2>
<p>Sometimes we want to construct custom animations that span more
than a single central layer and its two surrounding layers.</p>
<p>One possible solution to this is to allow for the passing
of neural networks into larger neural networks and treating them as layers.
This way a person can make a class that extends NeuralNetwork, which then
can implement its own forward pass animation, and then that neural network
can then be passed into a larger neural network and treated as its own
individual layer.</p>
<p>This may be a good workaround in certain situations, but this does not
solve the problem of allowing for multiple animations that each require
the context of multiple layers.</p>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022, Alec Helbling
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
Contents
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Design Doc: Neural Network Rendering Pipeline</a><ul>
<li><a class="reference internal" href="#neural-network-layer-scope-and-mobject-ownership">Neural Network Layer Scope and Mobject Ownership</a></li>
<li><a class="reference internal" href="#constructing-more-elaborate-animations">Constructing More Elaborate Animations</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
</body>
</html>

Binary file not shown.

View File

@ -202,174 +202,18 @@
<a href="manim_ml.html#module-manim_ml"><code class="xref">manim_ml</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.html#module-manim_ml.image"><code class="xref">manim_ml.image</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.html#module-manim_ml.list_group"><code class="xref">manim_ml.list_group</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.html#module-manim_ml.manifold"><code class="xref">manim_ml.manifold</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.html#module-manim_ml.neural_network"><code class="xref">manim_ml.neural_network</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers"><code class="xref">manim_ml.neural_network.layers</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional"><code class="xref">manim_ml.neural_network.layers.convolutional</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional"><code class="xref">manim_ml.neural_network.layers.convolutional_to_convolutional</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding"><code class="xref">manim_ml.neural_network.layers.embedding</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward"><code class="xref">manim_ml.neural_network.layers.embedding_to_feed_forward</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward"><code class="xref">manim_ml.neural_network.layers.feed_forward</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding"><code class="xref">manim_ml.neural_network.layers.feed_forward_to_embedding</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward"><code class="xref">manim_ml.neural_network.layers.feed_forward_to_feed_forward</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image"><code class="xref">manim_ml.neural_network.layers.feed_forward_to_image</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector"><code class="xref">manim_ml.neural_network.layers.feed_forward_to_vector</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image"><code class="xref">manim_ml.neural_network.layers.image</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward"><code class="xref">manim_ml.neural_network.layers.image_to_feed_forward</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query"><code class="xref">manim_ml.neural_network.layers.paired_query</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward"><code class="xref">manim_ml.neural_network.layers.paired_query_to_feed_forward</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers"><code class="xref">manim_ml.neural_network.layers.parent_layers</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet"><code class="xref">manim_ml.neural_network.layers.triplet</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward"><code class="xref">manim_ml.neural_network.layers.triplet_to_feed_forward</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util"><code class="xref">manim_ml.neural_network.layers.util</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector"><code class="xref">manim_ml.neural_network.layers.vector</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network"><code class="xref">manim_ml.neural_network.neural_network</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations"><code class="xref">manim_ml.neural_network.neural_network_transformations</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder"><code class="xref">manim_ml.neural_network.variational_autoencoder</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.html#module-manim_ml.one_to_one_sync"><code class="xref">manim_ml.one_to_one_sync</code></a></td><td>
<em></em></td>
</tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="manim_ml.html#module-manim_ml.probability"><code class="xref">manim_ml.probability</code></a></td><td>
<em></em></td>
</tr>
</table>
</article>

File diff suppressed because one or more lines are too long

228
docs/build/html/test.html vendored Normal file
View File

@ -0,0 +1,228 @@
<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>&lt;no title&gt; - ManimML documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">ManimML documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">ManimML documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
</article>
</div>
<footer>
<div class="related-pages">
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022, Alec Helbling
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer no-toc">
</aside>
</div>
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
</body>
</html>

View File

@ -0,0 +1,275 @@
<!doctype html>
<html class="no-js">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Visualizing Neural Networks with ManimML - ManimML documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">ManimML documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">ManimML documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="visualizing-neural-networks-with-manimml">
<h1>Visualizing Neural Networks with ManimML<a class="headerlink" href="#visualizing-neural-networks-with-manimml" title="Permalink to this headline">#</a></h1>
<p>This is a tutorial on how to make neural network architecture visualizations
and animate common algorithms like the forward pass of a neural network.
Neural networks are a ubiquitous class of machine learning techniques.
One of the primary usecases for ManimML is for generating animations of neural network architectures.
We have attempted to construct a simple API for defining neural network architectures
that should feel native to anyone who has used popular deep learning libraries like Pytorch, Tensorflow, and Keras.
Users can define a sequence of layers and we prove a system for automatically generating various
animations of concepts like a forward pass. We also allow the user to change the style of rendered
architectures and algorithm animations.</p>
<p>For this tutorial we assume that you have already followed the <a class="reference internal" href="getting_started.html"><span class="doc">Getting Started</span></a> tutorial.
This tutorial goes over several simple topics:</p>
<ol class="arabic simple">
<li><p>Generating a simple feed forward neural network diagram</p></li>
<li><p>Animating the forward pass of a feed forward neural network</p></li>
<li><p>Generating a diagram of a convolutional neural network</p></li>
<li><p>Modifying the default style of a neural network</p></li>
</ol>
<p>The topics of other tutorials will include:</p>
<ol class="arabic simple">
<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 headline">#</a></h2>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022, Alec Helbling
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
Contents
</span>
</div>
<div class="toc-tree-container">
<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>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
</body>
</html>

2
docs/deploy.sh Normal file
View File

@ -0,0 +1,2 @@
touch docs/build/html/.nojekyll
git subtree push --prefix docs/build/html origin gh-pages

View File

@ -0,0 +1,7 @@
Getting Started
===============
This tutorial shows you how to install ManimML and generate
your first machine learning animation.
Adding to

View File

@ -3,10 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ManimML's documentation!
===================================
Testing difference.
Welcome to ManimML's documentation! (Testing differences)
=========================================================
.. toctree::
:maxdepth: 2

View File

@ -0,0 +1,32 @@
Design Doc: Neural Network Rendering Pipeline
=============================================
=======
Neural Network Layer Scope and Mobject Ownership
=======
An important consideration when designing this pipeline
was to figure out a consistent design philosophy answering the
following questions:
1. What content is owned by an individual layer?
2. Does a layer describe an operation, a piece of data, or both?
=======
Constructing More Elaborate Animations
=======
Sometimes we want to construct custom animations that span more
than a single central layer and its two surrounding layers.
One possible solution to this is to allow for the passing
of neural networks into larger neural networks and treating them as layers.
This way a person can make a class that extends NeuralNetwork, which then
can implement its own forward pass animation, and then that neural network
can then be passed into a larger neural network and treated as its own
individual layer.
This may be a good workaround in certain situations, but this does not
solve the problem of allowing for multiple animations that each require
the context of multiple layers.

View File

@ -0,0 +1,47 @@
Visualizing Neural Networks with ManimML
========================================
This is a tutorial on how to make neural network architecture visualizations
and animate common algorithms like the forward pass of a neural network.
Neural networks are a ubiquitous class of machine learning techniques.
One of the primary usecases for ManimML is for generating animations of neural network architectures.
We have attempted to construct a simple API for defining neural network architectures
that should feel native to anyone who has used popular deep learning libraries like Pytorch, Tensorflow, and Keras.
User's can define a sequence of layers and we prove a system for automatically generating various
animations of concepts like a forward pass. We also allow the user to change the style of rendered
architectures and algorithm animations.
For this tutorial we assume that you have already followed the :doc:`Getting Started <getting_started>` tutorial.
This tutorial goes over several simple topics:
1. Generating a simple feed forward neural network diagram
2. Animating the forward pass of a feed forward neural network
3. Generating a diagram of a convolutional neural network
4. Modifying the default style of a neural network
The topics of other tutorials will include:
1. Creating custom neural network layers
2. Creating custom animations of neural networks
=========================================
Visualizing a Feed Forward Neural Network
=========================================
.. manim:: FeedForwardNetworkScene
from manim_ml.neural_network.neural_network import NeuralNetwork
from manim_ml.neural_network.layers import FeedForwardLayer
class FeedForwardNetworkScene(Scene):
def construct(self):
neural_network = NeuralNetwork([
FeedForwardLayer(3),
FeedForwardLayer(5),
FeedForwardLayer(2),
FeedForwardLayer(4)
])
self.add(neural_network)