Files
ManimML/docs/build/html/manim_ml.neural_network.layers.html
2022-04-29 10:58:06 -04:00

849 lines
117 KiB
HTML

<!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>manim_ml.neural_network.layers package - 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="manim-ml-neural-network-layers-package">
<h1>manim_ml.neural_network.layers package<a class="headerlink" href="#manim-ml-neural-network-layers-package" title="Permalink to this headline">#</a></h1>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</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="#">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>
</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>