opensource/ManimML
1
0
Fork 0
mirror of https://github.com/helblazer811/ManimML.git synced 2025-07-15 07:57:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

Started adding a documentation website using Sphinx

Browse Source
This commit is contained in:
Alec Helbling
2022-04-29 10:58:06 -04:00
parent 9310b48c56
commit 9d6edbc6d7
52 changed files with 19863 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

BIN
docs/build/.DS_Store vendored Normal file
View File

Binary file not shown.

BIN
docs/build/doctrees/environment.pickle vendored Normal file
View File

Binary file not shown.

BIN
docs/build/doctrees/index.doctree vendored Normal file
View File

Binary file not shown.

BIN
docs/build/doctrees/manim_ml.doctree vendored Normal file
View File

Binary file not shown.

BIN
docs/build/doctrees/manim_ml.neural_network.doctree vendored Normal file
View File

Binary file not shown.

BIN
docs/build/doctrees/manim_ml.neural_network.layers.doctree vendored Normal file
View File

Binary file not shown.

BIN
docs/build/doctrees/modules.doctree vendored Normal file
View File

Binary file not shown.

4
docs/build/html/.buildinfo vendored Normal file
View File

@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4edc023178703a398a562c8ec3b1ae42
tags: 645f666f9bcd5a90fca523b33c5a78b7

20
docs/build/html/_sources/index.rst.txt vendored Normal file
View File

@ -0,0 +1,20 @@
.. ManimML documentation master file, created by
sphinx-quickstart on Fri Apr 29 10:47:48 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ManimML's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

157
docs/build/html/_sources/manim_ml.neural_network.layers.rst.txt vendored Normal file
View File

@ -0,0 +1,157 @@
manim\_ml.neural\_network.layers package
========================================
Submodules
----------
manim\_ml.neural\_network.layers.convolutional module
-----------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.convolutional
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.convolutional\_to\_convolutional module
------------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.convolutional_to_convolutional
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.embedding module
-------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.embedding
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.embedding\_to\_feed\_forward module
--------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.embedding_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward module
-----------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_embedding module
--------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_embedding
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_feed\_forward module
------------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_image module
----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_image
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_vector module
-----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_vector
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.image module
---------------------------------------------
.. automodule:: manim_ml.neural_network.layers.image
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.image\_to\_feed\_forward module
----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.image_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.paired\_query module
-----------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.paired_query
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.paired\_query\_to\_feed\_forward module
------------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.paired_query_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.parent\_layers module
------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.parent_layers
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.triplet module
-----------------------------------------------
.. automodule:: manim_ml.neural_network.layers.triplet
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.triplet\_to\_feed\_forward module
------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.triplet_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.util module
--------------------------------------------
.. automodule:: manim_ml.neural_network.layers.util
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.vector module
----------------------------------------------
.. automodule:: manim_ml.neural_network.layers.vector
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: manim_ml.neural_network.layers
:members:
:undoc-members:
:show-inheritance:

45
docs/build/html/_sources/manim_ml.neural_network.rst.txt vendored Normal file
View File

@ -0,0 +1,45 @@
manim\_ml.neural\_network package
=================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
manim_ml.neural_network.layers
Submodules
----------
manim\_ml.neural\_network.neural\_network module
------------------------------------------------
.. automodule:: manim_ml.neural_network.neural_network
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.neural\_network\_transformations module
-----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.neural_network_transformations
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.variational\_autoencoder module
---------------------------------------------------------
.. automodule:: manim_ml.neural_network.variational_autoencoder
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: manim_ml.neural_network
:members:
:undoc-members:
:show-inheritance:

61
docs/build/html/_sources/manim_ml.rst.txt vendored Normal file
View File

@ -0,0 +1,61 @@
manim\_ml package
=================
Subpackages
-----------
.. toctree::
:maxdepth: 4
manim_ml.neural_network
Submodules
----------
manim\_ml.image module
----------------------
.. automodule:: manim_ml.image
:members:
:undoc-members:
:show-inheritance:
manim\_ml.list\_group module
----------------------------
.. automodule:: manim_ml.list_group
:members:
:undoc-members:
:show-inheritance:
manim\_ml.manifold module
-------------------------
.. automodule:: manim_ml.manifold
:members:
:undoc-members:
:show-inheritance:
manim\_ml.one\_to\_one\_sync module
-----------------------------------
.. automodule:: manim_ml.one_to_one_sync
:members:
:undoc-members:
:show-inheritance:
manim\_ml.probability module
----------------------------
.. automodule:: manim_ml.probability
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: manim_ml
:members:
:undoc-members:
:show-inheritance:

7
docs/build/html/_sources/modules.rst.txt vendored Normal file
View File

@ -0,0 +1,7 @@
manim_ml
========
.. toctree::
:maxdepth: 4
manim_ml

906
docs/build/html/_static/basic.css vendored Normal file
View File

@ -0,0 +1,906 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
div.section::after {
display: block;
content: '';
clear: left;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li p.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, figure.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, figure.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, figure.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, figure.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar,
aside.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}
p.sidebar-title {
font-weight: bold;
}
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
aside.sidebar > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
aside.sidebar::after,
div.topic::after,
div.admonition::after,
blockquote::after {
display: block;
content: '';
clear: both;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
margin-top: 10px;
margin-bottom: 10px;
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > :first-child,
td > :first-child {
margin-top: 0px;
}
th > :last-child,
td > :last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure, figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption, figcaption {
padding: 0.3em;
}
div.figure p.caption span.caption-number,
figcaption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text,
figcaption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist {
margin: 1em 0;
}
table.hlist td {
vertical-align: top;
}
/* -- object description styles --------------------------------------------- */
.sig {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
}
.sig-name, code.descname {
background-color: transparent;
font-weight: bold;
}
.sig-name {
font-size: 1.1em;
}
code.descname {
font-size: 1.2em;
}
.sig-prename, code.descclassname {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.sig-param.n {
font-style: italic;
}
/* C++ specific styling */
.sig-inline.c-texpr,
.sig-inline.cpp-texpr {
font-family: unset;
}
.sig.c .k, .sig.c .kt,
.sig.cpp .k, .sig.cpp .kt {
color: #0033B3;
}
.sig.c .m,
.sig.cpp .m {
color: #1750EB;
}
.sig.c .s, .sig.c .sc,
.sig.cpp .s, .sig.cpp .sc {
color: #067D17;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
:not(li) > ol > li:first-child > :first-child,
:not(li) > ul > li:first-child > :first-child {
margin-top: 0px;
}
:not(li) > ol > li:last-child > :last-child,
:not(li) > ul > li:last-child > :last-child {
margin-bottom: 0px;
}
ol.simple ol p,
ol.simple ul p,
ul.simple ol p,
ul.simple ul p {
margin-top: 0;
}
ol.simple > li:not(:first-child) > p,
ul.simple > li:not(:first-child) > p {
margin-top: 0;
}
ol.simple p,
ul.simple p {
margin-bottom: 0;
}
dl.footnote > dt,
dl.citation > dt {
float: left;
margin-right: 0.5em;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > :first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0 0.5em;
content: ":";
display: inline-block;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
pre, div[class*="highlight-"] {
clear: both;
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}
div[class*="highlight-"] {
margin: 1em 0;
}
td.linenos pre {
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
display: block;
}
table.highlighttable tbody {
display: block;
}
table.highlighttable tr {
display: flex;
}
table.highlighttable td {
margin: 0;
padding: 0;
}
table.highlighttable td.linenos {
padding-right: 0.5em;
}
table.highlighttable td.code {
flex: 1;
overflow: hidden;
}
.highlight .hll {
display: block;
}
div.highlight pre,
table.highlighttable pre {
margin: 0;
}
div.code-block-caption + div {
margin-top: 0;
}
div.code-block-caption {
margin-top: 1em;
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
-moz-user-select: none; /* Firefox */
-ms-user-select: none; /* IE10+ */
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
margin: 1em 0;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: absolute;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

358
docs/build/html/_static/doctools.js vendored Normal file
View File

@ -0,0 +1,358 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
this.initOnKeyListeners();
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
return string;
return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
if (!body.length) {
body = $('body');
}
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
var url = new URL(window.location);
url.searchParams.delete('highlight');
window.history.replaceState({}, '', url);
},
/**
* helper function to focus on search bar
*/
focusSearchBar : function() {
$('input[name=q]').first().focus();
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this === '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
return;
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& activeElementType !== 'BUTTON') {
if (event.altKey || event.ctrlKey || event.metaKey)
return;
if (!event.shiftKey) {
switch (event.key) {
case 'ArrowLeft':
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
break;
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
break;
case 'ArrowRight':
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
break;
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
case 'Escape':
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
break;
Documentation.hideSearchWords();
return false;
}
}
// some keyboard layouts may need Shift to get /
switch (event.key) {
case '/':
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
break;
Documentation.focusSearchBar();
return false;
}
}
});
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

14
docs/build/html/_static/documentation_options.js vendored Normal file
View File

@ -0,0 +1,14 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
};

BIN
docs/build/html/_static/file.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 286 B

10872
docs/build/html/_static/jquery-3.5.1.js vendored Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/build/html/_static/jquery.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

297
docs/build/html/_static/language_data.js vendored Normal file
View File

@ -0,0 +1,297 @@
/*
* language_data.js
* ~~~~~~~~~~~~~~~~
*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
/* Non-minified version is copied as a separate JS file, is available */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}

BIN
docs/build/html/_static/minus.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 90 B

BIN
docs/build/html/_static/plus.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 90 B

252
docs/build/html/_static/pygments.css vendored Normal file
View File

@ -0,0 +1,252 @@
.highlight pre { line-height: 125%; }
.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #8f5902; font-style: italic } /* Comment */
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
.highlight .g { color: #000000 } /* Generic */
.highlight .k { color: #204a87; font-weight: bold } /* Keyword */
.highlight .l { color: #000000 } /* Literal */
.highlight .n { color: #000000 } /* Name */
.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */
.highlight .x { color: #000000 } /* Other */
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
.highlight .gd { color: #a40000 } /* Generic.Deleted */
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
.highlight .gr { color: #ef2929 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #000000; font-style: italic } /* Generic.Output */
.highlight .gp { color: #8f5902 } /* Generic.Prompt */
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */
.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */
.highlight .ld { color: #000000 } /* Literal.Date */
.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */
.highlight .s { color: #4e9a06 } /* Literal.String */
.highlight .na { color: #c4a000 } /* Name.Attribute */
.highlight .nb { color: #204a87 } /* Name.Builtin */
.highlight .nc { color: #000000 } /* Name.Class */
.highlight .no { color: #000000 } /* Name.Constant */
.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #ce5c00 } /* Name.Entity */
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #000000 } /* Name.Function */
.highlight .nl { color: #f57900 } /* Name.Label */
.highlight .nn { color: #000000 } /* Name.Namespace */
.highlight .nx { color: #000000 } /* Name.Other */
.highlight .py { color: #000000 } /* Name.Property */
.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #000000 } /* Name.Variable */
.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #000000 } /* Name.Function.Magic */
.highlight .vc { color: #000000 } /* Name.Variable.Class */
.highlight .vg { color: #000000 } /* Name.Variable.Global */
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */
@media not print {
body[data-theme="dark"] .highlight pre { line-height: 125%; }
body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
body[data-theme="dark"] .highlight .hll { background-color: #404040 }
body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 }
body[data-theme="dark"] .highlight .c { color: #999999; font-style: italic } /* Comment */
body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */
body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */
body[data-theme="dark"] .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */
body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */
body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */
body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */
body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */
body[data-theme="dark"] .highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
body[data-theme="dark"] .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
body[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
body[data-theme="dark"] .highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
body[data-theme="dark"] .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */
body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */
body[data-theme="dark"] .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
body[data-theme="dark"] .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
body[data-theme="dark"] .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
body[data-theme="dark"] .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
body[data-theme="dark"] .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
body[data-theme="dark"] .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */
body[data-theme="dark"] .highlight .m { color: #3677a9 } /* Literal.Number */
body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */
body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */
body[data-theme="dark"] .highlight .nb { color: #24909d } /* Name.Builtin */
body[data-theme="dark"] .highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */
body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */
body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */
body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */
body[data-theme="dark"] .highlight .nf { color: #447fcf } /* Name.Function */
body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */
body[data-theme="dark"] .highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */
body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */
body[data-theme="dark"] .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */
body[data-theme="dark"] .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */
body[data-theme="dark"] .highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
body[data-theme="dark"] .highlight .mf { color: #3677a9 } /* Literal.Number.Float */
body[data-theme="dark"] .highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
body[data-theme="dark"] .highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
body[data-theme="dark"] .highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */
body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */
body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */
body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */
body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */
body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */
body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */
body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */
body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
body[data-theme="dark"] .highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
body[data-theme="dark"] .highlight .fm { color: #447fcf } /* Name.Function.Magic */
body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */
body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */
body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */
body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */
body[data-theme="dark"] .highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) .highlight pre { line-height: 125%; }
body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
body:not([data-theme="light"]) .highlight .hll { background-color: #404040 }
body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 }
body:not([data-theme="light"]) .highlight .c { color: #999999; font-style: italic } /* Comment */
body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */
body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */
body:not([data-theme="light"]) .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */
body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */
body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */
body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */
body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */
body:not([data-theme="light"]) .highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
body:not([data-theme="light"]) .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
body:not([data-theme="light"]) .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
body:not([data-theme="light"]) .highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
body:not([data-theme="light"]) .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */
body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */
body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */
body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */
body:not([data-theme="light"]) .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
body:not([data-theme="light"]) .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
body:not([data-theme="light"]) .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
body:not([data-theme="light"]) .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
body:not([data-theme="light"]) .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
body:not([data-theme="light"]) .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */
body:not([data-theme="light"]) .highlight .m { color: #3677a9 } /* Literal.Number */
body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */
body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */
body:not([data-theme="light"]) .highlight .nb { color: #24909d } /* Name.Builtin */
body:not([data-theme="light"]) .highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */
body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */
body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */
body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */
body:not([data-theme="light"]) .highlight .nf { color: #447fcf } /* Name.Function */
body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */
body:not([data-theme="light"]) .highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */
body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */
body:not([data-theme="light"]) .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */
body:not([data-theme="light"]) .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */
body:not([data-theme="light"]) .highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
body:not([data-theme="light"]) .highlight .mf { color: #3677a9 } /* Literal.Number.Float */
body:not([data-theme="light"]) .highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
body:not([data-theme="light"]) .highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
body:not([data-theme="light"]) .highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */
body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */
body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */
body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */
body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */
body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */
body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */
body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */
body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
body:not([data-theme="light"]) .highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
body:not([data-theme="light"]) .highlight .fm { color: #447fcf } /* Name.Function.Magic */
body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */
body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */
body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */
body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */
body:not([data-theme="light"]) .highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
}
}

0
docs/build/html/_static/scripts/furo-extensions.js vendored Normal file
View File

3
docs/build/html/_static/scripts/furo.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

7
docs/build/html/_static/scripts/furo.js.LICENSE.txt vendored Normal file
View File

@ -0,0 +1,7 @@
/*!
* gumshoejs v5.1.2 (patched by @pradyunsg)
* A simple, framework-agnostic scrollspy script.
* (c) 2019 Chris Ferdinandi
* MIT License
* http://github.com/cferdinandi/gumshoe
*/

1
docs/build/html/_static/scripts/furo.js.map vendored Normal file
View File

File diff suppressed because one or more lines are too long

525
docs/build/html/_static/searchtools.js vendored Normal file
View File

@ -0,0 +1,525 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
if (!Scorer) {
/**
* Simple result scoring code.
*/
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [filename, title, anchor, descr, score]
// and returns the new score.
/*
score: function(result) {
return result[4];
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5}, // used to be unimportantResults
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2
};
}
if (!splitQuery) {
function splitQuery(query) {
return query.split(/\s+/);
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
htmlToText : function(htmlString) {
var virtualDocument = document.implementation.createHTMLDocument('virtual');
var htmlElement = $(htmlString, virtualDocument);
htmlElement.find('.headerlink').remove();
docContent = htmlElement.find('[role=main]')[0];
if(docContent === undefined) {
console.warn("Content block not found. Sphinx search tries to obtain it " +
"via '[role=main]'. Could you check your theme or template.");
return "";
}
return docContent.textContent || docContent.innerText;
},
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[name="q"]')[0].value = query;
this.performSearch(query);
}
},
loadIndex : function(url) {
$.ajax({type: "GET", url: url, data: null,
dataType: "script", cache: true,
complete: function(jqxhr, textstatus) {
if (textstatus != "success") {
document.getElementById("searchindexloader").src = url;
}
}});
},
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
var i;
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
}
pulse();
},
/**
* perform a search for something (or wait until index is loaded)
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
/**
* execute search (requires search index to be loaded)
*/
query : function(query) {
var i;
// stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = splitQuery(query);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
objectterms.push(tmp[i].toLowerCase());
}
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
var toAppend;
// select the correct list
if (word[0] == '-') {
toAppend = excluded;
word = word.substr(1);
}
else {
toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$u.contains(toAppend, word))
toAppend.push(word);
}
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var terms = this._index.terms;
var titleterms = this._index.titleterms;
// array of [filename, title, anchor, descr, score]
var results = [];
$('#search-progress').empty();
// lookup as object
for (i = 0; i < objectterms.length; i++) {
var others = [].concat(objectterms.slice(0, i),
objectterms.slice(i+1, objectterms.length));
results = results.concat(this.performObjectSearch(objectterms[i], others));
}
// lookup as search terms in fulltext
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
for (i = 0; i < results.length; i++)
results[i][4] = Scorer.score(results[i]);
}
// now sort the results by score (in opposite order of appearance, since the
// display function below uses pop() to retrieve items) and then
// alphabetically
results.sort(function(a, b) {
var left = a[4];
var right = b[4];
if (left > right) {
return 1;
} else if (left < right) {
return -1;
} else {
// same score: sort alphabetically
left = a[1].toLowerCase();
right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
}
});
// for debugging
//Search.lastresults = results.slice(); // a copy
//console.info('search results:', Search.lastresults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li></li>');
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
}
listItem.append($('<a/>').attr('href',
linkUrl +
highlightstring + item[2]).html(item[1]));
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
} else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) {
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
var summary = Search.makeSearchSummary(data, searchterms, hlterms);
if (summary) {
listItem.append(summary);
}
}
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
}});
} else {
// just display title
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
},
/**
* search for object names
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
var docnames = this._index.docnames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
var i;
var results = [];
for (var prefix in objects) {
for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
var match = objects[prefix][iMatch];
var name = match[4];
var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
var score = 0;
var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
if (otherterms.length > 0) {
var haystack = (prefix + ' ' + name + ' ' +
objname + ' ' + title).toLowerCase();
var allfound = true;
for (i = 0; i < otherterms.length; i++) {
if (haystack.indexOf(otherterms[i]) == -1) {
allfound = false;
break;
}
}
if (!allfound) {
continue;
}
}
var descr = objname + _(', in ') + title;
var anchor = match[3];
if (anchor === '')
anchor = fullname;
else if (anchor == '-')
anchor = objnames[match[1]][1] + '-' + fullname;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2])) {
score += Scorer.objPrio[match[2]];
} else {
score += Scorer.objPrioDefault;
}
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
}
}
}
return results;
},
/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
*/
escapeRegExp : function(string) {
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
},
/**
* search for full-text terms in the index
*/
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
var docnames = this._index.docnames;
var filenames = this._index.filenames;
var titles = this._index.titles;
var i, j, file;
var fileMap = {};
var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
var files = [];
var _o = [
{files: terms[word], score: Scorer.term},
{files: titleterms[word], score: Scorer.title}
];
// add support for partial matches
if (word.length > 2) {
var word_regex = this.escapeRegExp(word);
for (var w in terms) {
if (w.match(word_regex) && !terms[word]) {
_o.push({files: terms[w], score: Scorer.partialTerm})
}
}
for (var w in titleterms) {
if (w.match(word_regex) && !titleterms[word]) {
_o.push({files: titleterms[w], score: Scorer.partialTitle})
}
}
}
// no match but word was a required one
if ($u.every(_o, function(o){return o.files === undefined;})) {
break;
}
// found search word in contents
$u.each(_o, function(o) {
var _files = o.files;
if (_files === undefined)
return
if (_files.length === undefined)
_files = [_files];
files = files.concat(_files);
// set score for the word in each file to Scorer.term
for (j = 0; j < _files.length; j++) {
file = _files[j];
if (!(file in scoreMap))
scoreMap[file] = {};
scoreMap[file][word] = o.score;
}
});
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap && fileMap[file].indexOf(word) === -1)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (file in fileMap) {
var valid = true;
// check if all requirements are matched
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
searchterms.filter(function(term){return term.length > 2}).length
if (
fileMap[file].length != searchterms.length &&
fileMap[file].length != filteredTermCount
) continue;
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
titleterms[excluded[i]] == file ||
$u.contains(terms[excluded[i]] || [], file) ||
$u.contains(titleterms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it to the result list
if (valid) {
// select one (max) score for the file.
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
}
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
if (text == "") {
return null;
}
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<p class="context"></p>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
};
$(document).ready(function() {
Search.init();
});

2
docs/build/html/_static/styles/furo-extensions.css vendored Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/build/html/_static/styles/furo-extensions.css.map vendored Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/build/html/_static/styles/furo.css vendored Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/build/html/_static/styles/furo.css.map vendored Normal file
View File

File diff suppressed because one or more lines are too long

2042
docs/build/html/_static/underscore-1.13.1.js vendored Normal file
View File

File diff suppressed because it is too large Load Diff

6
docs/build/html/_static/underscore.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

977
docs/build/html/genindex.html vendored Normal file
View File

@ -0,0 +1,977 @@
<!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"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/><title>Index - ManimML documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">ManimML documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">ManimML documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section class="genindex-section">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a></div>
</section>
<section id="A" class="genindex-section">
<h2>A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.add">add() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.add_gaussian_distribution">add_gaussian_distribution() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject.animation_overrides">animation_overrides (manim_ml.image.GrayscaleImageMobject attribute)</a>
<ul>
<li><a href="manim_ml.html#manim_ml.image.LabeledColorImage.animation_overrides">(manim_ml.image.LabeledColorImage attribute)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.animation_overrides">(manim_ml.list_group.ListGroup attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.animation_overrides">(manim_ml.neural_network.layers.convolutional.ConvolutionalLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.animation_overrides">(manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.animation_overrides">(manim_ml.neural_network.layers.embedding.EmbeddingLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.animation_overrides">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.animation_overrides">(manim_ml.neural_network.layers.feed_forward.FeedForwardLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.animation_overrides">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.animation_overrides">(manim_ml.neural_network.layers.image.ImageLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.animation_overrides">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.animation_overrides">(manim_ml.neural_network.layers.paired_query.PairedQueryLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.animation_overrides">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.BlankConnective.animation_overrides">(manim_ml.neural_network.layers.parent_layers.BlankConnective attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.animation_overrides">(manim_ml.neural_network.layers.parent_layers.ConnectiveLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.animation_overrides">(manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.animation_overrides">(manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.animation_overrides">(manim_ml.neural_network.layers.triplet.TripletLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.animation_overrides">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer.animation_overrides">(manim_ml.neural_network.layers.vector.VectorLayer attribute)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork.animation_overrides">(manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork attribute)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.animation_overrides">(manim_ml.neural_network.neural_network.NeuralNetwork attribute)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.animation_overrides">(manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder attribute)</a>
</li>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.animation_overrides">(manim_ml.probability.GaussianDistribution attribute)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="B" class="genindex-section">
<h2>B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.BlankConnective">BlankConnective (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="C" class="genindex-section">
<h2>C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.compute_covariance_rotation_and_scale">compute_covariance_rotation_and_scale() (manim_ml.probability.GaussianDistribution method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer">ConnectiveLayer (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene.construct">construct() (manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.construct_edges">construct_edges() (manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.construct_gaussian_distribution">construct_gaussian_distribution() (manim_ml.probability.GaussianDistribution method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.construct_gaussian_point_cloud">construct_gaussian_point_cloud() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution.construct_simple_gaussian_ellipse">construct_simple_gaussian_ellipse() (manim_ml.probability.GaussianDistribution method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer">ConvolutionalLayer (class in manim_ml.neural_network.layers.convolutional)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional">ConvolutionalToConvolutional (class in manim_ml.neural_network.layers.convolutional_to_convolutional)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject.create">create() (manim_ml.image.GrayscaleImageMobject method)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="E" class="genindex-section">
<h2>E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer">EmbeddingLayer (class in manim_ml.neural_network.layers.embedding)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward">EmbeddingToFeedForward (class in manim_ml.neural_network.layers.embedding_to_feed_forward)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="F" class="genindex-section">
<h2>F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer">FeedForwardLayer (class in manim_ml.neural_network.layers.feed_forward)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.FeedForwardNeuralNetwork">FeedForwardNeuralNetwork (class in manim_ml.neural_network.neural_network)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding">FeedForwardToEmbedding (class in manim_ml.neural_network.layers.feed_forward_to_embedding)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward">FeedForwardToFeedForward (class in manim_ml.neural_network.layers.feed_forward_to_feed_forward)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage">FeedForwardToImage (class in manim_ml.neural_network.layers.feed_forward_to_image)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector">FeedForwardToVector (class in manim_ml.neural_network.layers.feed_forward_to_vector)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject.from_path">from_path() (manim_ml.image.GrayscaleImageMobject class method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.from_path">(manim_ml.neural_network.layers.image.ImageLayer class method)</a>
</li>
</ul></li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.from_paths">from_paths() (manim_ml.neural_network.layers.paired_query.PairedQueryLayer class method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.from_paths">(manim_ml.neural_network.layers.triplet.TripletLayer class method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="G" class="genindex-section">
<h2>G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.probability.GaussianDistribution">GaussianDistribution (class in manim_ml.probability)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.get">get() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.util.get_connective_layer">get_connective_layer() (in module manim_ml.neural_network.layers.util)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.get_connective_layer_widths">get_connective_layer_widths() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.get_connective_layers">get_connective_layers() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.get_distribution_location">get_distribution_location() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.get_right">get_right() (manim_ml.neural_network.layers.image.ImageLayer method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.image.GrayscaleImageMobject">GrayscaleImageMobject (class in manim_ml.image)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="H" class="genindex-section">
<h2>H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.height">height (manim_ml.neural_network.layers.image.ImageLayer property)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="I" class="genindex-section">
<h2>I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer">ImageLayer (class in manim_ml.neural_network.layers.image)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward">ImageToFeedForward (class in manim_ml.neural_network.layers.image_to_feed_forward)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.index_of">index_of() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.input_class">input_class (manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional attribute)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.input_class">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.input_class">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.input_class">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.input_class">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.input_class">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.input_class">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.input_class">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.input_class">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.insert">insert() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.insert_layer">insert_layer() (manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer">InsertLayer (class in manim_ml.neural_network.neural_network_transformations)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="L" class="genindex-section">
<h2>L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.image.LabeledColorImage">LabeledColorImage (class in manim_ml.image)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup">ListGroup (class in manim_ml.list_group)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="M" class="genindex-section">
<h2>M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_assets">make_assets() (manim_ml.neural_network.layers.paired_query.PairedQueryLayer method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.make_assets">(manim_ml.neural_network.layers.triplet.TripletLayer method)</a>
</li>
</ul></li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_connective_layers_animation">make_create_connective_layers_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_create_layer_animation">make_create_layer_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_filter_corner_lines">make_filter_corner_lines() (manim_ml.neural_network.layers.convolutional.ConvolutionalLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional.ConvolutionalLayer.make_forward_pass_animation">make_forward_pass_animation() (manim_ml.neural_network.layers.convolutional.ConvolutionalLayer method)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_forward_pass_animation">(manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward.FeedForwardLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward.FeedForwardLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.make_forward_pass_animation">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.image.ImageLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.paired_query.PairedQueryLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.BlankConnective.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.BlankConnective method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.ConnectiveLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.ConnectiveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.triplet.TripletLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.make_forward_pass_animation">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer.make_forward_pass_animation">(manim_ml.neural_network.layers.vector.VectorLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.make_forward_pass_animation">(manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
</ul></li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_image_forward_pass">make_image_forward_pass() (manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.make_lines">make_lines() (manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_move_animation">make_move_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.make_move_layers_animation">make_move_layers_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_new_connective_animation">make_new_connective_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_animation">make_remove_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_connective_layers_animation">make_remove_connective_layers_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer.make_remove_layer_animation">make_remove_layer_animation() (manim_ml.neural_network.neural_network_transformations.RemoveLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder.make_triplet_forward_pass">make_triplet_forward_pass() (manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder method)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer.make_vector">make_vector() (manim_ml.neural_network.layers.vector.VectorLayer method)</a>
</li>
<li>
manim_ml
<ul>
<li><a href="manim_ml.html#module-manim_ml">module</a>
</li>
</ul></li>
<li>
manim_ml.image
<ul>
<li><a href="manim_ml.html#module-manim_ml.image">module</a>
</li>
</ul></li>
<li>
manim_ml.list_group
<ul>
<li><a href="manim_ml.html#module-manim_ml.list_group">module</a>
</li>
</ul></li>
<li>
manim_ml.manifold
<ul>
<li><a href="manim_ml.html#module-manim_ml.manifold">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.convolutional
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.convolutional_to_convolutional
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.embedding
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.embedding_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward_to_embedding
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
manim_ml.neural_network.layers.feed_forward_to_image
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.feed_forward_to_vector
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.image
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.image_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.paired_query
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.paired_query_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.parent_layers
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.triplet
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.triplet_to_feed_forward
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.util
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.layers.vector
<ul>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.neural_network
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.neural_network_transformations
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">module</a>
</li>
</ul></li>
<li>
manim_ml.neural_network.variational_autoencoder
<ul>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">module</a>
</li>
</ul></li>
<li>
manim_ml.one_to_one_sync
<ul>
<li><a href="manim_ml.html#module-manim_ml.one_to_one_sync">module</a>
</li>
</ul></li>
<li>
manim_ml.probability
<ul>
<li><a href="manim_ml.html#module-manim_ml.probability">module</a>
</li>
</ul></li>
<li>
module
<ul>
<li><a href="manim_ml.html#module-manim_ml">manim_ml</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.image">manim_ml.image</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.list_group">manim_ml.list_group</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.manifold">manim_ml.manifold</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network">manim_ml.neural_network</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">manim_ml.neural_network.layers</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">manim_ml.neural_network.layers.convolutional</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">manim_ml.neural_network.layers.convolutional_to_convolutional</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">manim_ml.neural_network.layers.embedding</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">manim_ml.neural_network.layers.embedding_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">manim_ml.neural_network.layers.feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">manim_ml.neural_network.layers.feed_forward_to_embedding</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">manim_ml.neural_network.layers.feed_forward_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">manim_ml.neural_network.layers.feed_forward_to_image</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">manim_ml.neural_network.layers.feed_forward_to_vector</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">manim_ml.neural_network.layers.image</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">manim_ml.neural_network.layers.image_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">manim_ml.neural_network.layers.paired_query</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">manim_ml.neural_network.layers.paired_query_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">manim_ml.neural_network.layers.parent_layers</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">manim_ml.neural_network.layers.triplet</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">manim_ml.neural_network.layers.triplet_to_feed_forward</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">manim_ml.neural_network.layers.util</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">manim_ml.neural_network.layers.vector</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">manim_ml.neural_network.neural_network</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">manim_ml.neural_network.neural_network_transformations</a>
</li>
<li><a href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">manim_ml.neural_network.variational_autoencoder</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.one_to_one_sync">manim_ml.one_to_one_sync</a>
</li>
<li><a href="manim_ml.html#module-manim_ml.probability">manim_ml.probability</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="N" class="genindex-section">
<h2>N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork">NeuralNetwork (class in manim_ml.neural_network.neural_network)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.NeuralNetworkEmbeddingTestScene">NeuralNetworkEmbeddingTestScene (class in manim_ml.neural_network.layers.embedding)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.NeuralNetworkLayer">NeuralNetworkLayer (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="O" class="genindex-section">
<h2>O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.one_to_one_sync.OneToOneSync">OneToOneSync (class in manim_ml.one_to_one_sync)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional.output_class">output_class (manim_ml.neural_network.layers.convolutional_to_convolutional.ConvolutionalToConvolutional attribute)</a>
<ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward.output_class">(manim_ml.neural_network.layers.embedding_to_feed_forward.EmbeddingToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding.output_class">(manim_ml.neural_network.layers.feed_forward_to_embedding.FeedForwardToEmbedding attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward.output_class">(manim_ml.neural_network.layers.feed_forward_to_feed_forward.FeedForwardToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage.output_class">(manim_ml.neural_network.layers.feed_forward_to_image.FeedForwardToImage attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector.output_class">(manim_ml.neural_network.layers.feed_forward_to_vector.FeedForwardToVector attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward.output_class">(manim_ml.neural_network.layers.image_to_feed_forward.ImageToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward.output_class">(manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward attribute)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward.output_class">(manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward attribute)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="P" class="genindex-section">
<h2>P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query.PairedQueryLayer">PairedQueryLayer (class in manim_ml.neural_network.layers.paired_query)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.paired_query_to_feed_forward.PairedQueryToFeedForward">PairedQueryToFeedForward (class in manim_ml.neural_network.layers.paired_query_to_feed_forward)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="R" class="genindex-section">
<h2>R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.remove">remove() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.remove_at_index">remove_at_index() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.remove_at_indices">remove_at_indices() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.InsertLayer.remove_connective_layer_animation">remove_connective_layer_animation() (manim_ml.neural_network.neural_network_transformations.InsertLayer method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.remove_gaussian_distribution">remove_gaussian_distribution() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.remove_layer">remove_layer() (manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network_transformations.RemoveLayer">RemoveLayer (class in manim_ml.neural_network.neural_network_transformations)</a>
</li>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.replace">replace() (manim_ml.list_group.ListGroup method)</a>
</li>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.replace_layer">replace_layer() (manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="S" class="genindex-section">
<h2>S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.embedding.EmbeddingLayer.sample_point_location_from_distribution">sample_point_location_from_distribution() (manim_ml.neural_network.layers.embedding.EmbeddingLayer method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.html#manim_ml.list_group.ListGroup.set_z_index">set_z_index() (manim_ml.list_group.ListGroup method)</a>
<ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.neural_network.NeuralNetwork.set_z_index">(manim_ml.neural_network.neural_network.NeuralNetwork method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</section>
<section id="T" class="genindex-section">
<h2>T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet.TripletLayer">TripletLayer (class in manim_ml.neural_network.layers.triplet)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.triplet_to_feed_forward.TripletToFeedForward">TripletToFeedForward (class in manim_ml.neural_network.layers.triplet_to_feed_forward)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="V" class="genindex-section">
<h2>V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.html#manim_ml.neural_network.variational_autoencoder.VariationalAutoencoder">VariationalAutoencoder (class in manim_ml.neural_network.variational_autoencoder)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.vector.VectorLayer">VectorLayer (class in manim_ml.neural_network.layers.vector)</a>
</li>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.parent_layers.VGroupNeuralNetworkLayer">VGroupNeuralNetworkLayer (class in manim_ml.neural_network.layers.parent_layers)</a>
</li>
</ul></td>
</tr></table>
</section>
<section id="W" class="genindex-section">
<h2>W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manim_ml.neural_network.layers.html#manim_ml.neural_network.layers.image.ImageLayer.width">width (manim_ml.neural_network.layers.image.ImageLayer property)</a>
</li>
</ul></td>
</tr></table>
</section>
</article>
</div>
<footer>
<div class="related-pages">
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022, Alec Helbling
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer no-toc">
</aside>
</div>
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
</body>
</html>

258
docs/build/html/index.html vendored Normal file
View File

@ -0,0 +1,258 @@
<!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>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="#"><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="#">
<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="welcome-to-manimml-s-documentation">
<h1>Welcome to ManimML’s documentation!<a class="headerlink" href="#welcome-to-manimml-s-documentation" title="Permalink to this headline">#</a></h1>
<div class="toctree-wrapper compound">
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">#</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</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="#">Welcome to ManimML’s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></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>

438
docs/build/html/manim_ml.html vendored Normal file
View File

@ -0,0 +1,438 @@
<!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 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-package">
<h1>manim_ml package<a class="headerlink" href="#manim-ml-package" title="Permalink to this headline">#</a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="manim_ml.neural_network.html">manim_ml.neural_network package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="manim_ml.neural_network.layers.html">manim_ml.neural_network.layers package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional">manim_ml.neural_network.layers.convolutional module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.convolutional_to_convolutional">manim_ml.neural_network.layers.convolutional_to_convolutional module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding">manim_ml.neural_network.layers.embedding module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.embedding_to_feed_forward">manim_ml.neural_network.layers.embedding_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward">manim_ml.neural_network.layers.feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_embedding">manim_ml.neural_network.layers.feed_forward_to_embedding module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_feed_forward">manim_ml.neural_network.layers.feed_forward_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_image">manim_ml.neural_network.layers.feed_forward_to_image module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.feed_forward_to_vector">manim_ml.neural_network.layers.feed_forward_to_vector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image">manim_ml.neural_network.layers.image module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.image_to_feed_forward">manim_ml.neural_network.layers.image_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query">manim_ml.neural_network.layers.paired_query module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.paired_query_to_feed_forward">manim_ml.neural_network.layers.paired_query_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.parent_layers">manim_ml.neural_network.layers.parent_layers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet">manim_ml.neural_network.layers.triplet module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.triplet_to_feed_forward">manim_ml.neural_network.layers.triplet_to_feed_forward module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.util">manim_ml.neural_network.layers.util module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers.vector">manim_ml.neural_network.layers.vector module</a></li>
<li class="toctree-l4"><a class="reference internal" href="manim_ml.neural_network.layers.html#module-manim_ml.neural_network.layers">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network">manim_ml.neural_network.neural_network module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.neural_network_transformations">manim_ml.neural_network.neural_network_transformations module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network.variational_autoencoder">manim_ml.neural_network.variational_autoencoder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="manim_ml.neural_network.html#module-manim_ml.neural_network">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">#</a></h2>
</section>
<section id="module-manim_ml.image">
<span id="manim-ml-image-module"></span><h2>manim_ml.image module<a class="headerlink" href="#module-manim_ml.image" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.image.</span></span><span class="sig-name descname"><span class="pre">GrayscaleImageMobject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">numpy_image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.types.image_mobject.ImageMobject</span></code></p>
<p>Mobject for creating images in Manim from numpy arrays</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'manim.animation.creation.Create'&gt;:</span> <span class="pre">&lt;function</span> <span class="pre">GrayscaleImageMobject.create&gt;}</span></em><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject.create" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.image.GrayscaleImageMobject.from_path">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.GrayscaleImageMobject.from_path" title="Permalink to this definition">#</a></dt>
<dd><p>Loads image from path</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.image.LabeledColorImage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.image.</span></span><span class="sig-name descname"><span class="pre">LabeledColorImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FC6255'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Positive'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stroke_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">24</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.image.LabeledColorImage" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.mobject.Group</span></code></p>
<p>Labeled Color Image</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.image.LabeledColorImage.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#manim_ml.image.LabeledColorImage.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-manim_ml.list_group">
<span id="manim-ml-list-group-module"></span><h2>manim_ml.list_group module<a class="headerlink" href="#module-manim_ml.list_group" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.list_group.</span></span><span class="sig-name descname"><span class="pre">ListGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">layers</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.mobject.Mobject</span></code></p>
<p>Indexable Group with traditional list operations</p>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.add" title="Permalink to this definition">#</a></dt>
<dd><p>Adds to end</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#manim_ml.list_group.ListGroup.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.get" title="Permalink to this definition">#</a></dt>
<dd><p>Gets item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.index_of">
<span class="sig-name descname"><span class="pre">index_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.index_of" title="Permalink to this definition">#</a></dt>
<dd><p>Returns index of item if it exists</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.insert">
<span class="sig-name descname"><span class="pre">insert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.insert" title="Permalink to this definition">#</a></dt>
<dd><p>Inserts item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.remove" title="Permalink to this definition">#</a></dt>
<dd><p>Removes first instance of item</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.remove_at_index">
<span class="sig-name descname"><span class="pre">remove_at_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.remove_at_index" title="Permalink to this definition">#</a></dt>
<dd><p>Removes item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.remove_at_indices">
<span class="sig-name descname"><span class="pre">remove_at_indices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.remove_at_indices" title="Permalink to this definition">#</a></dt>
<dd><p>Removes items at indices</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.replace">
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.replace" title="Permalink to this definition">#</a></dt>
<dd><p>Replaces item at index</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.list_group.ListGroup.set_z_index">
<span class="sig-name descname"><span class="pre">set_z_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">z_index_value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.list_group.ListGroup.set_z_index" title="Permalink to this definition">#</a></dt>
<dd><p>Sets z index of all values in ListGroup</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-manim_ml.manifold">
<span id="manim-ml-manifold-module"></span><h2>manim_ml.manifold module<a class="headerlink" href="#module-manim_ml.manifold" title="Permalink to this headline">#</a></h2>
<p>Visaulization of a latent Manifold</p>
</section>
<section id="module-manim_ml.one_to_one_sync">
<span id="manim-ml-one-to-one-sync-module"></span><h2>manim_ml.one_to_one_sync module<a class="headerlink" href="#module-manim_ml.one_to_one_sync" title="Permalink to this headline">#</a></h2>
<p>Module for handling syncing two animations one to one.
The goal here is to zip up two classes and their respective animations,
and create a joint class with the same animations that runs the animations
for both classes at the same time. This way we can connect two isomorphic
views of the same concept and visualize them at the same time.</p>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.one_to_one_sync.OneToOneSync">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.one_to_one_sync.</span></span><span class="sig-name descname"><span class="pre">OneToOneSync</span></span><a class="headerlink" href="#manim_ml.one_to_one_sync.OneToOneSync" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
</dd></dl>
</section>
<section id="module-manim_ml.probability">
<span id="manim-ml-probability-module"></span><h2>manim_ml.probability module<a class="headerlink" href="#module-manim_ml.probability" title="Permalink to this headline">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">manim_ml.probability.</span></span><span class="sig-name descname"><span class="pre">GaussianDistribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">axes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cov</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dist_theme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'gaussian'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">manim.mobject.types.vectorized_mobject.VGroup</span></code></p>
<p>Object for drawing a Gaussian distribution</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.animation_overrides">
<span class="sig-name descname"><span class="pre">animation_overrides</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.animation_overrides" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.compute_covariance_rotation_and_scale">
<span class="sig-name descname"><span class="pre">compute_covariance_rotation_and_scale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.compute_covariance_rotation_and_scale" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.construct_gaussian_distribution">
<span class="sig-name descname"><span class="pre">construct_gaussian_distribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mean</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_ellipses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.construct_gaussian_distribution" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a 2d Gaussian distribution object with given mean and covariance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="manim_ml.probability.GaussianDistribution.construct_simple_gaussian_ellipse">
<span class="sig-name descname"><span class="pre">construct_simple_gaussian_ellipse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mean</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">covariance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#FF862F'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#manim_ml.probability.GaussianDistribution.construct_simple_gaussian_ellipse" title="Permalink to this definition">#</a></dt>
<dd><p>Returns a 2d Gaussian distribution object with given mean and covariance</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-manim_ml">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-manim_ml" title="Permalink to this headline">#</a></h2>
</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 package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-manim_ml.image">manim_ml.image module</a></li>
<li><a class="reference internal" href="#module-manim_ml.list_group">manim_ml.list_group module</a></li>
<li><a class="reference internal" href="#module-manim_ml.manifold">manim_ml.manifold module</a></li>
<li><a class="reference internal" href="#module-manim_ml.one_to_one_sync">manim_ml.one_to_one_sync module</a></li>
<li><a class="reference internal" href="#module-manim_ml.probability">manim_ml.probability module</a></li>
<li><a class="reference internal" href="#module-manim_ml">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>

449
docs/build/html/manim_ml.neural_network.html vendored Normal file
View File

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

849
docs/build/html/manim_ml.neural_network.layers.html vendored Normal file
View File

@ -0,0 +1,849 @@
<!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>

257
docs/build/html/modules.html vendored Normal file
View File

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

BIN
docs/build/html/objects.inv vendored Normal file
View File

Binary file not shown.

414
docs/build/html/py-modindex.html vendored Normal file
View File

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

239
docs/build/html/search.html vendored Normal file
View File

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

1
docs/build/html/searchindex.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

35
docs/make.bat Normal file
View File

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

51
docs/source/conf.py Normal file
View File

@ -0,0 +1,51 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../../manim_ml'))
# -- Project information -----------------------------------------------------
project = 'ManimML'
copyright = '2022, Alec Helbling'
author = 'Alec Helbling'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'furo'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

20
docs/source/index.rst Normal file
View File

@ -0,0 +1,20 @@
.. ManimML documentation master file, created by
sphinx-quickstart on Fri Apr 29 10:47:48 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ManimML's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

157
docs/source/manim_ml.neural_network.layers.rst Normal file
View File

@ -0,0 +1,157 @@
manim\_ml.neural\_network.layers package
========================================
Submodules
----------
manim\_ml.neural\_network.layers.convolutional module
-----------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.convolutional
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.convolutional\_to\_convolutional module
------------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.convolutional_to_convolutional
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.embedding module
-------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.embedding
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.embedding\_to\_feed\_forward module
--------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.embedding_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward module
-----------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_embedding module
--------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_embedding
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_feed\_forward module
------------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_image module
----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_image
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.feed\_forward\_to\_vector module
-----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.feed_forward_to_vector
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.image module
---------------------------------------------
.. automodule:: manim_ml.neural_network.layers.image
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.image\_to\_feed\_forward module
----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.image_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.paired\_query module
-----------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.paired_query
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.paired\_query\_to\_feed\_forward module
------------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.paired_query_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.parent\_layers module
------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.parent_layers
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.triplet module
-----------------------------------------------
.. automodule:: manim_ml.neural_network.layers.triplet
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.triplet\_to\_feed\_forward module
------------------------------------------------------------------
.. automodule:: manim_ml.neural_network.layers.triplet_to_feed_forward
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.util module
--------------------------------------------
.. automodule:: manim_ml.neural_network.layers.util
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.layers.vector module
----------------------------------------------
.. automodule:: manim_ml.neural_network.layers.vector
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: manim_ml.neural_network.layers
:members:
:undoc-members:
:show-inheritance:

45
docs/source/manim_ml.neural_network.rst Normal file
View File

@ -0,0 +1,45 @@
manim\_ml.neural\_network package
=================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
manim_ml.neural_network.layers
Submodules
----------
manim\_ml.neural\_network.neural\_network module
------------------------------------------------
.. automodule:: manim_ml.neural_network.neural_network
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.neural\_network\_transformations module
-----------------------------------------------------------------
.. automodule:: manim_ml.neural_network.neural_network_transformations
:members:
:undoc-members:
:show-inheritance:
manim\_ml.neural\_network.variational\_autoencoder module
---------------------------------------------------------
.. automodule:: manim_ml.neural_network.variational_autoencoder
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: manim_ml.neural_network
:members:
:undoc-members:
:show-inheritance:

61
docs/source/manim_ml.rst Normal file
View File

@ -0,0 +1,61 @@
manim\_ml package
=================
Subpackages
-----------
.. toctree::
:maxdepth: 4
manim_ml.neural_network
Submodules
----------
manim\_ml.image module
----------------------
.. automodule:: manim_ml.image
:members:
:undoc-members:
:show-inheritance:
manim\_ml.list\_group module
----------------------------
.. automodule:: manim_ml.list_group
:members:
:undoc-members:
:show-inheritance:
manim\_ml.manifold module
-------------------------
.. automodule:: manim_ml.manifold
:members:
:undoc-members:
:show-inheritance:
manim\_ml.one\_to\_one\_sync module
-----------------------------------
.. automodule:: manim_ml.one_to_one_sync
:members:
:undoc-members:
:show-inheritance:
manim\_ml.probability module
----------------------------
.. automodule:: manim_ml.probability
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: manim_ml
:members:
:undoc-members:
:show-inheritance:

7
docs/source/modules.rst Normal file
View File

@ -0,0 +1,7 @@
manim_ml
========
.. toctree::
:maxdepth: 4
manim_ml