Files
FYS-STK4155/doc/LectureNotes/_build/html/week45.html
T
Morten Hjorth-Jensen 4f275a4832 update jupyter-book
2024-11-12 09:48:10 +01:00

4723 lines
491 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Week 45, Convolutional Neural Networks (CCNs) and Recurrent Neural Networks (RNNs) &#8212; Applied Data Analysis and Machine Learning</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<script src="_static/documentation_options.js?v=9eb32ce0"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="_static/togglebutton.js?v=4a39c7ea"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script async="async" src="_static/sphinx-thebe.js?v=c100c467"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'week45';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Week 46: Decision Trees, Ensemble methods and Random Forests" href="week46.html" />
<link rel="prev" title="Week 44, Convolutional Neural Networks (CNN)" href="week44.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search this book..."
aria-label="Search this book..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="intro.html">
<img src="_static/logo.png" class="logo__image only-light" alt="Applied Data Analysis and Machine Learning - Home"/>
<img src="_static/logo.png" class="logo__image only-dark pst-js-only" alt="Applied Data Analysis and Machine Learning - Home"/>
</a></div>
<div class="sidebar-primary-item">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="intro.html">
Applied Data Analysis and Machine Learning
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">About the course</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="schedule.html">Teaching schedule with links to material</a></li>
<li class="toctree-l1"><a class="reference internal" href="teachers.html">Teachers and Grading</a></li>
<li class="toctree-l1"><a class="reference internal" href="textbooks.html">Textbooks</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Review of Statistics with Resampling Techniques and Linear Algebra</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="statistics.html">1. Elements of Probability Theory and Statistical Data Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="linalg.html">2. Linear Algebra, Handling of Arrays and more Python Features</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">From Regression to Support Vector Machines</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="chapter1.html">3. Linear Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter2.html">4. Ridge and Lasso Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter3.html">5. Resampling Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter4.html">6. Logistic Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapteroptimization.html">7. Optimization, the central part of any Machine Learning algortithm</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter5.html">8. Support Vector Machines, overarching aims</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Decision Trees, Ensemble Methods and Boosting</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="chapter6.html">9. Decision trees, overarching aims</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter7.html">10. Ensemble Methods: From a Single Tree to Many Trees and Extreme Boosting, Meet the Jungle of Methods</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Dimensionality Reduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="chapter8.html">11. Basic ideas of the Principal Component Analysis (PCA)</a></li>
<li class="toctree-l1"><a class="reference internal" href="clustering.html">12. Clustering and Unsupervised Learning</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Deep Learning Methods</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="chapter9.html">13. Neural networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter10.html">14. Building a Feed Forward Neural Network</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter11.html">15. Solving Differential Equations with Deep Learning</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter12.html">16. Convolutional Neural Networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="chapter13.html">17. Recurrent neural networks: Overarching view</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Weekly material, notes and exercises</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="exercisesweek34.html">Exercises week 34</a></li>
<li class="toctree-l1"><a class="reference internal" href="week34.html">Week 34: Introduction to the course, Logistics and Practicalities</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek35.html">Exercises week 35</a></li>
<li class="toctree-l1"><a class="reference internal" href="week35.html">Week 35: From Ordinary Linear Regression to Ridge and Lasso Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek36.html">Exercises week 36</a></li>
<li class="toctree-l1"><a class="reference internal" href="week36.html">Week 36: Linear Regression and Statistical interpretations</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek37.html">Exercises week 37</a></li>
<li class="toctree-l1"><a class="reference internal" href="week37.html">Week 37: Statistical interpretations and Resampling Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek38.html">Exercises week 38</a></li>
<li class="toctree-l1"><a class="reference internal" href="week38.html">Week 38: Logistic Regression and Optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek39.html">Exercises week 39</a></li>
<li class="toctree-l1"><a class="reference internal" href="week39.html">Week 39: Optimization and Gradient Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="week40.html">Week 40: Gradient descent methods (continued) and start Neural networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek41.html">Exercises week 41</a></li>
<li class="toctree-l1"><a class="reference internal" href="week41.html">Week 41 Neural networks and constructing a neural network code</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek42.html">Exercises week 42</a></li>
<li class="toctree-l1"><a class="reference internal" href="week42.html">Week 42 Constructing a Neural Network code with examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="additionweek42.html">Exercises Week 42: Logistic Regression and Optimization, reminders from week 38 and week 40</a></li>
<li class="toctree-l1"><a class="reference internal" href="week43.html">Week 43: Deep Learning: Constructing a Neural Network code and solving differential equations</a></li>
<li class="toctree-l1"><a class="reference internal" href="exercisesweek43.html">Exercises week 43</a></li>
<li class="toctree-l1"><a class="reference internal" href="week44.html">Week 44, Convolutional Neural Networks (CNN)</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Week 45, Convolutional Neural Networks (CCNs) and Recurrent Neural Networks (RNNs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="week46.html">Week 46: Decision Trees, Ensemble methods and Random Forests</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Projects</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="project1.html">Project 1 on Machine Learning, deadline October 7 (midnight), 2024</a></li>
<li class="toctree-l1"><a class="reference internal" href="project2.html">Project 2 on Machine Learning, deadline November 4 (Midnight)</a></li>
<li class="toctree-l1"><a class="reference internal" href="project3.html">Project 3 on Machine Learning, deadline December 9 (midnight), 2024</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</button></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-launch-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Launch interactive content">
<i class="fas fa-rocket"></i>
</button>
<ul class="dropdown-menu">
<li><a href="https://mybinder.org/v2/git/https%3A//compphysics.github.io/MachineLearning/doc/LectureNotes/_build/html/index.html/master?urlpath=tree/week45.ipynb" target="_blank"
class="btn btn-sm dropdown-item"
title="Launch on Binder"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<img alt="Binder logo" src="_static/images/logo_binder.svg">
</span>
<span class="btn__text-container">Binder</span>
</a>
</li>
</ul>
</div>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/week45.ipynb" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.ipynb</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button>
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</button>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Week 45, Convolutional Neural Networks (CCNs) and Recurrent Neural Networks (RNNs)</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#plans-for-week-45">Plans for week 45</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#material-for-the-lab-sessions-additional-ways-to-present-classification-results-and-other-practicalities">Material for the lab sessions, additional ways to present classification results and other practicalities</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#material-for-lecture-monday-november-4">Material for Lecture Monday November 4</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#convolutional-neural-networks-recognizing-images">Convolutional Neural Networks (recognizing images)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-is-the-difference">What is the Difference</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#neural-networks-vs-cnns">Neural Networks vs CNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-cnns-for-images-sound-files-medical-images-from-ct-scans-etc">Why CNNS for images, sound files, medical images from CT scans etc?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#regular-nns-dont-scale-well-to-full-images">Regular NNs dont scale well to full images</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#d-volumes-of-neurons">3D volumes of neurons</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#layers-used-to-build-cnns">Layers used to build CNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cnns-in-brief">CNNs in brief</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-deep-cnn-model-from-raschka-et-al">A deep CNN model (From Raschka et al)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#key-idea">Key Idea</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-convolutional-neural-networks-in-tensorflow-and-keras">Building convolutional neural networks in Tensorflow and Keras</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-it-up">Setting it up</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-mnist-dataset-again">The MNIST dataset again</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#strong-correlations">Strong correlations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#layers-of-a-cnn">Layers of a CNN</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#systematic-reduction">Systematic reduction</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#prerequisites-collect-and-pre-process-data">Prerequisites: Collect and pre-process data</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#importing-keras-and-tensorflow">Importing Keras and Tensorflow</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-with-keras">Running with Keras</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#final-part">Final part</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#final-visualization">Final visualization</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-cifar01-data-set">The CIFAR01 data set</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#verifying-the-data-set">Verifying the data set</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#set-up-the-model">Set up the model</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#add-dense-layers-on-top">Add Dense layers on top</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#compile-and-train-the-model">Compile and train the model</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#finally-evaluate-the-model">Finally, evaluate the model</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-our-own-cnn-code">Building our own CNN code</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#list-of-contents">List of contents:</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#schedulers">Schedulers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-schedulers">Usage of schedulers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#cost-functions">Cost functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-cost-functions">Usage of cost functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#activation-functions">Activation functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-activation-functions">Usage of activation functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution">Convolution</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#layers">Layers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution2dlayer-convolution-in-a-hidden-layer">Convolution2DLayer: convolution in a hidden layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#backpropagation-in-the-convolutional-layer">Backpropagation in the convolutional layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#demonstration">Demonstration</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pooling-layer">Pooling Layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#flattening-layer">Flattening Layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#fully-connected-layers">Fully Connected Layers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#optimized-convolution2dlayer">Optimized Convolution2DLayer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-convolutional-neural-network-cnn">The Convolutional Neural Network (CNN)</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-cnn-code">Usage of CNN code</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-remarks">Additional Remarks</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#remarks-on-the-speed">Remarks on the speed</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution-using-separable-kernels">Convolution using separable kernels</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution-in-the-fourier-domain">Convolution in the Fourier domain</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#from-ffnns-and-cnns-to-recurrent-neural-networks-rnns">From FFNNs and CNNs to recurrent neural networks (RNNs)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#feedback-connections">Feedback connections</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#vanishing-gradients">Vanishing gradients</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#recurrent-neural-networks-rnns-overarching-view">Recurrent neural networks (RNNs): Overarching view</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sequential-data-only">Sequential data only?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#differential-equations">Differential equations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-simple-example">A simple example</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns">RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-kinds-of-behaviour-can-rnns-exhibit">What kinds of behaviour can RNNs exhibit?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#basic-layout-figures-from-sebastian-rashcka-et-al-machine-learning-with-sickit-learn-and-pytorch">Basic layout, Figures from Sebastian Rashcka et al, Machine learning with Sickit-Learn and PyTorch</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#solving-differential-equations-with-rnns">Solving differential equations with RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#two-first-order-differential-equations">Two first-order differential equations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#velocity-only">Velocity only</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#linking-with-rnns">Linking with RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#minor-rewrite">Minor rewrite</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail">RNNs in more detail</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-2">RNNs in more detail, part 2</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-3">RNNs in more detail, part 3</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-4">RNNs in more detail, part 4</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-5">RNNs in more detail, part 5</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-6">RNNs in more detail, part 6</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-7">RNNs in more detail, part 7</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#backpropagation-through-time">Backpropagation through time</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-backward-pass-is-linear">The backward pass is linear</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-problem-of-exploding-or-vanishing-gradients">The problem of exploding or vanishing gradients</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mathematical-setup">Mathematical setup</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-through-figures-part-1">Back propagation in time through figures, part 1</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-part-2">Back propagation in time, part 2</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-part-3">Back propagation in time, part 3</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-part-4">Back propagation in time, part 4</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-in-equations">Back propagation in time in equations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#chain-rule-again">Chain rule again</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#gradients-of-loss-functions">Gradients of loss functions</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary-of-rnns">Summary of RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary-of-a-typical-rnn">Summary of a typical RNN</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#four-effective-ways-to-learn-an-rnn-and-preparing-for-next-week">Four effective ways to learn an RNN and preparing for next week</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#gating-mechanism-long-short-term-memory-lstm">Gating mechanism: Long Short Term Memory (LSTM)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#implementing-a-memory-cell-in-a-neural-network">Implementing a memory cell in a neural network</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#lstm-details">LSTM details</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#basic-layout">Basic layout</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#more-lstm-details">More LSTM details</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-forget-gate">The forget gate</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#input-gate">Input gate</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#forget-and-input">Forget and input</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#output-gate">Output gate</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<!-- HTML file automatically generated from DocOnce source (https://github.com/doconce/doconce/)
doconce format html week45.do.txt --no_mako -->
<!-- dom:TITLE: Week 45, Convolutional Neural Networks (CCNs) and Recurrent Neural Networks (RNNs) --><section class="tex2jax_ignore mathjax_ignore" id="week-45-convolutional-neural-networks-ccns-and-recurrent-neural-networks-rnns">
<h1>Week 45, Convolutional Neural Networks (CCNs) and Recurrent Neural Networks (RNNs)<a class="headerlink" href="#week-45-convolutional-neural-networks-ccns-and-recurrent-neural-networks-rnns" title="Link to this heading">#</a></h1>
<p><strong>Morten Hjorth-Jensen</strong>, Department of Physics, University of Oslo</p>
<p>Date: <strong>November 4-8</strong></p>
<section id="plans-for-week-45">
<h2>Plans for week 45<a class="headerlink" href="#plans-for-week-45" title="Link to this heading">#</a></h2>
<p><strong>Material for the lecture on Monday November 4, 2024.</strong></p>
<ol class="arabic simple">
<li><p>Convolutional Neural Networks, codes and examples (own code and TensorFlow and Pytorch implementations)</p></li>
<li><p>Recurrent Neural Networks (RNNs)</p></li>
<li><p>Readings and Videos:</p></li>
</ol>
<p>a. These lecture notes at <a class="github reference external" href="https://github.com/CompPhysics/MachineLearning/blob/master/doc/pub/week45/ipynb/week45.ipynb">CompPhysics/MachineLearning</a></p>
<!-- * [Video of lecture](https://youtu.be/z0x-vgyAZUk) -->
<!-- * [Whiteboard notes](https://github.com/CompPhysics/MachineLearning/blob/master/doc/HandWrittenNotes/2023/NotesNov9.pdf) -->
<p>b. For a more in depth discussion on CNNs and recurrent neural networks we recommend Goodfellow et al chapters 9 and 10. See also chapter 11 and 12 on practicalities and applications</p>
<p>c. Reading suggestions for implementation of CNNs and RNNs, see Raschka et al chapters 14-15 at <a class="github reference external" href="https://github.com/rasbt/machine-learning-book">rasbt/machine-learning-book</a>.</p>
<p>d. Video on Recurrent Neural Networks from MIT at <a class="reference external" href="https://www.youtube.com/watch?v=SEnXr6v2ifU&amp;amp;ab_channel=AlexanderAmini">https://www.youtube.com/watch?v=SEnXr6v2ifU&amp;ab_channel=AlexanderAmini</a></p>
<p>e. Video on Deep Learning at <a class="reference external" href="https://www.youtube.com/playlist?list=PLZHQObOWTQDNU6R1_67000Dx_ZCJB-3pi">https://www.youtube.com/playlist?list=PLZHQObOWTQDNU6R1_67000Dx_ZCJB-3pi</a></p>
</section>
<section id="material-for-the-lab-sessions-additional-ways-to-present-classification-results-and-other-practicalities">
<h2>Material for the lab sessions, additional ways to present classification results and other practicalities<a class="headerlink" href="#material-for-the-lab-sessions-additional-ways-to-present-classification-results-and-other-practicalities" title="Link to this heading">#</a></h2>
<p><strong>Material for the active learning sessions on Tuesday and Wednesday.</strong></p>
<ol class="arabic simple">
<li><p>Discussion of and work on project 3, available from Monday November 4, late evening</p></li>
</ol>
</section>
<section id="material-for-lecture-monday-november-4">
<h2>Material for Lecture Monday November 4<a class="headerlink" href="#material-for-lecture-monday-november-4" title="Link to this heading">#</a></h2>
</section>
<section id="convolutional-neural-networks-recognizing-images">
<h2>Convolutional Neural Networks (recognizing images)<a class="headerlink" href="#convolutional-neural-networks-recognizing-images" title="Link to this heading">#</a></h2>
<p>Convolutional neural networks (CNNs) were developed during the last
decade of the previous century, with a focus on character recognition
tasks. Nowadays, CNNs are a central element in the spectacular success
of deep learning methods. The success in for example image
classifications have made them a central tool for most machine
learning practitioners.</p>
<p>CNNs are very similar to ordinary Neural Networks.
They are made up of neurons that have learnable weights and
biases. Each neuron receives some inputs, performs a dot product and
optionally follows it with a non-linearity. The whole network still
expresses a single differentiable score function: from the raw image
pixels on one end to class scores at the other. And they still have a
loss function (for example Softmax) on the last (fully-connected) layer
and all the tips/tricks we developed for learning regular Neural
Networks still apply (back propagation, gradient descent etc etc).</p>
</section>
<section id="what-is-the-difference">
<h2>What is the Difference<a class="headerlink" href="#what-is-the-difference" title="Link to this heading">#</a></h2>
<p><strong>CNN architectures make the explicit assumption that
the inputs are images, which allows us to encode certain properties
into the architecture. These then make the forward function more
efficient to implement and vastly reduce the amount of parameters in
the network.</strong></p>
</section>
<section id="neural-networks-vs-cnns">
<h2>Neural Networks vs CNNs<a class="headerlink" href="#neural-networks-vs-cnns" title="Link to this heading">#</a></h2>
<p>Neural networks are defined as <strong>affine transformations</strong>, that is
a vector is received as input and is multiplied with a matrix of so-called weights (our unknown paramters) to produce an
output (to which a bias vector is usually added before passing the result
through a nonlinear activation function). This is applicable to any type of input, be it an
image, a sound clip or an unordered collection of features: whatever their
dimensionality, their representation can always be flattened into a vector
before the transformation.</p>
</section>
<section id="why-cnns-for-images-sound-files-medical-images-from-ct-scans-etc">
<h2>Why CNNS for images, sound files, medical images from CT scans etc?<a class="headerlink" href="#why-cnns-for-images-sound-files-medical-images-from-ct-scans-etc" title="Link to this heading">#</a></h2>
<p>However, when we consider images, sound clips and many other similar kinds of data, these data have an intrinsic
structure. More formally, they share these important properties:</p>
<ul class="simple">
<li><p>They are stored as multi-dimensional arrays (think of the pixels of a figure) .</p></li>
<li><p>They feature one or more axes for which ordering matters (e.g., width and height axes for an image, time axis for a sound clip).</p></li>
<li><p>One axis, called the channel axis, is used to access different views of the data (e.g., the red, green and blue channels of a color image, or the left and right channels of a stereo audio track).</p></li>
</ul>
<p>These properties are not exploited when an affine transformation is applied; in
fact, all the axes are treated in the same way and the topological information
is not taken into account. Still, taking advantage of the implicit structure of
the data may prove very handy in solving some tasks, like computer vision and
speech recognition, and in these cases it would be best to preserve it. This is
where discrete convolutions come into play.</p>
<p>A discrete convolution is a linear transformation that preserves this notion of
ordering. It is sparse (only a few input units contribute to a given output
unit) and reuses parameters (the same weights are applied to multiple locations
in the input).</p>
</section>
<section id="regular-nns-dont-scale-well-to-full-images">
<h2>Regular NNs dont scale well to full images<a class="headerlink" href="#regular-nns-dont-scale-well-to-full-images" title="Link to this heading">#</a></h2>
<p>As an example, consider
an image of size <span class="math notranslate nohighlight">\(32\times 32\times 3\)</span> (32 wide, 32 high, 3 color channels), so a
single fully-connected neuron in a first hidden layer of a regular
Neural Network would have <span class="math notranslate nohighlight">\(32\times 32\times 3 = 3072\)</span> weights. This amount still
seems manageable, but clearly this fully-connected structure does not
scale to larger images. For example, an image of more respectable
size, say <span class="math notranslate nohighlight">\(200\times 200\times 3\)</span>, would lead to neurons that have
<span class="math notranslate nohighlight">\(200\times 200\times 3 = 120,000\)</span> weights.</p>
<p>We could have
several such neurons, and the parameters would add up quickly! Clearly,
this full connectivity is wasteful and the huge number of parameters
would quickly lead to possible overfitting.</p>
<!-- dom:FIGURE: [figslides/nn.jpeg, width=500 frac=0.6] A regular 3-layer Neural Network. -->
<!-- begin figure -->
<p><img src="figslides/nn.jpeg" width="500"><p style="font-size: 0.9em"><i>Figure 1: A regular 3-layer Neural Network.</i></p></p>
<!-- end figure --></section>
<section id="d-volumes-of-neurons">
<h2>3D volumes of neurons<a class="headerlink" href="#d-volumes-of-neurons" title="Link to this heading">#</a></h2>
<p>Convolutional Neural Networks take advantage of the fact that the
input consists of images and they constrain the architecture in a more
sensible way.</p>
<p>In particular, unlike a regular Neural Network, the
layers of a CNN have neurons arranged in 3 dimensions: width,
height, depth. (Note that the word depth here refers to the third
dimension of an activation volume, not to the depth of a full Neural
Network, which can refer to the total number of layers in a network.)</p>
<p>To understand it better, the above example of an image
with an input volume of
activations has dimensions <span class="math notranslate nohighlight">\(32\times 32\times 3\)</span> (width, height,
depth respectively).</p>
<p>The neurons in a layer will
only be connected to a small region of the layer before it, instead of
all of the neurons in a fully-connected manner. Moreover, the final
output layer could for this specific image have dimensions <span class="math notranslate nohighlight">\(1\times 1 \times 10\)</span>,
because by the
end of the CNN architecture we will reduce the full image into a
single vector of class scores, arranged along the depth
dimension.</p>
<!-- dom:FIGURE: [figslides/cnn.jpeg, width=500 frac=0.6] A CNN arranges its neurons in three dimensions (width, height, depth), as visualized in one of the layers. Every layer of a CNN transforms the 3D input volume to a 3D output volume of neuron activations. In this example, the red input layer holds the image, so its width and height would be the dimensions of the image, and the depth would be 3 (Red, Green, Blue channels). -->
<!-- begin figure -->
<p><img src="figslides/cnn.jpeg" width="500"><p style="font-size: 0.9em"><i>Figure 1: A CNN arranges its neurons in three dimensions (width, height, depth), as visualized in one of the layers. Every layer of a CNN transforms the 3D input volume to a 3D output volume of neuron activations. In this example, the red input layer holds the image, so its width and height would be the dimensions of the image, and the depth would be 3 (Red, Green, Blue channels).</i></p></p>
<!-- end figure --></section>
<section id="layers-used-to-build-cnns">
<h2>Layers used to build CNNs<a class="headerlink" href="#layers-used-to-build-cnns" title="Link to this heading">#</a></h2>
<p>A simple CNN is a sequence of layers, and every layer of a CNN
transforms one volume of activations to another through a
differentiable function. We use three main types of layers to build
CNN architectures: Convolutional Layer, Pooling Layer, and
Fully-Connected Layer (exactly as seen in regular Neural Networks). We
will stack these layers to form a full CNN architecture.</p>
<p>A simple CNN for image classification could have the architecture:</p>
<ul class="simple">
<li><p><strong>INPUT</strong> (<span class="math notranslate nohighlight">\(32\times 32 \times 3\)</span>) will hold the raw pixel values of the image, in this case an image of width 32, height 32, and with three color channels R,G,B.</p></li>
<li><p><strong>CONV</strong> (convolutional )layer will compute the output of neurons that are connected to local regions in the input, each computing a dot product between their weights and a small region they are connected to in the input volume. This may result in volume such as <span class="math notranslate nohighlight">\([32\times 32\times 12]\)</span> if we decided to use 12 filters.</p></li>
<li><p><strong>RELU</strong> layer will apply an elementwise activation function, such as the <span class="math notranslate nohighlight">\(max(0,x)\)</span> thresholding at zero. This leaves the size of the volume unchanged (<span class="math notranslate nohighlight">\([32\times 32\times 12]\)</span>).</p></li>
<li><p><strong>POOL</strong> (pooling) layer will perform a downsampling operation along the spatial dimensions (width, height), resulting in volume such as <span class="math notranslate nohighlight">\([16\times 16\times 12]\)</span>.</p></li>
<li><p><strong>FC</strong> (i.e. fully-connected) layer will compute the class scores, resulting in volume of size <span class="math notranslate nohighlight">\([1\times 1\times 10]\)</span>, where each of the 10 numbers correspond to a class score, such as among the 10 categories of the MNIST images we considered above . As with ordinary Neural Networks and as the name implies, each neuron in this layer will be connected to all the numbers in the previous volume.</p></li>
</ul>
</section>
<section id="cnns-in-brief">
<h2>CNNs in brief<a class="headerlink" href="#cnns-in-brief" title="Link to this heading">#</a></h2>
<p>In summary:</p>
<ul class="simple">
<li><p>A CNN architecture is in the simplest case a list of Layers that transform the image volume into an output volume (e.g. holding the class scores)</p></li>
<li><p>There are a few distinct types of Layers (e.g. CONV/FC/RELU/POOL are by far the most popular)</p></li>
<li><p>Each Layer accepts an input 3D volume and transforms it to an output 3D volume through a differentiable function</p></li>
<li><p>Each Layer may or may not have parameters (e.g. CONV/FC do, RELU/POOL dont)</p></li>
<li><p>Each Layer may or may not have additional hyperparameters (e.g. CONV/FC/POOL do, RELU doesnt)</p></li>
</ul>
</section>
<section id="a-deep-cnn-model-from-raschka-et-al">
<h2>A deep CNN model (<a class="reference external" href="https://github.com/rasbt/machine-learning-book">From Raschka et al</a>)<a class="headerlink" href="#a-deep-cnn-model-from-raschka-et-al" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/deepcnn.png, width=500 frac=0.67] A deep CNN -->
<!-- begin figure -->
<p><img src="figslides/deepcnn.png" width="500"><p style="font-size: 0.9em"><i>Figure 1: A deep CNN</i></p></p>
<!-- end figure --></section>
<section id="key-idea">
<h2>Key Idea<a class="headerlink" href="#key-idea" title="Link to this heading">#</a></h2>
<p>A dense neural network is representd by an affine operation (like matrix-matrix multiplication) where all parameters are included.</p>
<p>The key idea in CNNs for say imaging is that in images neighbor pixels tend to be related! So we connect
only neighboring neurons in the input instead of connecting all with the first hidden layer.</p>
<p>We say we perform a filtering (convolution is the mathematical operation).</p>
</section>
<section id="building-convolutional-neural-networks-in-tensorflow-and-keras">
<h2>Building convolutional neural networks in Tensorflow and Keras<a class="headerlink" href="#building-convolutional-neural-networks-in-tensorflow-and-keras" title="Link to this heading">#</a></h2>
<p>As discussed above, CNNs are neural networks built from the assumption that the inputs
to the network are 2D images. This is important because the number of features or pixels in images
grows very fast with the image size, and an enormous number of weights and biases are needed in order to build an accurate network.</p>
<p>As before, we still have our input, a hidden layer and an output. Whats novel about convolutional networks
are the <strong>convolutional</strong> and <strong>pooling</strong> layers stacked in pairs between the input and the hidden layer.
In addition, the data is no longer represented as a 2D feature matrix, instead each input is a number of 2D
matrices, typically 1 for each color dimension (Red, Green, Blue).</p>
</section>
<section id="setting-it-up">
<h2>Setting it up<a class="headerlink" href="#setting-it-up" title="Link to this heading">#</a></h2>
<p>It means that to represent the entire
dataset of images, we require a 4D matrix or <strong>tensor</strong>. This tensor has the dimensions:</p>
<div class="math notranslate nohighlight">
\[
(n_{inputs},\, n_{pixels, width},\, n_{pixels, height},\, depth) .
\]</div>
</section>
<section id="the-mnist-dataset-again">
<h2>The MNIST dataset again<a class="headerlink" href="#the-mnist-dataset-again" title="Link to this heading">#</a></h2>
<p>The MNIST dataset consists of grayscale images with a pixel size of
<span class="math notranslate nohighlight">\(28\times 28\)</span>, meaning we require <span class="math notranslate nohighlight">\(28 \times 28 = 724\)</span> weights to each
neuron in the first hidden layer.</p>
<p>If we were to analyze images of size <span class="math notranslate nohighlight">\(128\times 128\)</span> we would require
<span class="math notranslate nohighlight">\(128 \times 128 = 16384\)</span> weights to each neuron. Even worse if we were
dealing with color images, as most images are, we have an image matrix
of size <span class="math notranslate nohighlight">\(128\times 128\)</span> for each color dimension (Red, Green, Blue),
meaning 3 times the number of weights <span class="math notranslate nohighlight">\(= 49152\)</span> are required for every
single neuron in the first hidden layer.</p>
</section>
<section id="strong-correlations">
<h2>Strong correlations<a class="headerlink" href="#strong-correlations" title="Link to this heading">#</a></h2>
<p>Images typically have strong local correlations, meaning that a small
part of the image varies little from its neighboring regions. If for
example we have an image of a blue car, we can roughly assume that a
small blue part of the image is surrounded by other blue regions.</p>
<p>Therefore, instead of connecting every single pixel to a neuron in the
first hidden layer, as we have previously done with deep neural
networks, we can instead connect each neuron to a small part of the
image (in all 3 RGB depth dimensions). The size of each small area is
fixed, and known as a <a class="reference external" href="https://en.wikipedia.org/wiki/Receptive_field">receptive</a>.</p>
</section>
<section id="layers-of-a-cnn">
<h2>Layers of a CNN<a class="headerlink" href="#layers-of-a-cnn" title="Link to this heading">#</a></h2>
<p>The layers of a convolutional neural network arrange neurons in 3D: width, height and depth.<br />
The input image is typically a square matrix of depth 3.</p>
<p>A <strong>convolution</strong> is performed on the image which outputs
a 3D volume of neurons. The weights to the input are arranged in a number of 2D matrices, known as <strong>filters</strong>.</p>
<p>Each filter slides along the input image, taking the dot product
between each small part of the image and the filter, in all depth
dimensions. This is then passed through a non-linear function,
typically the <strong>Rectified Linear (ReLu)</strong> function, which serves as the
activation of the neurons in the first convolutional layer. This is
further passed through a <strong>pooling layer</strong>, which reduces the size of the
convolutional layer, e.g. by taking the maximum or average across some
small regions, and this serves as input to the next convolutional
layer.</p>
</section>
<section id="systematic-reduction">
<h2>Systematic reduction<a class="headerlink" href="#systematic-reduction" title="Link to this heading">#</a></h2>
<p>By systematically reducing the size of the input volume, through
convolution and pooling, the network should create representations of
small parts of the input, and then from them assemble representations
of larger areas. The final pooling layer is flattened to serve as
input to a hidden layer, such that each neuron in the final pooling
layer is connected to every single neuron in the hidden layer. This
then serves as input to the output layer, e.g. a softmax output for
classification.</p>
</section>
<section id="prerequisites-collect-and-pre-process-data">
<h2>Prerequisites: Collect and pre-process data<a class="headerlink" href="#prerequisites-collect-and-pre-process-data" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">matplotlib</span> inline
<span class="c1"># import necessary packages</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">from</span> <span class="nn">sklearn</span> <span class="kn">import</span> <span class="n">datasets</span>
<span class="c1"># ensure the same random numbers appear every time</span>
<span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="c1"># display images in notebook</span>
<span class="o">%</span><span class="k">matplotlib</span> inline
<span class="n">plt</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">&#39;figure.figsize&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="mi">12</span><span class="p">,</span><span class="mi">12</span><span class="p">)</span>
<span class="c1"># download MNIST dataset</span>
<span class="n">digits</span> <span class="o">=</span> <span class="n">datasets</span><span class="o">.</span><span class="n">load_digits</span><span class="p">()</span>
<span class="c1"># define inputs and labels</span>
<span class="n">inputs</span> <span class="o">=</span> <span class="n">digits</span><span class="o">.</span><span class="n">images</span>
<span class="n">labels</span> <span class="o">=</span> <span class="n">digits</span><span class="o">.</span><span class="n">target</span>
<span class="c1"># RGB images have a depth of 3</span>
<span class="c1"># our images are grayscale so they should have a depth of 1</span>
<span class="n">inputs</span> <span class="o">=</span> <span class="n">inputs</span><span class="p">[:,:,:,</span><span class="n">np</span><span class="o">.</span><span class="n">newaxis</span><span class="p">]</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;inputs = (n_inputs, pixel_width, pixel_height, depth) = &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">inputs</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;labels = (n_inputs) = &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">labels</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="c1"># choose some random images to display</span>
<span class="n">n_inputs</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span>
<span class="n">indices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">n_inputs</span><span class="p">)</span>
<span class="n">random_indices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">indices</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">image</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">digits</span><span class="o">.</span><span class="n">images</span><span class="p">[</span><span class="n">random_indices</span><span class="p">]):</span>
<span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">axis</span><span class="p">(</span><span class="s1">&#39;off&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">cm</span><span class="o">.</span><span class="n">gray_r</span><span class="p">,</span> <span class="n">interpolation</span><span class="o">=</span><span class="s1">&#39;nearest&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Label: </span><span class="si">%d</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">digits</span><span class="o">.</span><span class="n">target</span><span class="p">[</span><span class="n">random_indices</span><span class="p">[</span><span class="n">i</span><span class="p">]])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>inputs = (n_inputs, pixel_width, pixel_height, depth) = (1797, 8, 8, 1)
labels = (n_inputs) = (1797,)
</pre></div>
</div>
<img alt="_images/07194f3d2a886bdcad6a2127866233c9c16e24cf4f6732bfaaf6620580b7a0ce.png" src="_images/07194f3d2a886bdcad6a2127866233c9c16e24cf4f6732bfaaf6620580b7a0ce.png" />
</div>
</div>
</section>
<section id="importing-keras-and-tensorflow">
<h2>Importing Keras and Tensorflow<a class="headerlink" href="#importing-keras-and-tensorflow" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">datasets</span><span class="p">,</span> <span class="n">layers</span><span class="p">,</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.layers</span> <span class="kn">import</span> <span class="n">Input</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.models</span> <span class="kn">import</span> <span class="n">Sequential</span> <span class="c1">#This allows appending layers to existing models</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.layers</span> <span class="kn">import</span> <span class="n">Dense</span> <span class="c1">#This allows defining the characteristics of a particular layer</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">optimizers</span> <span class="c1">#This allows using whichever optimiser we want (sgd,adam,RMSprop)</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">regularizers</span> <span class="c1">#This allows using whichever regularizer we want (l1,l2,l1_l2)</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.utils</span> <span class="kn">import</span> <span class="n">to_categorical</span> <span class="c1">#This allows using categorical cross entropy as the cost function</span>
<span class="c1">#from tensorflow.keras import Conv2D</span>
<span class="c1">#from tensorflow.keras import MaxPooling2D</span>
<span class="c1">#from tensorflow.keras import Flatten</span>
<span class="kn">from</span> <span class="nn">sklearn.model_selection</span> <span class="kn">import</span> <span class="n">train_test_split</span>
<span class="c1"># representation of labels</span>
<span class="n">labels</span> <span class="o">=</span> <span class="n">to_categorical</span><span class="p">(</span><span class="n">labels</span><span class="p">)</span>
<span class="c1"># split into train and test data</span>
<span class="c1"># one-liner from scikit-learn library</span>
<span class="n">train_size</span> <span class="o">=</span> <span class="mf">0.8</span>
<span class="n">test_size</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">train_size</span>
<span class="n">X_train</span><span class="p">,</span> <span class="n">X_test</span><span class="p">,</span> <span class="n">Y_train</span><span class="p">,</span> <span class="n">Y_test</span> <span class="o">=</span> <span class="n">train_test_split</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">labels</span><span class="p">,</span> <span class="n">train_size</span><span class="o">=</span><span class="n">train_size</span><span class="p">,</span>
<span class="n">test_size</span><span class="o">=</span><span class="n">test_size</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="cell_output docutils container">
<div class="output traceback highlight-ipythontb notranslate"><div class="highlight"><pre><span></span><span class="gt">---------------------------------------------------------------------------</span>
<span class="ne">NotFoundError</span><span class="g g-Whitespace"> </span>Traceback (most recent call last)
<span class="n">Cell</span> <span class="n">In</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">line</span> <span class="mi">1</span>
<span class="ne">----&gt; </span><span class="mi">1</span> <span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">datasets</span><span class="p">,</span> <span class="n">layers</span><span class="p">,</span> <span class="n">models</span>
<span class="g g-Whitespace"> </span><span class="mi">2</span> <span class="kn">from</span> <span class="nn">tensorflow.keras.layers</span> <span class="kn">import</span> <span class="n">Input</span>
<span class="g g-Whitespace"> </span><span class="mi">3</span> <span class="kn">from</span> <span class="nn">tensorflow.keras.models</span> <span class="kn">import</span> <span class="n">Sequential</span> <span class="c1">#This allows appending layers to existing models</span>
<span class="n">File</span> <span class="o">~/</span><span class="n">miniforge3</span><span class="o">/</span><span class="n">envs</span><span class="o">/</span><span class="n">myenv</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="mf">.9</span><span class="o">/</span><span class="n">site</span><span class="o">-</span><span class="n">packages</span><span class="o">/</span><span class="n">tensorflow</span><span class="o">/</span><span class="fm">__init__</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">440</span>
<span class="g g-Whitespace"> </span><span class="mi">438</span> <span class="n">_plugin_dir</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_s</span><span class="p">,</span> <span class="s1">&#39;tensorflow-plugins&#39;</span><span class="p">)</span>
<span class="g g-Whitespace"> </span><span class="mi">439</span> <span class="k">if</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">_plugin_dir</span><span class="p">):</span>
<span class="ne">--&gt; </span><span class="mi">440</span> <span class="n">_ll</span><span class="o">.</span><span class="n">load_library</span><span class="p">(</span><span class="n">_plugin_dir</span><span class="p">)</span>
<span class="g g-Whitespace"> </span><span class="mi">441</span> <span class="c1"># Load Pluggable Device Library</span>
<span class="g g-Whitespace"> </span><span class="mi">442</span> <span class="n">_ll</span><span class="o">.</span><span class="n">load_pluggable_device_library</span><span class="p">(</span><span class="n">_plugin_dir</span><span class="p">)</span>
<span class="nn">File ~/miniforge3/envs/myenv/lib/python3.9/site-packages/tensorflow/python/framework/load_library.py:151,</span> in <span class="ni">load_library</span><span class="nt">(library_location)</span>
<span class="g g-Whitespace"> </span><span class="mi">148</span> <span class="n">kernel_libraries</span> <span class="o">=</span> <span class="p">[</span><span class="n">library_location</span><span class="p">]</span>
<span class="g g-Whitespace"> </span><span class="mi">150</span> <span class="k">for</span> <span class="n">lib</span> <span class="ow">in</span> <span class="n">kernel_libraries</span><span class="p">:</span>
<span class="ne">--&gt; </span><span class="mi">151</span> <span class="n">py_tf</span><span class="o">.</span><span class="n">TF_LoadLibrary</span><span class="p">(</span><span class="n">lib</span><span class="p">)</span>
<span class="g g-Whitespace"> </span><span class="mi">153</span> <span class="k">else</span><span class="p">:</span>
<span class="g g-Whitespace"> </span><span class="mi">154</span> <span class="k">raise</span> <span class="ne">OSError</span><span class="p">(</span>
<span class="g g-Whitespace"> </span><span class="mi">155</span> <span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">,</span>
<span class="g g-Whitespace"> </span><span class="mi">156</span> <span class="s1">&#39;The file or folder to load kernel libraries from does not exist.&#39;</span><span class="p">,</span>
<span class="g g-Whitespace"> </span><span class="mi">157</span> <span class="n">library_location</span><span class="p">)</span>
<span class="ne">NotFoundError</span>: dlopen(/Users/mhjensen/miniforge3/envs/myenv/lib/python3.9/site-packages/tensorflow-plugins/libmetal_plugin.dylib, 0x0006): symbol not found in flat namespace &#39;_TF_GetInputPropertiesList&#39;
</pre></div>
</div>
</div>
</div>
</section>
<section id="running-with-keras">
<h2>Running with Keras<a class="headerlink" href="#running-with-keras" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">create_convolutional_neural_network_keras</span><span class="p">(</span><span class="n">input_shape</span><span class="p">,</span> <span class="n">receptive_field</span><span class="p">,</span>
<span class="n">n_filters</span><span class="p">,</span> <span class="n">n_neurons_connected</span><span class="p">,</span> <span class="n">n_categories</span><span class="p">,</span>
<span class="n">eta</span><span class="p">,</span> <span class="n">lmbd</span><span class="p">):</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Sequential</span><span class="p">()</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Conv2D</span><span class="p">(</span><span class="n">n_filters</span><span class="p">,</span> <span class="p">(</span><span class="n">receptive_field</span><span class="p">,</span> <span class="n">receptive_field</span><span class="p">),</span> <span class="n">input_shape</span><span class="o">=</span><span class="n">input_shape</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">&#39;same&#39;</span><span class="p">,</span>
<span class="n">activation</span><span class="o">=</span><span class="s1">&#39;relu&#39;</span><span class="p">,</span> <span class="n">kernel_regularizer</span><span class="o">=</span><span class="n">regularizers</span><span class="o">.</span><span class="n">l2</span><span class="p">(</span><span class="n">lmbd</span><span class="p">)))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">MaxPooling2D</span><span class="p">(</span><span class="n">pool_size</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Flatten</span><span class="p">())</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="n">n_neurons_connected</span><span class="p">,</span> <span class="n">activation</span><span class="o">=</span><span class="s1">&#39;relu&#39;</span><span class="p">,</span> <span class="n">kernel_regularizer</span><span class="o">=</span><span class="n">regularizers</span><span class="o">.</span><span class="n">l2</span><span class="p">(</span><span class="n">lmbd</span><span class="p">)))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="n">n_categories</span><span class="p">,</span> <span class="n">activation</span><span class="o">=</span><span class="s1">&#39;softmax&#39;</span><span class="p">,</span> <span class="n">kernel_regularizer</span><span class="o">=</span><span class="n">regularizers</span><span class="o">.</span><span class="n">l2</span><span class="p">(</span><span class="n">lmbd</span><span class="p">)))</span>
<span class="n">sgd</span> <span class="o">=</span> <span class="n">optimizers</span><span class="o">.</span><span class="n">SGD</span><span class="p">(</span><span class="n">learning_rate</span><span class="o">=</span><span class="n">eta</span><span class="p">)</span>
<span class="n">model</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">loss</span><span class="o">=</span><span class="s1">&#39;categorical_crossentropy&#39;</span><span class="p">,</span> <span class="n">optimizer</span><span class="o">=</span><span class="n">sgd</span><span class="p">,</span> <span class="n">metrics</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;accuracy&#39;</span><span class="p">])</span>
<span class="k">return</span> <span class="n">model</span>
<span class="n">epochs</span> <span class="o">=</span> <span class="mi">100</span>
<span class="n">batch_size</span> <span class="o">=</span> <span class="mi">100</span>
<span class="n">input_shape</span> <span class="o">=</span> <span class="n">X_train</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">4</span><span class="p">]</span>
<span class="n">receptive_field</span> <span class="o">=</span> <span class="mi">3</span>
<span class="n">n_filters</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">n_neurons_connected</span> <span class="o">=</span> <span class="mi">50</span>
<span class="n">n_categories</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">eta_vals</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">logspace</span><span class="p">(</span><span class="o">-</span><span class="mi">5</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">7</span><span class="p">)</span>
<span class="n">lmbd_vals</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">logspace</span><span class="p">(</span><span class="o">-</span><span class="mi">5</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">7</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="final-part">
<h2>Final part<a class="headerlink" href="#final-part" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">CNN_keras</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">eta_vals</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">lmbd_vals</span><span class="p">)),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">object</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">eta</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">eta_vals</span><span class="p">):</span>
<span class="k">for</span> <span class="n">j</span><span class="p">,</span> <span class="n">lmbd</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">lmbd_vals</span><span class="p">):</span>
<span class="n">CNN</span> <span class="o">=</span> <span class="n">create_convolutional_neural_network_keras</span><span class="p">(</span><span class="n">input_shape</span><span class="p">,</span> <span class="n">receptive_field</span><span class="p">,</span>
<span class="n">n_filters</span><span class="p">,</span> <span class="n">n_neurons_connected</span><span class="p">,</span> <span class="n">n_categories</span><span class="p">,</span>
<span class="n">eta</span><span class="p">,</span> <span class="n">lmbd</span><span class="p">)</span>
<span class="n">CNN</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">X_train</span><span class="p">,</span> <span class="n">Y_train</span><span class="p">,</span> <span class="n">epochs</span><span class="o">=</span><span class="n">epochs</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="n">scores</span> <span class="o">=</span> <span class="n">CNN</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">X_test</span><span class="p">,</span> <span class="n">Y_test</span><span class="p">)</span>
<span class="n">CNN_keras</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span> <span class="o">=</span> <span class="n">CNN</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Learning rate = &quot;</span><span class="p">,</span> <span class="n">eta</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Lambda = &quot;</span><span class="p">,</span> <span class="n">lmbd</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Test accuracy: </span><span class="si">%.3f</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">scores</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="nb">print</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="final-visualization">
<h2>Final visualization<a class="headerlink" href="#final-visualization" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># visual representation of grid search</span>
<span class="c1"># uses seaborn heatmap, could probably do this in matplotlib</span>
<span class="kn">import</span> <span class="nn">seaborn</span> <span class="k">as</span> <span class="nn">sns</span>
<span class="n">sns</span><span class="o">.</span><span class="n">set</span><span class="p">()</span>
<span class="n">train_accuracy</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">eta_vals</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">lmbd_vals</span><span class="p">)))</span>
<span class="n">test_accuracy</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">eta_vals</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">lmbd_vals</span><span class="p">)))</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">eta_vals</span><span class="p">)):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">lmbd_vals</span><span class="p">)):</span>
<span class="n">CNN</span> <span class="o">=</span> <span class="n">CNN_keras</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span>
<span class="n">train_accuracy</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span> <span class="o">=</span> <span class="n">CNN</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">X_train</span><span class="p">,</span> <span class="n">Y_train</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">test_accuracy</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span> <span class="o">=</span> <span class="n">CNN</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">X_test</span><span class="p">,</span> <span class="n">Y_test</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="n">figsize</span> <span class="o">=</span> <span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
<span class="n">sns</span><span class="o">.</span><span class="n">heatmap</span><span class="p">(</span><span class="n">train_accuracy</span><span class="p">,</span> <span class="n">annot</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;viridis&quot;</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s2">&quot;Training Accuracy&quot;</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="s2">&quot;$\eta$&quot;</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="s2">&quot;$\lambda$&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="n">figsize</span> <span class="o">=</span> <span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
<span class="n">sns</span><span class="o">.</span><span class="n">heatmap</span><span class="p">(</span><span class="n">test_accuracy</span><span class="p">,</span> <span class="n">annot</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;viridis&quot;</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s2">&quot;Test Accuracy&quot;</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="s2">&quot;$\eta$&quot;</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="s2">&quot;$\lambda$&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="the-cifar01-data-set">
<h2>The CIFAR01 data set<a class="headerlink" href="#the-cifar01-data-set" title="Link to this heading">#</a></h2>
<p>The CIFAR10 dataset contains 60,000 color images in 10 classes, with
6,000 images in each class. The dataset is divided into 50,000
training images and 10,000 testing images. The classes are mutually
exclusive and there is no overlap between them.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">datasets</span><span class="p">,</span> <span class="n">layers</span><span class="p">,</span> <span class="n">models</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="c1"># We import the data set</span>
<span class="p">(</span><span class="n">train_images</span><span class="p">,</span> <span class="n">train_labels</span><span class="p">),</span> <span class="p">(</span><span class="n">test_images</span><span class="p">,</span> <span class="n">test_labels</span><span class="p">)</span> <span class="o">=</span> <span class="n">datasets</span><span class="o">.</span><span class="n">cifar10</span><span class="o">.</span><span class="n">load_data</span><span class="p">()</span>
<span class="c1"># Normalize pixel values to be between 0 and 1 by dividing by 255. </span>
<span class="n">train_images</span><span class="p">,</span> <span class="n">test_images</span> <span class="o">=</span> <span class="n">train_images</span> <span class="o">/</span> <span class="mf">255.0</span><span class="p">,</span> <span class="n">test_images</span> <span class="o">/</span> <span class="mf">255.0</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="verifying-the-data-set">
<h2>Verifying the data set<a class="headerlink" href="#verifying-the-data-set" title="Link to this heading">#</a></h2>
<p>To verify that the dataset looks correct, lets plot the first 25 images from the training set and display the class name below each image.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">class_names</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;airplane&#39;</span><span class="p">,</span> <span class="s1">&#39;automobile&#39;</span><span class="p">,</span> <span class="s1">&#39;bird&#39;</span><span class="p">,</span> <span class="s1">&#39;cat&#39;</span><span class="p">,</span> <span class="s1">&#39;deer&#39;</span><span class="p">,</span>
<span class="s1">&#39;dog&#39;</span><span class="p">,</span> <span class="s1">&#39;frog&#39;</span><span class="p">,</span> <span class="s1">&#39;horse&#39;</span><span class="p">,</span> <span class="s1">&#39;ship&#39;</span><span class="p">,</span> <span class="s1">&#39;truck&#39;</span><span class="p">]</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">10</span><span class="p">))</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">25</span><span class="p">):</span>
<span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xticks</span><span class="p">([])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">yticks</span><span class="p">([])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">grid</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">train_images</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">cmap</span><span class="o">=</span><span class="n">plt</span><span class="o">.</span><span class="n">cm</span><span class="o">.</span><span class="n">binary</span><span class="p">)</span>
<span class="c1"># The CIFAR labels happen to be arrays, </span>
<span class="c1"># which is why you need the extra index</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="n">class_names</span><span class="p">[</span><span class="n">train_labels</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">0</span><span class="p">]])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="set-up-the-model">
<h2>Set up the model<a class="headerlink" href="#set-up-the-model" title="Link to this heading">#</a></h2>
<p>The 6 lines of code below define the convolutional base using a common pattern: a stack of Conv2D and MaxPooling2D layers.</p>
<p>As input, a CNN takes tensors of shape (image_height, image_width, color_channels), ignoring the batch size. If you are new to these dimensions, color_channels refers to (R,G,B). In this example, you will configure our CNN to process inputs of shape (32, 32, 3), which is the format of CIFAR images. You can do this by passing the argument input_shape to our first layer.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">Sequential</span><span class="p">()</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Conv2D</span><span class="p">(</span><span class="mi">32</span><span class="p">,</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">activation</span><span class="o">=</span><span class="s1">&#39;relu&#39;</span><span class="p">,</span> <span class="n">input_shape</span><span class="o">=</span><span class="p">(</span><span class="mi">32</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="mi">3</span><span class="p">)))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">MaxPooling2D</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Conv2D</span><span class="p">(</span><span class="mi">64</span><span class="p">,</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">activation</span><span class="o">=</span><span class="s1">&#39;relu&#39;</span><span class="p">))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">MaxPooling2D</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Conv2D</span><span class="p">(</span><span class="mi">64</span><span class="p">,</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">activation</span><span class="o">=</span><span class="s1">&#39;relu&#39;</span><span class="p">))</span>
<span class="c1"># Let&#39;s display the architecture of our model so far.</span>
<span class="n">model</span><span class="o">.</span><span class="n">summary</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<p>You can see that the output of every Conv2D and MaxPooling2D layer is a 3D tensor of shape (height, width, channels). The width and height dimensions tend to shrink as you go deeper in the network. The number of output channels for each Conv2D layer is controlled by the first argument (e.g., 32 or 64). Typically, as the width and height shrink, you can afford (computationally) to add more output channels in each Conv2D layer.</p>
</section>
<section id="add-dense-layers-on-top">
<h2>Add Dense layers on top<a class="headerlink" href="#add-dense-layers-on-top" title="Link to this heading">#</a></h2>
<p>To complete our model, you will feed the last output tensor from the
convolutional base (of shape (4, 4, 64)) into one or more Dense layers
to perform classification. Dense layers take vectors as input (which
are 1D), while the current output is a 3D tensor. First, you will
flatten (or unroll) the 3D output to 1D, then add one or more Dense
layers on top. CIFAR has 10 output classes, so you use a final Dense
layer with 10 outputs and a softmax activation.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Flatten</span><span class="p">())</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">64</span><span class="p">,</span> <span class="n">activation</span><span class="o">=</span><span class="s1">&#39;relu&#39;</span><span class="p">))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span>
<span class="c1"># Here&#39;s the complete architecture of our model</span>
<span class="n">model</span><span class="o">.</span><span class="n">summary</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<p>As you can see, our (4, 4, 64) outputs were flattened into vectors of shape (1024) before going through two Dense layers.</p>
</section>
<section id="compile-and-train-the-model">
<h2>Compile and train the model<a class="headerlink" href="#compile-and-train-the-model" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">model</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">optimizer</span><span class="o">=</span><span class="s1">&#39;adam&#39;</span><span class="p">,</span>
<span class="n">loss</span><span class="o">=</span><span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">losses</span><span class="o">.</span><span class="n">SparseCategoricalCrossentropy</span><span class="p">(</span><span class="n">from_logits</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span>
<span class="n">metrics</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;accuracy&#39;</span><span class="p">])</span>
<span class="n">history</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">train_images</span><span class="p">,</span> <span class="n">train_labels</span><span class="p">,</span> <span class="n">epochs</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">validation_data</span><span class="o">=</span><span class="p">(</span><span class="n">test_images</span><span class="p">,</span> <span class="n">test_labels</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="finally-evaluate-the-model">
<h2>Finally, evaluate the model<a class="headerlink" href="#finally-evaluate-the-model" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">history</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">&#39;accuracy&#39;</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="s1">&#39;accuracy&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">history</span><span class="o">.</span><span class="n">history</span><span class="p">[</span><span class="s1">&#39;val_accuracy&#39;</span><span class="p">],</span> <span class="n">label</span> <span class="o">=</span> <span class="s1">&#39;val_accuracy&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="s1">&#39;Epoch&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="s1">&#39;Accuracy&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylim</span><span class="p">([</span><span class="mf">0.5</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s1">&#39;lower right&#39;</span><span class="p">)</span>
<span class="n">test_loss</span><span class="p">,</span> <span class="n">test_acc</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">test_images</span><span class="p">,</span> <span class="n">test_labels</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">test_acc</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="building-our-own-cnn-code">
<h2>Building our own CNN code<a class="headerlink" href="#building-our-own-cnn-code" title="Link to this heading">#</a></h2>
<p>Here we present a flexible and readable python code for a CNN
implemented with NumPy. We will present the code, showcase how to use
the codebase and fit a CNN that yields a 99% accuracy on the 28x28
MNIST dataset within reasonable time.</p>
<p><strong>The codes here were developed by Eric Reber and Gregor Kajda during spring 2023.</strong></p>
<p>The CNN is compatible with all schedulers, cost functions and
activation functions discussed in constructing our neural network
codes.</p>
<p>The CNN code consists of different types of Layer classes, including
Convolution2DLayer, Pooling2DLayer, FlattenLayer, FullyConnectedLayer
and OutputLayer, which can be added to the CNN object using the
interface of the CNN class. This allows you to easily construct your
own CNN, as well as allowing you to get used to an interface similar
to that of TensorFlow which is used for real world applications.</p>
<p>Another important feature of this code is that it throws errors if
unreasonable decisions are made (for example using a kernel that is
larger than the image, not using a FlattenLayer, etc), and provides
the user with an informative error message.</p>
<section id="list-of-contents">
<h3>List of contents:<a class="headerlink" href="#list-of-contents" title="Link to this heading">#</a></h3>
<ol class="arabic simple">
<li><p>Schedulers</p></li>
<li><p>Activation Functions</p></li>
<li><p>Cost Functions</p></li>
<li><p>Convolution</p></li>
<li><p>Layers</p></li>
<li><p>CNN</p></li>
<li><p>Some final remarks</p></li>
</ol>
</section>
<section id="schedulers">
<h3>Schedulers<a class="headerlink" href="#schedulers" title="Link to this heading">#</a></h3>
<p>The code below shows object oriented implementations of the Constant,
Momentum, Adagrad, AdagradMomentum, RMS prop and Adam schedulers. All
of the classes belong to the shared abstract Scheduler class, and
share the update_change() and reset() methods allowing for any of the
schedulers to be seamlessly used during the training stage, as will
later be shown in the fit() method of the neural
network. Update_change() only has one parameter, the gradient
(<span class="math notranslate nohighlight">\(\delta^{l}_{j}a^{l-1}_k\)</span>), and returns the change which will be
subtracted from the weights. The reset() function takes no parameters,
and resets the desired variables. For Constant and Momentum, reset
does nothing.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">autograd.numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="k">class</span> <span class="nc">Scheduler</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Abstract class for Schedulers</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">=</span> <span class="n">eta</span>
<span class="c1"># should be overwritten</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="c1"># overwritten if needed</span>
<span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">class</span> <span class="nc">Constant</span><span class="p">(</span><span class="n">Scheduler</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">eta</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">*</span> <span class="n">gradient</span>
<span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">class</span> <span class="nc">Momentum</span><span class="p">(</span><span class="n">Scheduler</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">momentum</span><span class="p">:</span> <span class="nb">float</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">eta</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">momentum</span> <span class="o">=</span> <span class="n">momentum</span>
<span class="bp">self</span><span class="o">.</span><span class="n">change</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">change</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">momentum</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">change</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">*</span> <span class="n">gradient</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">change</span>
<span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">class</span> <span class="nc">Adagrad</span><span class="p">(</span><span class="n">Scheduler</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">eta</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">1e-8</span> <span class="c1"># avoid division ny zero</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">gradient</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">gradient</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="o">+=</span> <span class="n">gradient</span> <span class="o">@</span> <span class="n">gradient</span><span class="o">.</span><span class="n">T</span>
<span class="n">G_t_inverse</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="p">(</span>
<span class="n">delta</span> <span class="o">+</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diagonal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">G_t</span><span class="p">),</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">G_t</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">1</span><span class="p">)))</span>
<span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">*</span> <span class="n">gradient</span> <span class="o">*</span> <span class="n">G_t_inverse</span>
<span class="k">def</span> <span class="nf">reset</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">G_t</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">class</span> <span class="nc">AdagradMomentum</span><span class="p">(</span><span class="n">Scheduler</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">,</span> <span class="n">momentum</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">eta</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">momentum</span> <span class="o">=</span> <span class="n">momentum</span>
<span class="bp">self</span><span class="o">.</span><span class="n">change</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">1e-8</span> <span class="c1"># avoid division ny zero</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">gradient</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">gradient</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G_t</span> <span class="o">+=</span> <span class="n">gradient</span> <span class="o">@</span> <span class="n">gradient</span><span class="o">.</span><span class="n">T</span>
<span class="n">G_t_inverse</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="p">(</span>
<span class="n">delta</span> <span class="o">+</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diagonal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">G_t</span><span class="p">),</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">G_t</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">1</span><span class="p">)))</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">change</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">change</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">momentum</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">*</span> <span class="n">gradient</span> <span class="o">*</span> <span class="n">G_t_inverse</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">change</span>
<span class="k">def</span> <span class="nf">reset</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">G_t</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">class</span> <span class="nc">RMS_prop</span><span class="p">(</span><span class="n">Scheduler</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">,</span> <span class="n">rho</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">eta</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rho</span> <span class="o">=</span> <span class="n">rho</span>
<span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">1e-8</span> <span class="c1"># avoid division ny zero</span>
<span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">+</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho</span><span class="p">)</span> <span class="o">*</span> <span class="n">gradient</span> <span class="o">*</span> <span class="n">gradient</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">*</span> <span class="n">gradient</span> <span class="o">/</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">+</span> <span class="n">delta</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">reset</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">second</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="k">class</span> <span class="nc">Adam</span><span class="p">(</span><span class="n">Scheduler</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eta</span><span class="p">,</span> <span class="n">rho</span><span class="p">,</span> <span class="n">rho2</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">eta</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rho</span> <span class="o">=</span> <span class="n">rho</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rho2</span> <span class="o">=</span> <span class="n">rho2</span>
<span class="bp">self</span><span class="o">.</span><span class="n">moment</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n_epochs</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">def</span> <span class="nf">update_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">gradient</span><span class="p">):</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">1e-8</span> <span class="c1"># avoid division ny zero</span>
<span class="bp">self</span><span class="o">.</span><span class="n">moment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">moment</span> <span class="o">+</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho</span><span class="p">)</span> <span class="o">*</span> <span class="n">gradient</span>
<span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho2</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">+</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho2</span><span class="p">)</span> <span class="o">*</span> <span class="n">gradient</span> <span class="o">*</span> <span class="n">gradient</span>
<span class="n">moment_corrected</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">moment</span> <span class="o">/</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">n_epochs</span><span class="p">)</span>
<span class="n">second_corrected</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">/</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho2</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">n_epochs</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">*</span> <span class="n">moment_corrected</span> <span class="o">/</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">second_corrected</span> <span class="o">+</span> <span class="n">delta</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">reset</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">n_epochs</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">moment</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">second</span> <span class="o">=</span> <span class="mi">0</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="usage-of-schedulers">
<h3>Usage of schedulers<a class="headerlink" href="#usage-of-schedulers" title="Link to this heading">#</a></h3>
<p>To initalize a scheduler, simply create the object and pass in the necessary parameters such as the learning rate and the momentum as shown below. As the Scheduler class is an abstract class it should not called directly, and will raise an error upon usage.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">momentum_scheduler</span> <span class="o">=</span> <span class="n">Momentum</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-3</span><span class="p">,</span> <span class="n">momentum</span><span class="o">=</span><span class="mf">0.9</span><span class="p">)</span>
<span class="n">adam_scheduler</span> <span class="o">=</span> <span class="n">Adam</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-3</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">rho2</span><span class="o">=</span><span class="mf">0.999</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>Here is a small example for how a segment of code using schedulers could look. Switching out the schedulers is simple.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span><span class="mi">3</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Before scheduler:</span><span class="se">\n</span><span class="si">{</span><span class="n">weights</span><span class="si">=}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">epochs</span> <span class="o">=</span> <span class="mi">10</span>
<span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">epochs</span><span class="p">):</span>
<span class="n">gradient</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
<span class="n">change</span> <span class="o">=</span> <span class="n">adam_scheduler</span><span class="o">.</span><span class="n">update_change</span><span class="p">(</span><span class="n">gradient</span><span class="p">)</span>
<span class="n">weights</span> <span class="o">=</span> <span class="n">weights</span> <span class="o">-</span> <span class="n">change</span>
<span class="n">adam_scheduler</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">After scheduler:</span><span class="se">\n</span><span class="si">{</span><span class="n">weights</span><span class="si">=}</span><span class="s2">&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="cost-functions">
<h3>Cost functions<a class="headerlink" href="#cost-functions" title="Link to this heading">#</a></h3>
<p>In this section we will quickly look at cost functions that can be
used when creating the neural network. Every cost function takes the
target vector as its parameter, and returns a function valued only at
X such that it may easily be differentiated.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">CostOLS</span><span class="p">(</span><span class="n">target</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return OLS function valued only at X, so</span>
<span class="sd"> that it may be easily differentiated</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="mf">1.0</span> <span class="o">/</span> <span class="n">target</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">((</span><span class="n">target</span> <span class="o">-</span> <span class="n">X</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span><span class="p">)</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">def</span> <span class="nf">CostLogReg</span><span class="p">(</span><span class="n">target</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return Logistic Regression cost function</span>
<span class="sd"> valued only at X, so that it may be easily differentiated</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">return</span> <span class="o">-</span><span class="p">(</span><span class="mf">1.0</span> <span class="o">/</span> <span class="n">target</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="p">(</span><span class="n">target</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">X</span> <span class="o">+</span> <span class="mf">10e-10</span><span class="p">))</span> <span class="o">+</span> <span class="p">((</span><span class="mi">1</span> <span class="o">-</span> <span class="n">target</span><span class="p">)</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="n">X</span> <span class="o">+</span> <span class="mf">10e-10</span><span class="p">))</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">def</span> <span class="nf">CostCrossEntropy</span><span class="p">(</span><span class="n">target</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return cross entropy cost function valued only at X, so</span>
<span class="sd"> that it may be easily differentiated</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">return</span> <span class="o">-</span><span class="p">(</span><span class="mf">1.0</span> <span class="o">/</span> <span class="n">target</span><span class="o">.</span><span class="n">size</span><span class="p">)</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">target</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">X</span> <span class="o">+</span> <span class="mf">10e-10</span><span class="p">))</span>
<span class="k">return</span> <span class="n">func</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="usage-of-cost-functions">
<h3>Usage of cost functions<a class="headerlink" href="#usage-of-cost-functions" title="Link to this heading">#</a></h3>
<p>Below we will provide a short example of how these cost function may
be used to obtain results if you wish to test them out on your own
using AutoGrads automatic differentiation.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">autograd</span> <span class="kn">import</span> <span class="n">grad</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]])</span><span class="o">.</span><span class="n">T</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]])</span><span class="o">.</span><span class="n">T</span>
<span class="n">cost_func</span> <span class="o">=</span> <span class="n">CostCrossEntropy</span>
<span class="n">cost_func_derivative</span> <span class="o">=</span> <span class="n">grad</span><span class="p">(</span><span class="n">cost_func</span><span class="p">(</span><span class="n">target</span><span class="p">))</span>
<span class="n">valued_at_a</span> <span class="o">=</span> <span class="n">cost_func_derivative</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Derivative of cost function </span><span class="si">{</span><span class="n">cost_func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2"> valued at a:</span><span class="se">\n</span><span class="si">{</span><span class="n">valued_at_a</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="activation-functions">
<h3>Activation functions<a class="headerlink" href="#activation-functions" title="Link to this heading">#</a></h3>
<p>Finally, before we look at the layers that make up the neural network,
we will look at the activation functions which can be specified
between the hidden layers and as the output function. Each function
can be valued for any given vector or matrix X, and can be
differentiated via derivate().</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">autograd.numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">autograd</span> <span class="kn">import</span> <span class="n">elementwise_grad</span>
<span class="k">def</span> <span class="nf">identity</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">return</span> <span class="n">X</span>
<span class="k">def</span> <span class="nf">sigmoid</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="p">(</span><span class="mi">1</span> <span class="o">+</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="n">X</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">FloatingPointError</span><span class="p">:</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">X</span> <span class="o">&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">softmax</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="n">X</span> <span class="o">=</span> <span class="n">X</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">10e-10</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="n">X</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="n">X</span><span class="p">),</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">+</span> <span class="n">delta</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">RELU</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">X</span> <span class="o">&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">X</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">LRELU</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">10e-4</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">X</span> <span class="o">&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">X</span><span class="p">,</span> <span class="n">delta</span> <span class="o">*</span> <span class="n">X</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">derivate</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
<span class="k">if</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;RELU&quot;</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">X</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">elif</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;LRELU&quot;</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">X</span><span class="p">):</span>
<span class="n">delta</span> <span class="o">=</span> <span class="mf">10e-4</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">X</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">delta</span><span class="p">)</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">elementwise_grad</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="usage-of-activation-functions">
<h3>Usage of activation functions<a class="headerlink" href="#usage-of-activation-functions" title="Link to this heading">#</a></h3>
<p>Below we present a short demonstration of how to use an activation
function. The derivative of the activation function will be important
when calculating the output delta term during backpropagation. Note
that derivate() can also be used for cost functions for a more
generalized approach.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">z</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]])</span><span class="o">.</span><span class="n">T</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Input to activation function:</span><span class="se">\n</span><span class="si">{</span><span class="n">z</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">act_func</span> <span class="o">=</span> <span class="n">sigmoid</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">act_func</span><span class="p">(</span><span class="n">z</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Output from </span><span class="si">{</span><span class="n">act_func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2"> activation function:</span><span class="se">\n</span><span class="si">{</span><span class="n">a</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">act_func_derivative</span> <span class="o">=</span> <span class="n">derivate</span><span class="p">(</span><span class="n">act_func</span><span class="p">)</span>
<span class="n">valued_at_z</span> <span class="o">=</span> <span class="n">act_func_derivative</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Derivative of </span><span class="si">{</span><span class="n">act_func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2"> activation function valued at z:</span><span class="se">\n</span><span class="si">{</span><span class="n">valued_at_z</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="convolution">
<h3>Convolution<a class="headerlink" href="#convolution" title="Link to this heading">#</a></h3>
<p>In order to construct a convolutional neural network (CNN), it is
crucial to comprehend the fundamental principles of convolution and
how it aids in extracting information from images. Convolution, at its
core, is merely a mathematical operation between two functions that
yields another function. It is represented by an integral between two
functions, which is typically expressed as:</p>
<div class="math notranslate nohighlight">
\[
(f \ast g)(t):=\int_{-\infty}^{\infty} f(\tau) g(t-\tau) d \tau.
\]</div>
<p>Here, <span class="math notranslate nohighlight">\(f\)</span> and <span class="math notranslate nohighlight">\(g\)</span> are the two functions on which we want to perform an
operation. The outcome of the convolution operation is represented by
<span class="math notranslate nohighlight">\((f \ast g)\)</span>, and it is derived by sliding the function <span class="math notranslate nohighlight">\(g\)</span> over <span class="math notranslate nohighlight">\(f\)</span> and
computing the integral of their product at each position. If both
functions are continuous, convolution takes the form shown
above. However, if we discretize both <span class="math notranslate nohighlight">\(f\)</span> and <span class="math notranslate nohighlight">\(g\)</span>, the convolution
operation will take the form of a sum between the elements of <span class="math notranslate nohighlight">\(f\)</span> and <span class="math notranslate nohighlight">\(g\)</span>:</p>
<div class="math notranslate nohighlight">
\[
(f \ast g)[n]=\sum_{m=0}^{n-1} f(m) g(n-m).
\]</div>
<p>The key idea we utilize to extract the information contained in an
image is to slide an <span class="math notranslate nohighlight">\(m \times n\)</span> matrix <span class="math notranslate nohighlight">\(g\)</span> over an <span class="math notranslate nohighlight">\(m \times n\)</span>
matrix <span class="math notranslate nohighlight">\(f\)</span>. In our case, <span class="math notranslate nohighlight">\(f\)</span> represents the image, while <span class="math notranslate nohighlight">\(g\)</span>
represents the kernel, oftentimes called a filter. However, since our
convolution will be a two-dimensional variant, we need to extend our
mathematical formula with an additional summation:</p>
<div class="math notranslate nohighlight">
\[
(f \ast g)(i, j)\sum_{m=0}^{M-1}\sum_{n=0}^{N-1} f(m,n) g(i-m, j-n).
\]</div>
<p>It is imperative to note that the size of the kernel g is
significantly smaller than the size of the input image f, thereby
reducing the amount of computation necessary for feature
extraction. Furthermore, the kernel is usually a trainable parameter
in a convolutional neural network, allowing the network to learn
appropriate kernels for specific tasks.</p>
<p>To give you an example of how 2D convolution works in practice,
suppose we have an image <span class="math notranslate nohighlight">\(f\)</span> of dimension <span class="math notranslate nohighlight">\(6 \times 6\)</span></p>
<div class="math notranslate nohighlight">
\[\begin{split}
f = \begin{bmatrix}
4 &amp; 1 &amp; 2 &amp; 9 &amp; 8 &amp; 6 \\
9 &amp; 5 &amp; 9 &amp; 5 &amp; 8 &amp; 5 \\
1 &amp; 5 &amp; 9 &amp; 7 &amp; 6 &amp; 4 \\
2 &amp; 9 &amp; 8 &amp; 3 &amp; 7 &amp; 1 \\
8 &amp; 1 &amp; 6 &amp; 4 &amp; 2 &amp; 2 \\
1 &amp; 0 &amp; 5 &amp; 7 &amp; 8 &amp; 2 \\
\end{bmatrix}
\end{split}\]</div>
<p>and a <span class="math notranslate nohighlight">\(3 \times 3\)</span> kernel <span class="math notranslate nohighlight">\(g\)</span> called a low-pass filter. Note that the
kernel is usually rotated by 180 degrees during convolution, however
this has no effect on this kernel.</p>
<div class="math notranslate nohighlight">
\[\begin{split}
g = \frac{1}{9}
\begin{bmatrix}
1 &amp; 1 &amp; 1 \\
1 &amp; 1 &amp; 1 \\
1 &amp; 1 &amp; 1 \\
\end{bmatrix}
\end{split}\]</div>
<p>In order to filter the image, we have to extract a <span class="math notranslate nohighlight">\(3 \times 3\)</span>
element from the upper left corner of <span class="math notranslate nohighlight">\(f\)</span>, and perform element-wise
multiplication of the extracted image pixels with the elements of the
kernel <span class="math notranslate nohighlight">\(g\)</span>:</p>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{bmatrix}
4 &amp; 1 &amp; 2 \\
9 &amp; 5 &amp; 9 \\
1 &amp; 5 &amp; 9 \\
\end{bmatrix}
\cdot
\begin{bmatrix}
\frac{1}{9} &amp; \frac{1}{9} &amp; \frac{1}{9} \\
\frac{1}{9} &amp; \frac{1}{9} &amp; \frac{1}{9} \\
\frac{1}{9} &amp; \frac{1}{9} &amp; \frac{1}{9} \\
\end{bmatrix}
=
\begin{bmatrix}
\frac{4}{9} &amp; \frac{1}{9} &amp; \frac{2}{9} \\
\frac{9}{9} &amp; \frac{5}{9} &amp; \frac{9}{9} \\
\frac{1}{9} &amp; \frac{5}{9} &amp; \frac{9}{9} \\
\end {bmatrix}
= \boldsymbol{A}
\end{split}\]</div>
<p>Then, following the multiplication, we summarize all the elements of the resulting matrix <span class="math notranslate nohighlight">\(\boldsymbol{A}\)</span>:</p>
<div class="math notranslate nohighlight">
\[
(f \ast g)(0, 0)= \sum_{i=0}^{2} \sum_{j=0}^{2} a_{i,j} = 5,
\]</div>
<p>which corresponds to the first element of the filtered image <span class="math notranslate nohighlight">\((f \ast g)\)</span>.</p>
<p>Here we use a stride of <span class="math notranslate nohighlight">\(S=1\)</span>, a parameter denoted <span class="math notranslate nohighlight">\(S\)</span> which describes how
many indexes we move the kernel <span class="math notranslate nohighlight">\(g\)</span> to the right before repeating the
calculations above for the next <span class="math notranslate nohighlight">\(3 \times 3\)</span> element of the image
<span class="math notranslate nohighlight">\(f\)</span>. It is usually presumed that <span class="math notranslate nohighlight">\(S=1\)</span>, however, larger values for <span class="math notranslate nohighlight">\(S\)</span>
can be used to reduce the dimentionality of the filtered image such
that the convolution operation is more computationally efficient. In
the context of a convolutional neural network, this will become very
useful.</p>
<p>The full result of the convolution is:</p>
<div class="math notranslate nohighlight">
\[\begin{split}
(f \ast g) =
\begin{bmatrix}
5 &amp; 5.78 &amp; 7 &amp; 6.44 \\
6.33 &amp; 6.67 &amp; 6.89 &amp; 5.11 \\
5.44 &amp; 5.78 &amp; 5.78 &amp; 4 \\
4.44 &amp; 4.78 &amp; 5.56 &amp; 4 \\
\end{bmatrix}
\end{split}\]</div>
<p>The result is markedly smaller in shape than the original image. This
occurs when using convolution without first padding the image with
additional columns and rows, allowing us to keep the original image
shape after sliding the kernel over the image. How many rows and
columns we wish to pad the image with depends strictly on the shape of
the kernel, as we wish to pad the image with <span class="math notranslate nohighlight">\(r\)</span> additional rows and
<span class="math notranslate nohighlight">\(c\)</span> additional columns.</p>
<div class="math notranslate nohighlight">
\[\begin{split}
r =\lfloor \frac{\mathrm{kernel height}}{2} \rfloor \cdot 2 \\
c =\lfloor \frac{\mathrm{kernel width}}{2} \rfloor \cdot 2
\end{split}\]</div>
<p>Note the notation <span class="math notranslate nohighlight">\(\lfloor \frac{\mathrm{kernel width}}{2} \rfloor\)</span> means that
we floor the result of the division, meaning we round down to a whole
number in case <span class="math notranslate nohighlight">\(\frac{\mathrm{kernel width}}{2}\)</span> results in a floating point
number.</p>
<p>Using those simple equations, we find out by how much we have to
extend the dimensions of the original image. Before proceeding,
however, we might ask what we shall fill the additional rows and
columns with? One of the most common approaches to padding is
zero-padding, which as the name suggest, involves filling the rows and
columns with zeros. This is the approach that we will be using for
this demonstration. If we apply this padding to out original <span class="math notranslate nohighlight">\(6 \times 6\)</span>
image, the result will be an <span class="math notranslate nohighlight">\(8 \times 8\)</span> image as the kernel has a width and
height of 3. Note that the original image is encapsuled by the
zero-padded rows and columns:</p>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{bmatrix}
0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 \\
0 &amp; 4 &amp; 1 &amp; 2 &amp; 9 &amp; 8 &amp; 6 &amp; 0 \\
0 &amp; 9 &amp; 5 &amp; 9 &amp; 5 &amp; 8 &amp; 5 &amp; 0 \\
0 &amp; 1 &amp; 5 &amp; 9 &amp; 7 &amp; 6 &amp; 4 &amp; 0 \\
0 &amp; 2 &amp; 9 &amp; 8 &amp; 3 &amp; 7 &amp; 1 &amp; 0 \\
0 &amp; 8 &amp; 1 &amp; 6 &amp; 4 &amp; 2 &amp; 2 &amp; 0 \\
0 &amp; 1 &amp; 0 &amp; 5 &amp; 7 &amp; 8 &amp; 2 &amp; 0 \\
0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 &amp; 0 \\
\end{bmatrix}.
\end{split}\]</div>
<p>Below we have provided code that demonstrates padding and
convolution. As you will see when we run the code, the size of the
image will remain unchanged when using padding.~</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="k">def</span> <span class="nf">padding</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">):</span>
<span class="c1"># calculate r and c</span>
<span class="n">r</span> <span class="o">=</span> <span class="p">(</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">c</span> <span class="o">=</span> <span class="p">(</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="c1"># padded image dimensions</span>
<span class="n">padded_height</span> <span class="o">=</span> <span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">r</span>
<span class="n">padded_width</span> <span class="o">=</span> <span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">c</span>
<span class="c1"># for more readable code</span>
<span class="n">k_half_height</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">k_half_width</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="c1"># zero matrix with padded dimensions</span>
<span class="n">padded_img</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">padded_height</span><span class="p">,</span> <span class="n">padded_width</span><span class="p">))</span>
<span class="c1"># place image into zero matrix</span>
<span class="n">padded_img</span><span class="p">[</span><span class="n">k_half_height</span> <span class="p">:</span> <span class="n">padded_height</span> <span class="o">-</span> <span class="n">k_half_height</span><span class="p">,</span>
<span class="n">k_half_width</span> <span class="p">:</span> <span class="n">padded_width</span> <span class="o">-</span> <span class="n">k_half_width</span><span class="p">]</span> <span class="o">=</span> <span class="n">image</span><span class="p">[:,</span> <span class="p">:]</span>
<span class="k">return</span> <span class="n">padded_img</span>
<span class="k">def</span> <span class="nf">convolve</span><span class="p">(</span><span class="n">original_image</span><span class="p">,</span> <span class="n">padded_image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">,</span> <span class="n">stride</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="c1"># rotate kernel by 180 degrees</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="n">kernel</span><span class="p">))</span>
<span class="c1"># note that kernel height // 2 is written as &#39;m&#39;</span>
<span class="c1"># and kernel width // 2 as &#39;n&#39; in the mathematical notation</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">r</span> <span class="o">=</span> <span class="p">(</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">c</span> <span class="o">=</span> <span class="p">(</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="c1"># initialize output array</span>
<span class="n">convolved_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">original_image</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">image_height</span> <span class="o">=</span> <span class="n">original_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">image_width</span> <span class="o">=</span> <span class="n">original_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># the convolution</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">image_height</span> <span class="o">+</span> <span class="n">m</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">image_width</span> <span class="o">+</span> <span class="n">n</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="n">convolved_image</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="n">m</span><span class="p">,</span> <span class="n">j</span><span class="o">-</span><span class="n">n</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="n">padded_image</span><span class="p">[</span><span class="n">i</span> <span class="p">:</span> <span class="n">i</span> <span class="o">+</span> <span class="n">m</span><span class="p">,</span> <span class="n">j</span> <span class="p">:</span> <span class="n">j</span> <span class="o">+</span> <span class="n">n</span><span class="p">]</span>
<span class="o">*</span> <span class="n">kernel</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">convolved_image</span>
<span class="k">def</span> <span class="nf">convolve</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">,</span> <span class="n">stride</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="n">kernel</span><span class="p">)</span>
<span class="n">k_half_height</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">k_half_width</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">conv_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">pad_image</span> <span class="o">=</span> <span class="n">padding</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">k_half_height</span><span class="p">,</span> <span class="n">conv_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">k_half_height</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">k_half_width</span><span class="p">,</span> <span class="n">conv_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">k_half_width</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="n">conv_image</span><span class="p">[</span><span class="n">i</span> <span class="o">-</span> <span class="n">k_half_height</span><span class="p">,</span> <span class="n">j</span> <span class="o">-</span> <span class="n">k_half_width</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="n">pad_image</span><span class="p">[</span>
<span class="n">i</span> <span class="o">-</span> <span class="n">k_half_height</span> <span class="p">:</span> <span class="n">i</span> <span class="o">+</span> <span class="n">k_half_height</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">j</span> <span class="o">-</span> <span class="n">k_half_width</span> <span class="p">:</span> <span class="n">j</span> <span class="o">+</span> <span class="n">k_half_width</span> <span class="o">+</span> <span class="mi">1</span>
<span class="p">]</span>
<span class="o">*</span> <span class="n">kernel</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">conv_image</span>
</pre></div>
</div>
</div>
</div>
<p>Fun fact: When filtering images, you will see that convolution
involves rotating the kernel by 180 degrees. However, this is not the
case when applying convolution in a CNN, where the same operation that is not
rotated by 180 degrees is called cross-correlation, which is normally implemented in most libraries.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">original_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">6</span><span class="p">],</span>
<span class="p">[</span><span class="mi">9</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">5</span><span class="p">],</span>
<span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">4</span><span class="p">],</span>
<span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span>
<span class="p">[</span><span class="mi">8</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span>
<span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">2</span><span class="p">]])</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="o">/</span><span class="mi">9</span><span class="p">)</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="mi">3</span><span class="p">,</span><span class="mi">3</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">original_image</span><span class="o">.</span><span class="n">shape</span><span class="si">=}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="c1"># note that convolve() performs padding</span>
<span class="n">convolved_image</span> <span class="o">=</span> <span class="n">convolve</span><span class="p">(</span><span class="n">original_image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">,</span> <span class="n">stride</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convolved_image</span><span class="o">.</span><span class="n">shape</span><span class="si">=}</span><span class="s2">&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>As you can see, the resulting image is of the same size as the
original image. To round of our demonstration of convolution, we will
present the results of convolution using commonly used kernels. In a
CNN, the values of the kernels are randomly initialized, and then
learned during training. These kernels will extract information
regarding the picture, such as for example the edge detection filter
demonstrated below extracts the edges present in the picture. Of
course, there is no guarantee that the CNN will learn an edge
detection filter, but this should provide some intuiton as to how the
CNN is able to use kernels to make better predictions than a regular
feed forward neural network.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Now an example using a real image and first a gaussian low-pass filter and then a Sobel filter</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">imageio.v3</span> <span class="k">as</span> <span class="nn">imageio</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="k">def</span> <span class="nf">generate_gauss_mask</span><span class="p">(</span><span class="n">sigma</span><span class="p">,</span> <span class="n">K</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="n">side</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="mi">1</span> <span class="o">+</span> <span class="mi">8</span> <span class="o">*</span> <span class="n">sigma</span><span class="p">)</span>
<span class="n">y</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mgrid</span><span class="p">[</span><span class="o">-</span><span class="n">side</span> <span class="o">//</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span> <span class="p">:</span> <span class="p">(</span><span class="n">side</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="n">side</span> <span class="o">//</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span> <span class="p">:</span> <span class="p">(</span><span class="n">side</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span>
<span class="n">ker_coef</span> <span class="o">=</span> <span class="n">K</span> <span class="o">/</span> <span class="p">(</span><span class="mi">2</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span> <span class="o">*</span> <span class="n">sigma</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
<span class="n">g</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="p">((</span><span class="n">x</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="n">y</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="mf">2.0</span> <span class="o">*</span> <span class="n">sigma</span><span class="o">**</span><span class="mi">2</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">g</span><span class="p">,</span> <span class="n">ker_coef</span>
<span class="n">img_path</span> <span class="o">=</span> <span class="s2">&quot;data/IMG-2167.JPG&quot;</span>
<span class="n">image_of_cute_dog</span> <span class="o">=</span> <span class="n">imageio</span><span class="o">.</span><span class="n">imread</span><span class="p">(</span><span class="n">img_path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">&#39;L&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">image_of_cute_dog</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">aspect</span><span class="o">=</span><span class="s2">&quot;auto&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Original image&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="n">gauss</span><span class="p">,</span> <span class="n">kernel</span> <span class="o">=</span> <span class="n">generate_gauss_mask</span><span class="p">(</span><span class="n">sigma</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
<span class="n">gauss_kernel</span> <span class="o">=</span> <span class="n">gauss</span><span class="o">*</span><span class="n">kernel</span>
<span class="n">filtered_image</span> <span class="o">=</span> <span class="n">convolve</span><span class="p">(</span><span class="n">image_of_cute_dog</span><span class="p">,</span> <span class="n">gauss_kernel</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">filtered_image</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">aspect</span><span class="o">=</span><span class="s2">&quot;auto&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Result of convolution with gauss kernel (blurring filter)&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="n">sobel_kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span>
<span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span>
<span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">]])</span>
<span class="n">filtered_image</span> <span class="o">=</span> <span class="n">convolve</span><span class="p">(</span><span class="n">image_of_cute_dog</span><span class="p">,</span> <span class="n">sobel_kernel</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">filtered_image</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">aspect</span><span class="o">=</span><span class="s2">&quot;auto&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Result of convolution with sobel kernel (edge detection filter)&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="layers">
<h3>Layers<a class="headerlink" href="#layers" title="Link to this heading">#</a></h3>
<p>The code below initialises global variables for readability and
describes the abstract class Layers. This is not important in order to
understand the CNN, but is benefitial for organizing the code neatly.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">math</span>
<span class="kn">import</span> <span class="nn">autograd.numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span><span class="p">,</span> <span class="n">copy</span>
<span class="kn">from</span> <span class="nn">autograd</span> <span class="kn">import</span> <span class="n">grad</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span>
<span class="c1"># global variables for index readability</span>
<span class="n">input_index</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">node_index</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">bias_index</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">input_channel_index</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">feature_maps_index</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">height_index</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">width_index</span> <span class="o">=</span> <span class="mi">3</span>
<span class="n">kernel_feature_maps_index</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">kernel_input_channels_index</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">class</span> <span class="nc">Layer</span><span class="p">:</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">seed</span> <span class="o">=</span> <span class="n">seed</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="k">def</span> <span class="nf">_reset_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">previous_nodes</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="convolution2dlayer-convolution-in-a-hidden-layer">
<h3>Convolution2DLayer: convolution in a hidden layer<a class="headerlink" href="#convolution2dlayer-convolution-in-a-hidden-layer" title="Link to this heading">#</a></h3>
<p>After establishing the foundational understanding of applying
convolution to spatial data, let us delve into the intricate workings
of a convolutional layer in a Convolutional Neural Network (CNN). The
primary function of convolution, as previously discussed, is to
extract pertinent information from images while simultaneously
decreasing the scale of our data. To initiate the image processing, we
shall begin by partitioning the images into color channels (unless the
image is grayscale), comprising three primary colors: red, green, and
blue. We will subsequently utilize trainable kernels to construct a
higher-dimensional encoding of each channel called feature
maps. Successive layers will receive these feature maps as inputs,
generating further encodings, albeit with reduced dimensions. The term
trainable kernels denotes the initialization of pre-defined
kernel-shaped weights, which we will then train via backpropagation,
similar to how weights are trained in a Feedforward Neural Network.</p>
<p>To ensure seamless integration between our implementation of the
convolutional layer and popular machine learning frameworks like
Tensorflow (Keras) and PyTorch, we have adopted a design pattern that
mirrors the construction of models using these APIs. This involves
implementing our convolutional layer as a Python class or object,
which allows for a more modular and flexible approach to building
neural networks. By structuring our code in this way, users can easily
incorporate our implementation into their existing machine learning
pipelines without having to make significant changes to their
codebase. Additionally, this design pattern promotes code reusability
and makes it easier to maintain and update our convolutional layer
implementation over time.</p>
<p>Note that the Convolution2DLayer takes in an activation function as a parameter, as it also performs non-linearity.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Convolution2DLayer</span><span class="p">(</span><span class="n">Layer</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">input_channels</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="p">,</span>
<span class="n">v_stride</span><span class="p">,</span>
<span class="n">h_stride</span><span class="p">,</span>
<span class="n">pad</span><span class="p">,</span>
<span class="n">act_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span>
<span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">reset_weights_independently</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span> <span class="o">=</span> <span class="n">input_channels</span>
<span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span> <span class="o">=</span> <span class="n">feature_maps</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">=</span> <span class="n">kernel_height</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span> <span class="o">=</span> <span class="n">kernel_width</span>
<span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">=</span> <span class="n">v_stride</span>
<span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">=</span> <span class="n">h_stride</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pad</span> <span class="o">=</span> <span class="n">pad</span>
<span class="bp">self</span><span class="o">.</span><span class="n">act_func</span> <span class="o">=</span> <span class="n">act_func</span>
<span class="c1"># such that the layer can be used on its own</span>
<span class="c1"># outside of the CNN module</span>
<span class="k">if</span> <span class="n">reset_weights_independently</span> <span class="o">==</span> <span class="kc">True</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_reset_weights_independently</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">):</span>
<span class="c1"># note that the shape of X_batch = [inputs, input_maps, img_height, img_width]</span>
<span class="c1"># pad the input batch</span>
<span class="n">X_batch_padded</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_padding</span><span class="p">(</span><span class="n">X_batch</span><span class="p">)</span>
<span class="c1"># calculate height_index and width_index after stride</span>
<span class="n">strided_height</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">))</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">))</span>
<span class="c1"># create output array</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span><span class="p">,</span>
<span class="n">strided_height</span><span class="p">,</span>
<span class="n">strided_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># save input and output for backpropagation</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span> <span class="o">=</span> <span class="n">X_batch</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output_shape</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">shape</span>
<span class="c1"># checking for errors, no need to look here :)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_check_for_errors</span><span class="p">()</span>
<span class="c1"># convolve input with kernel</span>
<span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">chin</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">):</span>
<span class="k">for</span> <span class="n">fmap</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span><span class="p">):</span>
<span class="n">out_h</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">):</span>
<span class="n">out_w</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">):</span>
<span class="n">output</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="n">out_h</span><span class="p">,</span> <span class="n">out_w</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="n">X_batch_padded</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">chin</span><span class="p">,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel</span><span class="p">[</span><span class="n">chin</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:]</span>
<span class="p">)</span>
<span class="n">out_w</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">out_h</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="c1"># Pay attention to the fact that we&#39;re not rotating the kernel by 180 degrees when filtering the image in</span>
<span class="c1"># the convolutional layer, as convolution in terms of Machine Learning is a procedure known as cross-correlation</span>
<span class="c1"># in image processing and signal processing</span>
<span class="c1"># return a</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">(</span><span class="n">output</span> <span class="o">/</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="p">):</span>
<span class="c1"># intiate matrices</span>
<span class="n">delta_term</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="n">gradient_kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="c1"># pad input for convolution</span>
<span class="n">X_batch_padded</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_padding</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="p">)</span>
<span class="c1"># Since an activation function is used at the output of the convolution layer, its derivative</span>
<span class="c1"># has to be accounted for in the backpropagation -&gt; as if ReLU was a layer on its own.</span>
<span class="n">act_derivative</span> <span class="o">=</span> <span class="n">derivate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">)</span>
<span class="n">delta_term_next</span> <span class="o">=</span> <span class="n">act_derivative</span><span class="p">(</span><span class="n">delta_term_next</span><span class="p">)</span>
<span class="c1"># fill in 0&#39;s for values removed by vertical stride in feedforward</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">v_ind</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">delta_term_next</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">delta_term_next</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span>
<span class="n">delta_term_next</span><span class="p">,</span> <span class="n">v_ind</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">height_index</span>
<span class="p">)</span>
<span class="n">v_ind</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span>
<span class="c1"># fill in 0&#39;s for values removed by horizontal stride in feedforward</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">h_ind</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">delta_term_next</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">delta_term_next</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span>
<span class="n">delta_term_next</span><span class="p">,</span> <span class="n">h_ind</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">width_index</span>
<span class="p">)</span>
<span class="n">h_ind</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span>
<span class="c1"># crops out 0-rows and 0-columns</span>
<span class="n">delta_term_next</span> <span class="o">=</span> <span class="n">delta_term_next</span><span class="p">[</span>
<span class="p">:,</span>
<span class="p">:,</span>
<span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span>
<span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="p">]</span>
<span class="c1"># the gradient received from the next layer also needs to be padded</span>
<span class="n">delta_term_next</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_padding</span><span class="p">(</span><span class="n">delta_term_next</span><span class="p">)</span>
<span class="c1"># calculate delta term by convolving next delta term with kernel</span>
<span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">chin</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">):</span>
<span class="k">for</span> <span class="n">fmap</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span><span class="p">):</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]):</span>
<span class="n">delta_term</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="n">chin</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="n">delta_term_next</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">fmap</span><span class="p">,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel</span><span class="p">[</span><span class="n">chin</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:]))</span>
<span class="p">)</span>
<span class="c1"># calculate gradient for kernel for weight update</span>
<span class="c1"># also via convolution</span>
<span class="k">for</span> <span class="n">chin</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">):</span>
<span class="k">for</span> <span class="n">fmap</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span><span class="p">):</span>
<span class="k">for</span> <span class="n">k_x</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">):</span>
<span class="k">for</span> <span class="n">k_y</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">):</span>
<span class="n">gradient_kernel</span><span class="p">[</span><span class="n">chin</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="n">k_x</span><span class="p">,</span> <span class="n">k_y</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="n">X_batch_padded</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">chin</span><span class="p">,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="o">*</span> <span class="n">delta_term_next</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">fmap</span><span class="p">,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">)</span>
<span class="c1"># all kernels are updated with weight gradient of kernel</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel</span> <span class="o">-=</span> <span class="n">gradient_kernel</span>
<span class="c1"># return delta term</span>
<span class="k">return</span> <span class="n">delta_term</span>
<span class="k">def</span> <span class="nf">_padding</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">,</span> <span class="n">batch_type</span><span class="o">=</span><span class="s2">&quot;image&quot;</span><span class="p">):</span>
<span class="c1"># same padding for images</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pad</span> <span class="o">==</span> <span class="s2">&quot;same&quot;</span> <span class="ow">and</span> <span class="n">batch_type</span> <span class="o">==</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span>
<span class="n">padded_height</span> <span class="o">=</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">padded_width</span> <span class="o">=</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">half_kernel_height</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">half_kernel_width</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span> <span class="o">//</span> <span class="mi">2</span>
<span class="c1"># initialize padded array</span>
<span class="n">X_batch_padded</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">],</span>
<span class="n">padded_height</span><span class="p">,</span>
<span class="n">padded_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># zero pad all images in X_batch</span>
<span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]):</span>
<span class="n">padded_img</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
<span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">],</span> <span class="n">padded_height</span><span class="p">,</span> <span class="n">padded_width</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">padded_img</span><span class="p">[</span>
<span class="p">:,</span>
<span class="n">half_kernel_height</span> <span class="p">:</span> <span class="n">padded_height</span> <span class="o">-</span> <span class="n">half_kernel_height</span><span class="p">,</span>
<span class="n">half_kernel_width</span> <span class="p">:</span> <span class="n">padded_width</span> <span class="o">-</span> <span class="n">half_kernel_width</span><span class="p">,</span>
<span class="p">]</span> <span class="o">=</span> <span class="n">X_batch</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:]</span>
<span class="n">X_batch_padded</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:]</span> <span class="o">=</span> <span class="n">padded_img</span><span class="p">[:,</span> <span class="p">:,</span> <span class="p">:]</span>
<span class="k">return</span> <span class="n">X_batch_padded</span>
<span class="c1"># same padding for gradients</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">pad</span> <span class="o">==</span> <span class="s2">&quot;same&quot;</span> <span class="ow">and</span> <span class="n">batch_type</span> <span class="o">==</span> <span class="s2">&quot;grad&quot;</span><span class="p">:</span>
<span class="n">padded_height</span> <span class="o">=</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">padded_width</span> <span class="o">=</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span> <span class="o">//</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">half_kernel_height</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">half_kernel_width</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span> <span class="o">//</span> <span class="mi">2</span>
<span class="c1"># initialize padded array</span>
<span class="n">delta_term_padded</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">],</span>
<span class="n">padded_height</span><span class="p">,</span>
<span class="n">padded_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># zero pad delta term</span>
<span class="n">delta_term_padded</span><span class="p">[</span>
<span class="p">:,</span> <span class="p">:,</span> <span class="p">:</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span> <span class="p">:</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span>
<span class="p">]</span> <span class="o">=</span> <span class="n">X_batch</span><span class="p">[:,</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:]</span>
<span class="k">return</span> <span class="n">delta_term_padded</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">X_batch</span>
<span class="k">def</span> <span class="nf">_reset_weights_independently</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># sets seed to remove randomness inbetween runs</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">)</span>
<span class="c1"># initializes kernel matrix</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">(</span>
<span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># randomly initializes weights</span>
<span class="k">for</span> <span class="n">chin</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">kernel_input_channels_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">fmap</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">kernel_feature_maps_index</span><span class="p">]):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel</span><span class="p">[</span><span class="n">chin</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_reset_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">previous_nodes</span><span class="p">):</span>
<span class="c1"># sets weights</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_reset_weights_independently</span><span class="p">()</span>
<span class="c1"># returns shape of output used for subsequent layer&#39;s weight initiation</span>
<span class="n">strided_height</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
<span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">))</span>
<span class="n">next_nodes</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">feature_maps</span><span class="p">,</span>
<span class="n">strided_height</span><span class="p">,</span>
<span class="n">strided_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">next_nodes</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span>
<span class="k">def</span> <span class="nf">_check_for_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_channel_index</span><span class="p">]</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;ERROR: Number of input channels in data (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_channel_index</span><span class="p">]</span><span class="si">}</span><span class="s2">) is not equal to input channels in Convolution2DLayerOPT (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="si">}</span><span class="s2">)! Please change the number of input channels of the Convolution2DLayer such that they are equal&quot;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="backpropagation-in-the-convolutional-layer">
<h3>Backpropagation in the convolutional layer<a class="headerlink" href="#backpropagation-in-the-convolutional-layer" title="Link to this heading">#</a></h3>
<p>As you may have noticed, we have not yet explained how the
backpropagation algorithm works in a convolutional layer. However,
having covered all other major details about convolutional layers, we
are now prepared to do so. It should come as no surprise that the
calculation of delta terms at each convolutional layer takes the form
of convolution. After the gradient has been propagated backwards
through the flattening layer, where it was reshaped into an
appropriate form, calculating the update value for the kernel is
simply a matter of convolving the output gradient with the input of
the layer for which we are updating the weights. For more detail, this
article serves as an excellent resource, see
<a class="reference external" href="https://pavisj.medium.com/convolutions-and-backpropagations-46026a8f5d2c">https://pavisj.medium.com/convolutions-and-backpropagations-46026a8f5d2c</a></p>
</section>
<section id="demonstration">
<h3>Demonstration<a class="headerlink" href="#demonstration" title="Link to this heading">#</a></h3>
<p>We can use the convolutional layer above to perform a simple convolution on an image of the now familiar cute dog.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">imageio.v3</span> <span class="k">as</span> <span class="nn">imageio</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="k">def</span> <span class="nf">plot_convolution_result</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">layer</span><span class="p">):</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">X</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:],</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Original image&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="n">conv_result</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_feedforward</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Result of convolutional layer&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">conv_result</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:],</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
<span class="c1"># create layer</span>
<span class="n">layer</span> <span class="o">=</span> <span class="n">Convolution2DLayer</span><span class="p">(</span>
<span class="n">input_channels</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
<span class="n">v_stride</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">h_stride</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">pad</span><span class="o">=</span><span class="s2">&quot;same&quot;</span><span class="p">,</span>
<span class="n">act_func</span><span class="o">=</span><span class="n">identity</span><span class="p">,</span>
<span class="n">seed</span><span class="o">=</span><span class="mi">2023</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># read in image path, make data correct format</span>
<span class="n">img_path</span> <span class="o">=</span> <span class="n">img_path</span> <span class="o">=</span> <span class="s2">&quot;data/IMG-2167.JPG&quot;</span>
<span class="n">image_of_cute_dog</span> <span class="o">=</span> <span class="n">imageio</span><span class="o">.</span><span class="n">imread</span><span class="p">(</span><span class="n">img_path</span><span class="p">)</span>
<span class="n">image_shape</span> <span class="o">=</span> <span class="n">image_of_cute_dog</span><span class="o">.</span><span class="n">shape</span>
<span class="n">image_of_cute_dog</span> <span class="o">=</span> <span class="n">image_of_cute_dog</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">image_shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">image_shape</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">image_shape</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
<span class="n">image_of_cute_dog</span> <span class="o">=</span> <span class="n">image_of_cute_dog</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="c1"># plot the result of the convolution</span>
<span class="n">plot_convolution_result</span><span class="p">(</span><span class="n">image_of_cute_dog</span><span class="p">,</span> <span class="n">layer</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>We cobserve that the result has half the pixels on each axis due to
the fact that weve used a horizontal and vertical stride of 2. The
result of this convolution is not very insightfull, as the kernel has
completely random values for the first feedforward pass. However, as
we perform multiple forward and backward passes, the results of the
convolution should provide identifying features of the image it uses
for classification.</p>
<p>Note that image data usually comes in many different shapes and sizes,
but for our CNN we require the input data be formatted as [Number of
inputs, input channels, input height, input width]. Occasionally, the
data you come accross use will be formatted like this, but on many
occasions reshaping and transposing the dimensions is sadly necessary.</p>
</section>
<section id="pooling-layer">
<h3>Pooling Layer<a class="headerlink" href="#pooling-layer" title="Link to this heading">#</a></h3>
<p>The pooling layer is another widely used type of layer in
convolutional neural networks that enables data downsampling to a more
manageable size. Despite recent technological advancements that allow
for convolution without excessive size reduction of the data, the
pooling layer still remains a fundamental component of convolutional
neural networks. It can be used before, after, or in between
convolutional layers, although finding the optimal placement of layers
and network depth requires experimentation to achieve the best
performance for a given problem. The code we provide allows you to
perform two types of pooling known as max pooling and average pooling.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Pooling2DLayer</span><span class="p">(</span><span class="n">Layer</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="p">,</span>
<span class="n">v_stride</span><span class="p">,</span>
<span class="n">h_stride</span><span class="p">,</span>
<span class="n">pooling</span><span class="o">=</span><span class="s2">&quot;max&quot;</span><span class="p">,</span>
<span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">=</span> <span class="n">kernel_height</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span> <span class="o">=</span> <span class="n">kernel_width</span>
<span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">=</span> <span class="n">v_stride</span>
<span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">=</span> <span class="n">h_stride</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pooling</span> <span class="o">=</span> <span class="n">pooling</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">):</span>
<span class="c1"># Saving the input for use in the backwardpass</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span> <span class="o">=</span> <span class="n">X_batch</span>
<span class="c1"># check if user is silly</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_check_for_errors</span><span class="p">()</span>
<span class="c1"># Computing the size of the feature maps based on kernel size and the stride parameter</span>
<span class="n">strided_height</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span>
<span class="p">)</span> <span class="o">//</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">==</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]:</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="n">strided_height</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span>
<span class="p">)</span> <span class="o">//</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">+</span> <span class="mi">1</span>
<span class="c1"># initialize output array</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">],</span>
<span class="n">strided_height</span><span class="p">,</span>
<span class="n">strided_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># select pooling action, either max or average pooling</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pooling</span> <span class="o">==</span> <span class="s2">&quot;max&quot;</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pooling_action</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">max</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">pooling</span> <span class="o">==</span> <span class="s2">&quot;average&quot;</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pooling_action</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span>
<span class="c1"># pool based on kernel size and stride</span>
<span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">output</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">fmap</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">output</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">strided_height</span><span class="p">):</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">strided_width</span><span class="p">):</span>
<span class="n">output</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pooling_action</span><span class="p">(</span>
<span class="n">X_batch</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">fmap</span><span class="p">,</span>
<span class="p">(</span><span class="n">h</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">)</span> <span class="p">:</span> <span class="p">(</span><span class="n">h</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">)</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="p">(</span><span class="n">w</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">)</span> <span class="p">:</span> <span class="p">(</span><span class="n">w</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">)</span>
<span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">)</span>
<span class="c1"># output for feedforward in next layer</span>
<span class="k">return</span> <span class="n">output</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="p">):</span>
<span class="c1"># initiate delta term array</span>
<span class="n">delta_term</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">delta_term_next</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">fmap</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">delta_term_next</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">):</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span>
<span class="mi">0</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span>
<span class="p">):</span>
<span class="c1"># max pooling</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pooling</span> <span class="o">==</span> <span class="s2">&quot;max&quot;</span><span class="p">:</span>
<span class="c1"># get window</span>
<span class="n">window</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">fmap</span><span class="p">,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="c1"># find max values indices in window</span>
<span class="n">max_h</span><span class="p">,</span> <span class="n">max_w</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">unravel_index</span><span class="p">(</span>
<span class="n">window</span><span class="o">.</span><span class="n">argmax</span><span class="p">(),</span> <span class="n">window</span><span class="o">.</span><span class="n">shape</span>
<span class="p">)</span>
<span class="c1"># set values in new, upsampled delta term</span>
<span class="n">delta_term</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">fmap</span><span class="p">,</span>
<span class="p">(</span><span class="n">h</span> <span class="o">+</span> <span class="n">max_h</span><span class="p">),</span>
<span class="p">(</span><span class="n">w</span> <span class="o">+</span> <span class="n">max_w</span><span class="p">),</span>
<span class="p">]</span> <span class="o">+=</span> <span class="n">delta_term_next</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span><span class="p">]</span>
<span class="c1"># average pooling</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pooling</span> <span class="o">==</span> <span class="s2">&quot;average&quot;</span><span class="p">:</span>
<span class="n">delta_term</span><span class="p">[</span>
<span class="n">img</span><span class="p">,</span>
<span class="n">fmap</span><span class="p">,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">delta_term_next</span><span class="p">[</span><span class="n">img</span><span class="p">,</span> <span class="n">fmap</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span><span class="p">]</span>
<span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span>
<span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span>
<span class="p">)</span>
<span class="c1"># returns input to backpropagation in previous layer</span>
<span class="k">return</span> <span class="n">delta_term</span>
<span class="k">def</span> <span class="nf">_reset_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">previous_nodes</span><span class="p">):</span>
<span class="c1"># calculate strided height, strided width</span>
<span class="n">strided_height</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span>
<span class="p">)</span> <span class="o">//</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">==</span> <span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]:</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="n">strided_height</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span>
<span class="p">)</span> <span class="o">//</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">+</span> <span class="mi">1</span>
<span class="c1"># initiate output array</span>
<span class="n">output</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">],</span>
<span class="n">strided_height</span><span class="p">,</span>
<span class="n">strided_width</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># returns output with shape used for reset weights in next layer</span>
<span class="k">return</span> <span class="n">output</span>
<span class="k">def</span> <span class="nf">_check_for_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># check if input is smaller than kernel size -&gt; error</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span>
<span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;ERROR: Pooling kernel width_index (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="si">}</span><span class="s2">) larger than data width_index (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">input</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="si">}</span><span class="s2">), please lower the kernel width_index of the Pooling2DLayer&quot;</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span>
<span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;ERROR: Pooling kernel height_index (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="si">}</span><span class="s2">) larger than data height_index (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">input</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="si">}</span><span class="s2">), please lower the kernel height_index of the Pooling2DLayer&quot;</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="flattening-layer">
<h3>Flattening Layer<a class="headerlink" href="#flattening-layer" title="Link to this heading">#</a></h3>
<p>Before we can begin building our first CNN model, we need to introduce
the flattening layer. As its name suggests, the flattening layer
transforms the data into a one-dimensional vector that can be fed into
the feedforward layers of our network. This layer plays a crucial role
in preparing the data for further processing in the
network. Additionally, the flattening layer is responsible for
reshaping the gradient to the proper shape during
backpropagation. This ensures that the kernels are correctly updated,
allowing for effective learning in the network.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">FlattenLayer</span><span class="p">(</span><span class="n">Layer</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">act_func</span> <span class="o">=</span> <span class="n">act_func</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">):</span>
<span class="c1"># save input for backpropagation</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward_shape</span> <span class="o">=</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span>
<span class="c1"># Remember, the data has the following shape: (I, FM, H, W, ) in the convolutional layers</span>
<span class="c1"># whilst the data has the shape (I, FM * H * W) in the fully connected layers</span>
<span class="c1"># I = Inputs, FM = Feature Maps, H = Height and W = Width.</span>
<span class="n">X_batch</span> <span class="o">=</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="p">)</span>
<span class="c1"># add bias to a</span>
<span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span> <span class="o">=</span> <span class="n">X_batch</span>
<span class="n">bias</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span> <span class="mi">1</span><span class="p">))</span> <span class="o">*</span> <span class="mf">0.01</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">hstack</span><span class="p">([</span><span class="n">bias</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">])</span>
<span class="c1"># return a, the input to feedforward in next layer</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">weights_next</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="p">):</span>
<span class="n">activation_derivative</span> <span class="o">=</span> <span class="n">derivate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">)</span>
<span class="c1"># calculate delta term</span>
<span class="n">delta_term</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">weights_next</span><span class="p">[</span><span class="n">bias_index</span><span class="p">:,</span> <span class="p">:]</span> <span class="o">@</span> <span class="n">delta_term_next</span><span class="o">.</span><span class="n">T</span>
<span class="p">)</span><span class="o">.</span><span class="n">T</span> <span class="o">*</span> <span class="n">activation_derivative</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span><span class="p">)</span>
<span class="c1"># FlattenLayer does not update weights</span>
<span class="c1"># reshapes delta layer to convolutional layer data format [Input, Feature_Maps, Height, Width]</span>
<span class="k">return</span> <span class="n">delta_term</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward_shape</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_reset_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">previous_nodes</span><span class="p">):</span>
<span class="c1"># note that the previous nodes to the FlattenLayer are from the convolutional layers</span>
<span class="n">previous_nodes</span> <span class="o">=</span> <span class="n">previous_nodes</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="p">)</span>
<span class="c1"># return shape used in reset_weights in next layer</span>
<span class="k">return</span> <span class="n">previous_nodes</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">get_prev_a</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="fully-connected-layers">
<h3>Fully Connected Layers<a class="headerlink" href="#fully-connected-layers" title="Link to this heading">#</a></h3>
<p>Finally, the result from the flatten layer will pass to a series of
fully connected layers, which function as a normal feed forward neural
network. The fully connected layers are split into two classes;
FullyConnectedLayer which acts as a hidden layer, and OutputLayer,
which acts as the single output layer at the end of the CNN. If one
wishes to use this codebase to construct a normal feed forward neural
network, it must start with a FlattenLayer due to techincal details
regarding weight intitialization. However many FullyConnectedLayers
can be added to the CNN, and in each layer the amount of nodes, which
activation function and scheduler to use can be specified. In
practice, the scheduler will be specified in the CNN object
initialization, and inherited if no other scheduler is specified.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">FullyConnectedLayer</span><span class="p">(</span><span class="n">Layer</span><span class="p">):</span>
<span class="c1"># FullyConnectedLayer per default uses LRELU and Adam scheduler</span>
<span class="c1"># with an eta of 0.0001, rho of 0.9 and rho2 of 0.999</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">nodes</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
<span class="n">act_func</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">LRELU</span><span class="p">,</span>
<span class="n">scheduler</span><span class="p">:</span> <span class="n">Scheduler</span> <span class="o">=</span> <span class="n">Adam</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-4</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">rho2</span><span class="o">=</span><span class="mf">0.999</span><span class="p">),</span>
<span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodes</span> <span class="o">=</span> <span class="n">nodes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">act_func</span> <span class="o">=</span> <span class="n">act_func</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_weight</span> <span class="o">=</span> <span class="n">copy</span><span class="p">(</span><span class="n">scheduler</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_bias</span> <span class="o">=</span> <span class="n">copy</span><span class="p">(</span><span class="n">scheduler</span><span class="p">)</span>
<span class="c1"># initiate matrices for later</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weights</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">):</span>
<span class="c1"># calculate z</span>
<span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span> <span class="o">=</span> <span class="n">X_batch</span> <span class="o">@</span> <span class="bp">self</span><span class="o">.</span><span class="n">weights</span>
<span class="c1"># calculate a, add bias</span>
<span class="n">bias</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span> <span class="mi">1</span><span class="p">))</span> <span class="o">*</span> <span class="mf">0.01</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">hstack</span><span class="p">([</span><span class="n">bias</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span><span class="p">])</span>
<span class="c1"># return a, the input for feedforward in next layer</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">weights_next</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="p">,</span> <span class="n">a_previous</span><span class="p">,</span> <span class="n">lam</span><span class="p">):</span>
<span class="c1"># take the derivative of the activation function</span>
<span class="n">activation_derivative</span> <span class="o">=</span> <span class="n">derivate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">)</span>
<span class="c1"># calculate the delta term</span>
<span class="n">delta_term</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">weights_next</span><span class="p">[</span><span class="n">bias_index</span><span class="p">:,</span> <span class="p">:]</span> <span class="o">@</span> <span class="n">delta_term_next</span><span class="o">.</span><span class="n">T</span>
<span class="p">)</span><span class="o">.</span><span class="n">T</span> <span class="o">*</span> <span class="n">activation_derivative</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span><span class="p">)</span>
<span class="c1"># intitiate matrix to store gradient</span>
<span class="c1"># note that we exclude the bias term, which we will calculate later</span>
<span class="n">gradient_weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">a_previous</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">a_previous</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">]</span> <span class="o">-</span> <span class="n">bias_index</span><span class="p">,</span>
<span class="n">delta_term</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">],</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># calculate gradient = delta term * previous a</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">delta_term</span><span class="p">)):</span>
<span class="n">gradient_weights</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span>
<span class="n">a_previous</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">bias_index</span><span class="p">:],</span> <span class="n">delta_term</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="p">:]</span>
<span class="p">)</span>
<span class="c1"># sum the gradient, divide by input_index</span>
<span class="n">gradient_weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">gradient_weights</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">input_index</span><span class="p">)</span>
<span class="c1"># for the bias gradient we do not multiply by previous a</span>
<span class="n">gradient_bias</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">delta_term</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">input_index</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="mi">1</span><span class="p">,</span> <span class="n">delta_term</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">]</span>
<span class="p">)</span>
<span class="c1"># regularization term</span>
<span class="n">gradient_weights</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">weights</span><span class="p">[</span><span class="n">bias_index</span><span class="p">:,</span> <span class="p">:]</span> <span class="o">*</span> <span class="n">lam</span>
<span class="c1"># send gradients into scheduler</span>
<span class="c1"># returns update matrix which will be used to update the weights and bias</span>
<span class="n">update_matrix</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">vstack</span><span class="p">(</span>
<span class="p">[</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_bias</span><span class="o">.</span><span class="n">update_change</span><span class="p">(</span><span class="n">gradient_bias</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_weight</span><span class="o">.</span><span class="n">update_change</span><span class="p">(</span><span class="n">gradient_weights</span><span class="p">),</span>
<span class="p">]</span>
<span class="p">)</span>
<span class="c1"># update weights</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weights</span> <span class="o">-=</span> <span class="n">update_matrix</span>
<span class="c1"># return weights and delta term, input for backpropagation in previous layer</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">weights</span><span class="p">,</span> <span class="n">delta_term</span>
<span class="k">def</span> <span class="nf">_reset_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">previous_nodes</span><span class="p">):</span>
<span class="c1"># sets seed to remove randomness inbetween runs</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">)</span>
<span class="c1"># add bias, initiate random weights</span>
<span class="n">bias</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="n">previous_nodes</span> <span class="o">+</span> <span class="n">bias</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="p">)</span>
<span class="c1"># returns number of nodes, used for reset_weights in next layer</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span>
<span class="k">def</span> <span class="nf">_reset_scheduler</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># resets scheduler per epoch</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_weight</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_bias</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">get_prev_a</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># returns a matrix, used in backpropagation</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span>
<span class="k">class</span> <span class="nc">OutputLayer</span><span class="p">(</span><span class="n">FullyConnectedLayer</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">nodes</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
<span class="n">output_func</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">LRELU</span><span class="p">,</span>
<span class="n">cost_func</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">CostCrossEntropy</span><span class="p">,</span>
<span class="n">scheduler</span><span class="p">:</span> <span class="n">Scheduler</span> <span class="o">=</span> <span class="n">Adam</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-4</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">rho2</span><span class="o">=</span><span class="mf">0.999</span><span class="p">),</span>
<span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">nodes</span><span class="p">,</span> <span class="n">output_func</span><span class="p">,</span> <span class="n">copy</span><span class="p">(</span><span class="n">scheduler</span><span class="p">),</span> <span class="n">seed</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cost_func</span> <span class="o">=</span> <span class="n">cost_func</span>
<span class="c1"># initiate matrices for later</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weights</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># decides if the output layer performs binary or multi-class classification</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_pred_format</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="c1"># calculate a, z</span>
<span class="c1"># note that bias is not added as this would create an extra output class</span>
<span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span> <span class="o">=</span> <span class="n">X_batch</span> <span class="o">@</span> <span class="bp">self</span><span class="o">.</span><span class="n">weights</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span><span class="p">)</span>
<span class="c1"># returns prediction</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">a_previous</span><span class="p">,</span> <span class="n">lam</span><span class="p">):</span>
<span class="c1"># note that in the OutputLayer the activation function is the output function</span>
<span class="n">activation_derivative</span> <span class="o">=</span> <span class="n">derivate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">)</span>
<span class="c1"># calculate output delta terms</span>
<span class="c1"># for multi-class or binary classification</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">==</span> <span class="s2">&quot;Multi-class&quot;</span><span class="p">:</span>
<span class="n">delta_term</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span> <span class="o">-</span> <span class="n">target</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cost_func_derivative</span> <span class="o">=</span> <span class="n">grad</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cost_func</span><span class="p">(</span><span class="n">target</span><span class="p">))</span>
<span class="n">delta_term</span> <span class="o">=</span> <span class="n">activation_derivative</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">z_matrix</span><span class="p">)</span> <span class="o">*</span> <span class="n">cost_func_derivative</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">a_matrix</span>
<span class="p">)</span>
<span class="c1"># intiate matrix that stores gradient</span>
<span class="n">gradient_weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
<span class="p">(</span>
<span class="n">a_previous</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">a_previous</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">]</span> <span class="o">-</span> <span class="n">bias_index</span><span class="p">,</span>
<span class="n">delta_term</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">],</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="c1"># calculate gradient = delta term * previous a</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">delta_term</span><span class="p">)):</span>
<span class="n">gradient_weights</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span>
<span class="n">a_previous</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">bias_index</span><span class="p">:],</span> <span class="n">delta_term</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="p">:]</span>
<span class="p">)</span>
<span class="c1"># sum the gradient, divide by input_index</span>
<span class="n">gradient_weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">gradient_weights</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">input_index</span><span class="p">)</span>
<span class="c1"># for the bias gradient we do not multiply by previous a</span>
<span class="n">gradient_bias</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">delta_term</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">input_index</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="mi">1</span><span class="p">,</span> <span class="n">delta_term</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">node_index</span><span class="p">]</span>
<span class="p">)</span>
<span class="c1"># regularization term</span>
<span class="n">gradient_weights</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">weights</span><span class="p">[</span><span class="n">bias_index</span><span class="p">:,</span> <span class="p">:]</span> <span class="o">*</span> <span class="n">lam</span>
<span class="c1"># send gradients into scheduler</span>
<span class="c1"># returns update matrix which will be used to update the weights and bias</span>
<span class="n">update_matrix</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">vstack</span><span class="p">(</span>
<span class="p">[</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_bias</span><span class="o">.</span><span class="n">update_change</span><span class="p">(</span><span class="n">gradient_bias</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_weight</span><span class="o">.</span><span class="n">update_change</span><span class="p">(</span><span class="n">gradient_weights</span><span class="p">),</span>
<span class="p">]</span>
<span class="p">)</span>
<span class="c1"># update weights</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weights</span> <span class="o">-=</span> <span class="n">update_matrix</span>
<span class="c1"># return weights and delta term, input for backpropagation in previous layer</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">weights</span><span class="p">,</span> <span class="n">delta_term</span>
<span class="k">def</span> <span class="nf">_reset_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">previous_nodes</span><span class="p">):</span>
<span class="c1"># sets seed to remove randomness inbetween runs</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">)</span>
<span class="c1"># add bias, initiate random weights</span>
<span class="n">bias</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">weights</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">previous_nodes</span> <span class="o">+</span> <span class="n">bias</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span><span class="p">)</span>
<span class="c1"># returns number of nodes, used for reset_weights in next layer</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nodes</span>
<span class="k">def</span> <span class="nf">_reset_scheduler</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># resets scheduler per epoch</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_weight</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler_bias</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_set_pred_format</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># sets prediction format to either regression, binary or multi-class classification</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;identity&quot;</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">=</span> <span class="s2">&quot;Regression&quot;</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;sigmoid&quot;</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;tanh&quot;</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">=</span> <span class="s2">&quot;Binary&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">=</span> <span class="s2">&quot;Multi-class&quot;</span>
<span class="k">def</span> <span class="nf">get_pred_format</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># returns format of prediction</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="optimized-convolution2dlayer">
<h3>Optimized Convolution2DLayer<a class="headerlink" href="#optimized-convolution2dlayer" title="Link to this heading">#</a></h3>
<p>For our CNN, we have also implemented an optimized version of the
Convolution2DLayer, Convolution2DLayerOPT, which runs much faster. See
VII. Remarks for discussion. This layer will per default be used by
the CNN due to its computational advantages, but is much less
readable. Weve documented it such that specially interested students
can understand the principles behind it, but it is not recommended to
read. In short, we reshape and transpose parts of the image such that
the convolutional operation can be swapped out for a simple matrix
multiplication.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Convolution2DLayerOPT</span><span class="p">(</span><span class="n">Convolution2DLayer</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Am optimized version of the convolution layer above which</span>
<span class="sd"> utilizes an approach of extracting windows of size equivalent</span>
<span class="sd"> in size to the filter. The convoution is then performed on those</span>
<span class="sd"> windows instead of a full feature map.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">input_channels</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="p">,</span>
<span class="n">v_stride</span><span class="p">,</span>
<span class="n">h_stride</span><span class="p">,</span>
<span class="n">pad</span><span class="p">,</span>
<span class="n">act_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span>
<span class="n">seed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">reset_weights_independently</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
<span class="n">input_channels</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="p">,</span>
<span class="n">v_stride</span><span class="p">,</span>
<span class="n">h_stride</span><span class="p">,</span>
<span class="n">pad</span><span class="p">,</span>
<span class="n">act_func</span><span class="p">,</span>
<span class="n">seed</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># true if layer is used outside of CNN</span>
<span class="k">if</span> <span class="n">reset_weights_independently</span> <span class="o">==</span> <span class="kc">True</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_reset_weights_independently</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">):</span>
<span class="c1"># The optimized _feedforward method is difficult to understand but computationally more efficient</span>
<span class="c1"># for a more &quot;by the book&quot; approach, please look at the _feedforward method of Convolution2DLayer</span>
<span class="c1"># save the input for backpropagation</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span> <span class="o">=</span> <span class="n">X_batch</span>
<span class="c1"># check that there are the correct amount of input channels</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_check_for_errors</span><span class="p">()</span>
<span class="c1"># calculate new shape after stride</span>
<span class="n">strided_height</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">))</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">))</span>
<span class="c1"># get windows of the image for more computationally efficient convolution</span>
<span class="c1"># the idea is that we want to align the dimensions that we wish to matrix</span>
<span class="c1"># multiply, then use a simple matrix multiplication instead of convolution.</span>
<span class="c1"># then, we reshape the size back to its intended shape</span>
<span class="n">windows</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_extract_windows</span><span class="p">(</span><span class="n">X_batch</span><span class="p">)</span>
<span class="n">windows</span> <span class="o">=</span> <span class="n">windows</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">strided_height</span> <span class="o">*</span> <span class="n">strided_width</span><span class="p">,</span>
<span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># reshape the kernel for more computationally efficient convolution</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">kernel_input_channels_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># use simple matrix calculation to obtain output</span>
<span class="n">output</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="n">windows</span> <span class="o">@</span> <span class="n">kernel</span><span class="p">)</span>
<span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">strided_height</span><span class="p">,</span>
<span class="n">strided_width</span><span class="p">,</span>
<span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="p">)</span>
<span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="p">)</span>
<span class="c1"># The output is reshaped and rearranged to appropriate shape</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">(</span>
<span class="n">output</span> <span class="o">/</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span> <span class="o">*</span> <span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">feature_maps_index</span><span class="p">])</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">delta_term_next</span><span class="p">):</span>
<span class="c1"># The optimized _backpropagate method is difficult to understand but computationally more efficient</span>
<span class="c1"># for a more &quot;by the book&quot; approach, please look at the _backpropagate method of Convolution2DLayer</span>
<span class="n">act_derivative</span> <span class="o">=</span> <span class="n">derivate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">act_func</span><span class="p">)</span>
<span class="n">delta_term_next</span> <span class="o">=</span> <span class="n">act_derivative</span><span class="p">(</span><span class="n">delta_term_next</span><span class="p">)</span>
<span class="c1"># calculate strided dimensions</span>
<span class="n">strided_height</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
<span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">)</span>
<span class="p">)</span>
<span class="n">strided_width</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span>
<span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">)</span>
<span class="p">)</span>
<span class="c1"># copy kernel</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel</span>
<span class="c1"># get windows, reshape for matrix multiplication</span>
<span class="n">windows</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_extract_windows</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">strided_height</span>
<span class="o">*</span> <span class="n">strided_width</span><span class="p">,</span>
<span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># initialize output gradient, reshape and transpose into correct shape</span>
<span class="c1"># for matrix multiplication</span>
<span class="n">output_grad_tr</span> <span class="o">=</span> <span class="n">delta_term_next</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">strided_height</span>
<span class="o">*</span> <span class="n">strided_width</span><span class="p">,</span>
<span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># calculate gradient kernel via simple matrix multiplication and reshaping</span>
<span class="n">gradient_kernel</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="n">windows</span><span class="o">.</span><span class="n">T</span> <span class="o">@</span> <span class="n">output_grad_tr</span><span class="p">)</span>
<span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">kernel_input_channels_index</span><span class="p">],</span>
<span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span>
<span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">kernel_feature_maps_index</span><span class="p">],</span>
<span class="p">)</span>
<span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="p">)</span>
<span class="c1"># for computing the input gradient</span>
<span class="n">windows_out</span><span class="p">,</span> <span class="n">upsampled_height</span><span class="p">,</span> <span class="n">upsampled_width</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_extract_windows</span><span class="p">(</span>
<span class="n">delta_term_next</span><span class="p">,</span> <span class="s2">&quot;grad&quot;</span>
<span class="p">)</span>
<span class="c1"># calculate new window dimensions</span>
<span class="n">new_windows_first_dim</span> <span class="o">=</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">]</span>
<span class="o">*</span> <span class="n">upsampled_height</span>
<span class="o">*</span> <span class="n">upsampled_width</span>
<span class="p">)</span>
<span class="c1"># ceil allows for various asymmetric kernels</span>
<span class="n">new_windows_sec_dim</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="n">windows_out</span><span class="o">.</span><span class="n">size</span> <span class="o">/</span> <span class="n">new_windows_first_dim</span><span class="p">))</span>
<span class="c1"># reshape for matrix multiplication</span>
<span class="n">windows_out</span> <span class="o">=</span> <span class="n">windows_out</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="n">new_windows_first_dim</span><span class="p">,</span> <span class="n">new_windows_sec_dim</span>
<span class="p">)</span>
<span class="c1"># reshape for matrix multiplication</span>
<span class="n">kernel_reshaped</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># calculating input gradient for next convolutional layer</span>
<span class="n">input_grad</span> <span class="o">=</span> <span class="p">(</span><span class="n">windows_out</span> <span class="o">@</span> <span class="n">kernel_reshaped</span><span class="o">.</span><span class="n">T</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_index</span><span class="p">],</span>
<span class="n">upsampled_height</span><span class="p">,</span>
<span class="n">upsampled_width</span><span class="p">,</span>
<span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">kernel_input_channels_index</span><span class="p">],</span>
<span class="p">)</span>
<span class="n">input_grad</span> <span class="o">=</span> <span class="n">input_grad</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="c1"># Update the weights in the kernel</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kernel</span> <span class="o">-=</span> <span class="n">gradient_kernel</span>
<span class="c1"># Output the gradient to propagate backwards</span>
<span class="k">return</span> <span class="n">input_grad</span>
<span class="k">def</span> <span class="nf">_extract_windows</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">,</span> <span class="n">batch_type</span><span class="o">=</span><span class="s2">&quot;image&quot;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Receives as input the X_batch with shape (inputs, feature_maps, image_height, image_width)</span>
<span class="sd"> and extract windows of size kernel_height * kernel_width for every image and every feature_map.</span>
<span class="sd"> It then returns an np.ndarray of shape (image_height * image_width, inputs, feature_maps, kernel_height, kernel_width)</span>
<span class="sd"> which will be used either to filter the images in feedforward or to calculate the gradient.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># initialize list of windows</span>
<span class="n">windows</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">batch_type</span> <span class="o">==</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span>
<span class="c1"># pad the images</span>
<span class="n">X_batch_padded</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_padding</span><span class="p">(</span><span class="n">X_batch</span><span class="p">,</span> <span class="n">batch_type</span><span class="o">=</span><span class="s2">&quot;image&quot;</span><span class="p">)</span>
<span class="n">img_height</span><span class="p">,</span> <span class="n">img_width</span> <span class="o">=</span> <span class="n">X_batch_padded</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span>
<span class="c1"># For each location in the image...</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span>
<span class="mi">0</span><span class="p">,</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">,</span>
<span class="p">):</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span>
<span class="mi">0</span><span class="p">,</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">,</span>
<span class="p">):</span>
<span class="c1"># ...obtain an image patch of the original size (strided)</span>
<span class="c1"># get window</span>
<span class="n">window</span> <span class="o">=</span> <span class="n">X_batch_padded</span><span class="p">[</span>
<span class="p">:,</span>
<span class="p">:,</span>
<span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span>
<span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span><span class="p">,</span>
<span class="p">]</span>
<span class="c1"># append to list of windows</span>
<span class="n">windows</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
<span class="c1"># return numpy array instead of list</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span><span class="n">windows</span><span class="p">)</span>
<span class="c1"># In order to be able to perform backprogagation by the method of window extraction,</span>
<span class="c1"># here is a modified approach to extracting the windows which allow for the necessary</span>
<span class="c1"># upsampling of the gradient in case the on of the stride parameters is larger than one.</span>
<span class="k">if</span> <span class="n">batch_type</span> <span class="o">==</span> <span class="s2">&quot;grad&quot;</span><span class="p">:</span>
<span class="c1"># In the case of one of the stride parameters being odd, we have to take some</span>
<span class="c1"># extra care in calculating the upsampled size of X_batch. We solve this</span>
<span class="c1"># by simply flooring the result of dividing stride by 2.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">&lt;</span> <span class="mi">2</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">v_stride</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">v_stride</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">&lt;</span> <span class="mi">2</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">h_stride</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">h_stride</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
<span class="n">upsampled_height</span> <span class="o">=</span> <span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">)</span> <span class="o">-</span> <span class="n">v_stride</span>
<span class="n">upsampled_width</span> <span class="o">=</span> <span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">)</span> <span class="o">-</span> <span class="n">h_stride</span>
<span class="c1"># When upsampling, we need to insert rows and columns filled with zeros</span>
<span class="c1"># into each feature map. How many of those we have to insert is purely</span>
<span class="c1"># dependant on the value of stride parameter in the vertical and horizontal</span>
<span class="c1"># direction.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">v_ind</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">X_batch</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">X_batch</span><span class="p">,</span> <span class="n">v_ind</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">height_index</span><span class="p">)</span>
<span class="n">v_ind</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">h_ind</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">]):</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">X_batch</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">X_batch</span><span class="p">,</span> <span class="n">h_ind</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="n">width_index</span><span class="p">)</span>
<span class="n">h_ind</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span>
<span class="c1"># Since the insertion of zero-filled rows and columns isn&#39;t perfect, we have</span>
<span class="c1"># to assure that the resulting feature maps will have the expected upsampled height</span>
<span class="c1"># and width by cutting them og at desired dimensions.</span>
<span class="n">X_batch</span> <span class="o">=</span> <span class="n">X_batch</span><span class="p">[:,</span> <span class="p">:,</span> <span class="p">:</span><span class="n">upsampled_height</span><span class="p">,</span> <span class="p">:</span><span class="n">upsampled_width</span><span class="p">]</span>
<span class="n">X_batch_padded</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_padding</span><span class="p">(</span><span class="n">X_batch</span><span class="p">,</span> <span class="n">batch_type</span><span class="o">=</span><span class="s2">&quot;grad&quot;</span><span class="p">)</span>
<span class="c1"># initialize list of windows</span>
<span class="n">windows</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># For each location in the image...</span>
<span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span>
<span class="mi">0</span><span class="p">,</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">height_index</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">v_stride</span><span class="p">,</span>
<span class="p">):</span>
<span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span>
<span class="mi">0</span><span class="p">,</span>
<span class="n">X_batch</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">width_index</span><span class="p">],</span>
<span class="bp">self</span><span class="o">.</span><span class="n">h_stride</span><span class="p">,</span>
<span class="p">):</span>
<span class="c1"># ...obtain an image patch of the original size (strided)</span>
<span class="c1"># get window</span>
<span class="n">window</span> <span class="o">=</span> <span class="n">X_batch_padded</span><span class="p">[</span>
<span class="p">:,</span> <span class="p">:,</span> <span class="n">h</span> <span class="p">:</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_height</span><span class="p">,</span> <span class="n">w</span> <span class="p">:</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">kernel_width</span>
<span class="p">]</span>
<span class="c1"># append window to list</span>
<span class="n">windows</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
<span class="c1"># return numpy array, unsampled dimensions</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span><span class="n">windows</span><span class="p">),</span> <span class="n">upsampled_height</span><span class="p">,</span> <span class="n">upsampled_width</span>
<span class="k">def</span> <span class="nf">_check_for_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># compares input channels of data to input channels of Convolution2DLayer</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_channel_index</span><span class="p">]</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;ERROR: Number of input channels in data (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">X_batch_feedforward</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="n">input_channel_index</span><span class="p">]</span><span class="si">}</span><span class="s2">) is not equal to input channels in Convolution2DLayerOPT (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">input_channels</span><span class="si">}</span><span class="s2">)! Please change the number of input channels of the Convolution2DLayer such that they are equal&quot;</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="the-convolutional-neural-network-cnn">
<h3>The Convolutional Neural Network (CNN)<a class="headerlink" href="#the-convolutional-neural-network-cnn" title="Link to this heading">#</a></h3>
<p>Finally, we present the code for the CNN. The CNN class organizes all the layers, and allows for training on image data.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">math</span>
<span class="kn">import</span> <span class="nn">autograd.numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">autograd</span> <span class="kn">import</span> <span class="n">grad</span><span class="p">,</span> <span class="n">elementwise_grad</span>
<span class="kn">from</span> <span class="nn">random</span> <span class="kn">import</span> <span class="n">random</span><span class="p">,</span> <span class="n">seed</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Callable</span>
<span class="kn">from</span> <span class="nn">sklearn.utils</span> <span class="kn">import</span> <span class="n">resample</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">simplefilter</span><span class="p">(</span><span class="s2">&quot;error&quot;</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">CNN</span><span class="p">:</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">cost_func</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">CostCrossEntropy</span><span class="p">,</span>
<span class="n">scheduler</span><span class="p">:</span> <span class="n">Scheduler</span> <span class="o">=</span> <span class="n">Adam</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-4</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">rho2</span><span class="o">=</span><span class="mf">0.999</span><span class="p">),</span>
<span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Instantiates CNN object</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I output_func (costFunctions) cost function for feed forward neural network part of CNN,</span>
<span class="sd"> such as &quot;CostLogReg&quot;, &quot;CostOLS&quot; or &quot;CostCrossEntropy&quot;</span>
<span class="sd"> II scheduler (Scheduler) optional parameter, default set to Adam. Can also be set to other</span>
<span class="sd"> schedulers such as AdaGrad, Momentum, RMS_prop and Constant. Note that schedulers have</span>
<span class="sd"> to be instantiated first with proper parameters (for example eta, rho and rho2 for Adam)</span>
<span class="sd"> III seed (int) used for seeding all random operations</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layers</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cost_func</span> <span class="o">=</span> <span class="n">cost_func</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span> <span class="o">=</span> <span class="n">scheduler</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schedulers_weight</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schedulers_bias</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">seed</span> <span class="o">=</span> <span class="n">seed</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">add_FullyConnectedLayer</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">,</span> <span class="n">scheduler</span><span class="o">=</span><span class="kc">None</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Add a FullyConnectedLayer to the CNN, i.e. a hidden layer in the feed forward neural</span>
<span class="sd"> network part of the CNN. Often called a Dense layer in literature</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I nodes (int) number of nodes in FullyConnectedLayer</span>
<span class="sd"> II act_func (activationFunctions) activation function of FullyConnectedLayer,</span>
<span class="sd"> such as &quot;sigmoid&quot;, &quot;RELU&quot;, &quot;LRELU&quot;, &quot;softmax&quot; or &quot;identity&quot;</span>
<span class="sd"> III scheduler (Scheduler) optional parameter, default set to Adam. Can also be set to other</span>
<span class="sd"> schedulers such as AdaGrad, Momentum, RMS_prop and Constant</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">,</span> <span class="s2">&quot;FullyConnectedLayer should follow FlattenLayer in CNN&quot;</span>
<span class="k">if</span> <span class="n">scheduler</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">scheduler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span>
<span class="n">layer</span> <span class="o">=</span> <span class="n">FullyConnectedLayer</span><span class="p">(</span><span class="n">nodes</span><span class="p">,</span> <span class="n">act_func</span><span class="p">,</span> <span class="n">scheduler</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">layer</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">add_OutputLayer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">output_func</span><span class="o">=</span><span class="n">sigmoid</span><span class="p">,</span> <span class="n">scheduler</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Add an OutputLayer to the CNN, i.e. a the final layer in the feed forward neural</span>
<span class="sd"> network part of the CNN</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I nodes (int) number of nodes in OutputLayer. Set nodes=1 for binary classification and</span>
<span class="sd"> nodes = number of classes for multi-class classification</span>
<span class="sd"> II output_func (activationFunctions) activation function for the output layer, such as</span>
<span class="sd"> &quot;identity&quot; for regression, &quot;sigmoid&quot; for binary classification and &quot;softmax&quot; for multi-class</span>
<span class="sd"> classification</span>
<span class="sd"> III scheduler (Scheduler) optional parameter, default set to Adam. Can also be set to other</span>
<span class="sd"> schedulers such as AdaGrad, Momentum, RMS_prop and Constant</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">,</span> <span class="s2">&quot;OutputLayer should follow FullyConnectedLayer in CNN&quot;</span>
<span class="k">if</span> <span class="n">scheduler</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">scheduler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheduler</span>
<span class="n">output_layer</span> <span class="o">=</span> <span class="n">OutputLayer</span><span class="p">(</span>
<span class="n">nodes</span><span class="p">,</span> <span class="n">output_func</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cost_func</span><span class="p">,</span> <span class="n">scheduler</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">output_layer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">=</span> <span class="n">output_layer</span><span class="o">.</span><span class="n">get_pred_format</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">add_FlattenLayer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Add a FlattenLayer to the CNN, which flattens the image data such that it is formatted to</span>
<span class="sd"> be used in the feed forward neural network part of the CNN</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">FlattenLayer</span><span class="p">(</span><span class="n">act_func</span><span class="o">=</span><span class="n">act_func</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">add_Convolution2DLayer</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">input_channels</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">v_stride</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">h_stride</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">pad</span><span class="o">=</span><span class="s2">&quot;same&quot;</span><span class="p">,</span>
<span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">,</span>
<span class="n">optimized</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Add a Convolution2DLayer to the CNN, i.e. a convolutional layer with a 2 dimensional kernel. Should be</span>
<span class="sd"> the first layer added to the CNN</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I input_channels (int) specifies amount of input channels. For monochrome images, use input_channels</span>
<span class="sd"> = 1, and input_channels = 3 for colored images, where each channel represents one of R, G and B</span>
<span class="sd"> II feature_maps (int) amount of feature maps in CNN</span>
<span class="sd"> III kernel_height (int) height of the kernel, also called &#39;convolutional filter&#39; in literature</span>
<span class="sd"> IV kernel_width (int) width of the kernel, also called &#39;convolutional filter&#39; in literature</span>
<span class="sd"> V v_stride (int) value of vertical stride for dimentionality reduction</span>
<span class="sd"> VI h_stride (int) value of horizontal stride for dimentionality reduction</span>
<span class="sd"> VII pad (str) default = &quot;same&quot; ensures output size is the same as input size (given stride=1)</span>
<span class="sd"> VIII act_func (activationFunctions) default = &quot;LRELU&quot;, nonlinear activation function</span>
<span class="sd"> IX optimized (bool) default = True, uses Convolution2DLayerOPT if True which is much faster when</span>
<span class="sd"> compared to Convolution2DLayer, which is a more straightforward, understandable implementation</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">optimized</span><span class="p">:</span>
<span class="n">conv_layer</span> <span class="o">=</span> <span class="n">Convolution2DLayerOPT</span><span class="p">(</span>
<span class="n">input_channels</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="p">,</span>
<span class="n">v_stride</span><span class="p">,</span>
<span class="n">h_stride</span><span class="p">,</span>
<span class="n">pad</span><span class="p">,</span>
<span class="n">act_func</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">,</span>
<span class="n">reset_weights_independently</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">conv_layer</span> <span class="o">=</span> <span class="n">Convolution2DLayer</span><span class="p">(</span>
<span class="n">input_channels</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="p">,</span>
<span class="n">v_stride</span><span class="p">,</span>
<span class="n">h_stride</span><span class="p">,</span>
<span class="n">pad</span><span class="p">,</span>
<span class="n">act_func</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">,</span>
<span class="n">reset_weights_independently</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conv_layer</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">add_PoolingLayer</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">kernel_height</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">kernel_width</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">v_stride</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">h_stride</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">pooling</span><span class="o">=</span><span class="s2">&quot;max&quot;</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Add a Pooling2DLayer to the CNN, i.e. a pooling layer that reduces the dimentionality of</span>
<span class="sd"> the image data. It is not necessary to use a Pooling2DLayer when creating a CNN, but it</span>
<span class="sd"> can be used to speed up the training</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I kernel_height (int) height of the kernel used for pooling</span>
<span class="sd"> II kernel_width (int) width of the kernel used for pooling</span>
<span class="sd"> III v_stride (int) value of vertical stride for dimentionality reduction</span>
<span class="sd"> IV h_stride (int) value of horizontal stride for dimentionality reduction</span>
<span class="sd"> V pooling (str) either &quot;max&quot; or &quot;average&quot;, describes type of pooling performed</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">pooling_layer</span> <span class="o">=</span> <span class="n">Pooling2DLayer</span><span class="p">(</span>
<span class="n">kernel_height</span><span class="p">,</span> <span class="n">kernel_width</span><span class="p">,</span> <span class="n">v_stride</span><span class="p">,</span> <span class="n">h_stride</span><span class="p">,</span> <span class="n">pooling</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pooling_layer</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">fit</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">X</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">t</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">epochs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">100</span><span class="p">,</span>
<span class="n">lam</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">batches</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">X_val</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">t_val</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Fits the CNN to input X for a given amount of epochs. Performs feedforward and backpropagation passes,</span>
<span class="sd"> can utilize batches, regulariziation and validation if desired.</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> X (numpy array) with input data in format [images, input channels,</span>
<span class="sd"> image height, image_width]</span>
<span class="sd"> t (numpy array) target labels for input data</span>
<span class="sd"> epochs (int) amount of epochs</span>
<span class="sd"> lam (float) regulariziation term lambda</span>
<span class="sd"> batches (int) amount of batches input data splits into</span>
<span class="sd"> X_val (numpy array) validation data</span>
<span class="sd"> t_val (numpy array) target labels for validation data</span>
<span class="sd"> Returns:</span>
<span class="sd"> ------------</span>
<span class="sd"> scores (dict) a dictionary with &quot;train_error&quot;, &quot;train_acc&quot;, &quot;val_error&quot;, val_acc&quot; keys</span>
<span class="sd"> that contain numpy arrays with float values of all accuracies/errors over all epochs.</span>
<span class="sd"> Can be used to create plots. Also used to update the progress bar during training</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># setup</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">seed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">seed</span><span class="p">)</span>
<span class="c1"># initialize weights</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_initialize_weights</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
<span class="c1"># create arrays for score metrics</span>
<span class="n">scores</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_initialize_scores</span><span class="p">(</span><span class="n">epochs</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">batches</span> <span class="o">&lt;=</span> <span class="n">t</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">batch_size</span> <span class="o">=</span> <span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="n">batches</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">epoch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">epochs</span><span class="p">):</span>
<span class="k">for</span> <span class="n">batch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">batches</span><span class="p">):</span>
<span class="c1"># minibatch gradient descent</span>
<span class="c1"># If the for loop has reached the last batch, take all thats left</span>
<span class="k">if</span> <span class="n">batch</span> <span class="o">==</span> <span class="n">batches</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">X_batch</span> <span class="o">=</span> <span class="n">X</span><span class="p">[</span><span class="n">batch</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:]</span>
<span class="n">t_batch</span> <span class="o">=</span> <span class="n">t</span><span class="p">[</span><span class="n">batch</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="p">:,</span> <span class="p">:]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">X_batch</span> <span class="o">=</span> <span class="n">X</span><span class="p">[</span>
<span class="n">batch</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="p">:</span> <span class="p">(</span><span class="n">batch</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">batch_size</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:</span>
<span class="p">]</span>
<span class="n">t_batch</span> <span class="o">=</span> <span class="n">t</span><span class="p">[</span><span class="n">batch</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="p">:</span> <span class="p">(</span><span class="n">batch</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">batch_size</span><span class="p">,</span> <span class="p">:]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_feedforward</span><span class="p">(</span><span class="n">X_batch</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_backpropagate</span><span class="p">(</span><span class="n">t_batch</span><span class="p">,</span> <span class="n">lam</span><span class="p">)</span>
<span class="c1"># reset schedulers for each epoch (some schedulers pass in this call)</span>
<span class="k">for</span> <span class="n">layer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> <span class="n">FullyConnectedLayer</span><span class="p">):</span>
<span class="n">layer</span><span class="o">.</span><span class="n">_reset_scheduler</span><span class="p">()</span>
<span class="c1"># computing performance metrics</span>
<span class="n">scores</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_compute_scores</span><span class="p">(</span><span class="n">scores</span><span class="p">,</span> <span class="n">epoch</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">t</span><span class="p">,</span> <span class="n">X_val</span><span class="p">,</span> <span class="n">t_val</span><span class="p">)</span>
<span class="c1"># printing progress bar</span>
<span class="n">print_length</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_progress_bar</span><span class="p">(</span>
<span class="n">epoch</span><span class="p">,</span>
<span class="n">epochs</span><span class="p">,</span>
<span class="n">scores</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># allows for stopping training at any point and seeing the result</span>
<span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>
<span class="k">pass</span>
<span class="c1"># visualization of training progression (similiar to tensorflow progression bar)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\r</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">*</span> <span class="n">print_length</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_progress_bar</span><span class="p">(</span>
<span class="n">epochs</span><span class="p">,</span>
<span class="n">epochs</span><span class="p">,</span>
<span class="n">scores</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">scores</span>
<span class="k">def</span> <span class="nf">_feedforward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_batch</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Performs the feedforward pass for all layers in the CNN. Called from fit()</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">X_batch</span>
<span class="k">for</span> <span class="n">layer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">:</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_feedforward</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="k">return</span> <span class="n">a</span>
<span class="k">def</span> <span class="nf">_backpropagate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t_batch</span><span class="p">,</span> <span class="n">lam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Performs backpropagation for all layers in the CNN. Called from fit()</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">2</span>
<span class="n">reversed_layers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># for every layer, backwards</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">reversed_layers</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">layer</span> <span class="o">=</span> <span class="n">reversed_layers</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="n">prev_layer</span> <span class="o">=</span> <span class="n">reversed_layers</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span>
<span class="c1"># OutputLayer</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> <span class="n">OutputLayer</span><span class="p">):</span>
<span class="n">prev_a</span> <span class="o">=</span> <span class="n">prev_layer</span><span class="o">.</span><span class="n">get_prev_a</span><span class="p">()</span>
<span class="n">weights_next</span><span class="p">,</span> <span class="n">delta_next</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_backpropagate</span><span class="p">(</span><span class="n">t_batch</span><span class="p">,</span> <span class="n">prev_a</span><span class="p">,</span> <span class="n">lam</span><span class="p">)</span>
<span class="c1"># FullyConnectedLayer</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> <span class="n">FullyConnectedLayer</span><span class="p">):</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="n">delta_next</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">),</span> <span class="s2">&quot;No OutputLayer to follow FullyConnectedLayer&quot;</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="n">weights_next</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">),</span> <span class="s2">&quot;No OutputLayer to follow FullyConnectedLayer&quot;</span>
<span class="n">prev_a</span> <span class="o">=</span> <span class="n">prev_layer</span><span class="o">.</span><span class="n">get_prev_a</span><span class="p">()</span>
<span class="n">weights_next</span><span class="p">,</span> <span class="n">delta_next</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_backpropagate</span><span class="p">(</span>
<span class="n">weights_next</span><span class="p">,</span> <span class="n">delta_next</span><span class="p">,</span> <span class="n">prev_a</span><span class="p">,</span> <span class="n">lam</span>
<span class="p">)</span>
<span class="c1"># FlattenLayer</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> <span class="n">FlattenLayer</span><span class="p">):</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="n">delta_next</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">),</span> <span class="s2">&quot;No FullyConnectedLayer to follow FlattenLayer&quot;</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="n">weights_next</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">),</span> <span class="s2">&quot;No FullyConnectedLayer to follow FlattenLayer&quot;</span>
<span class="n">delta_next</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_backpropagate</span><span class="p">(</span><span class="n">weights_next</span><span class="p">,</span> <span class="n">delta_next</span><span class="p">)</span>
<span class="c1"># Convolution2DLayer and Convolution2DLayerOPT</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> <span class="n">Convolution2DLayer</span><span class="p">):</span>
<span class="k">assert</span> <span class="p">(</span>
<span class="n">delta_next</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">),</span> <span class="s2">&quot;No FlattenLayer to follow Convolution2DLayer&quot;</span>
<span class="n">delta_next</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_backpropagate</span><span class="p">(</span><span class="n">delta_next</span><span class="p">)</span>
<span class="c1"># Pooling2DLayer</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">layer</span><span class="p">,</span> <span class="n">Pooling2DLayer</span><span class="p">):</span>
<span class="k">assert</span> <span class="n">delta_next</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">,</span> <span class="s2">&quot;No Layer to follow Pooling2DLayer&quot;</span>
<span class="n">delta_next</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_backpropagate</span><span class="p">(</span><span class="n">delta_next</span><span class="p">)</span>
<span class="c1"># Catch error</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
<span class="k">def</span> <span class="nf">_compute_scores</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">scores</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span>
<span class="n">epoch</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
<span class="n">X</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">t</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">X_val</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">t_val</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Computes scores such as training error, training accuracy, validation error</span>
<span class="sd"> and validation accuracy for the CNN depending on if a validation set is used</span>
<span class="sd"> and if the CNN performs classification or regression</span>
<span class="sd"> Returns:</span>
<span class="sd"> ------------</span>
<span class="sd"> scores (dict) a dictionary with &quot;train_error&quot;, &quot;train_acc&quot;, &quot;val_error&quot;, val_acc&quot; keys</span>
<span class="sd"> that contain numpy arrays with float values of all accuracies/errors over all epochs.</span>
<span class="sd"> Can be used to create plots. Also used to update the progress bar during training</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">pred_train</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
<span class="n">cost_function_train</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cost_func</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
<span class="n">train_error</span> <span class="o">=</span> <span class="n">cost_function_train</span><span class="p">(</span><span class="n">pred_train</span><span class="p">)</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;train_error&quot;</span><span class="p">][</span><span class="n">epoch</span><span class="p">]</span> <span class="o">=</span> <span class="n">train_error</span>
<span class="k">if</span> <span class="n">X_val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">t_val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cost_function_val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cost_func</span><span class="p">(</span><span class="n">t_val</span><span class="p">)</span>
<span class="n">pred_val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">X_val</span><span class="p">)</span>
<span class="n">val_error</span> <span class="o">=</span> <span class="n">cost_function_val</span><span class="p">(</span><span class="n">pred_val</span><span class="p">)</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;val_error&quot;</span><span class="p">][</span><span class="n">epoch</span><span class="p">]</span> <span class="o">=</span> <span class="n">val_error</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">!=</span> <span class="s2">&quot;Regression&quot;</span><span class="p">:</span>
<span class="n">train_acc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_accuracy</span><span class="p">(</span><span class="n">pred_train</span><span class="p">,</span> <span class="n">t</span><span class="p">)</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;train_acc&quot;</span><span class="p">][</span><span class="n">epoch</span><span class="p">]</span> <span class="o">=</span> <span class="n">train_acc</span>
<span class="k">if</span> <span class="n">X_val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">t_val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">val_acc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_accuracy</span><span class="p">(</span><span class="n">pred_val</span><span class="p">,</span> <span class="n">t_val</span><span class="p">)</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;val_acc&quot;</span><span class="p">][</span><span class="n">epoch</span><span class="p">]</span> <span class="o">=</span> <span class="n">val_acc</span>
<span class="k">return</span> <span class="n">scores</span>
<span class="k">def</span> <span class="nf">_initialize_scores</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">epochs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Initializes scores such as training error, training accuracy, validation error</span>
<span class="sd"> and validation accuracy for the CNN</span>
<span class="sd"> Returns:</span>
<span class="sd"> ------------</span>
<span class="sd"> A dictionary with &quot;train_error&quot;, &quot;train_acc&quot;, &quot;val_error&quot;, val_acc&quot; keys that</span>
<span class="sd"> will contain numpy arrays with float values of all accuracies/errors over all epochs</span>
<span class="sd"> when passed through the _compute_scores() function during fit()</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">scores</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="n">train_errors</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span><span class="n">epochs</span><span class="p">)</span>
<span class="n">train_errors</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">)</span>
<span class="n">val_errors</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span><span class="n">epochs</span><span class="p">)</span>
<span class="n">val_errors</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">)</span>
<span class="n">train_accs</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span><span class="n">epochs</span><span class="p">)</span>
<span class="n">train_accs</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">)</span>
<span class="n">val_accs</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span><span class="n">epochs</span><span class="p">)</span>
<span class="n">val_accs</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">)</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;train_error&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">train_errors</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;val_error&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">val_errors</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;train_acc&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">train_accs</span>
<span class="n">scores</span><span class="p">[</span><span class="s2">&quot;val_acc&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">val_accs</span>
<span class="k">return</span> <span class="n">scores</span>
<span class="k">def</span> <span class="nf">_initialize_weights</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Initializes weights for all layers in CNN</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I X (np.ndarray) input of format [img, feature_maps, height, width]</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">prev_nodes</span> <span class="o">=</span> <span class="n">X</span>
<span class="k">for</span> <span class="n">layer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">:</span>
<span class="n">prev_nodes</span> <span class="o">=</span> <span class="n">layer</span><span class="o">.</span><span class="n">_reset_weights</span><span class="p">(</span><span class="n">prev_nodes</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">predict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">threshold</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Predicts output of input X</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I X (np.ndarray) input [img, feature_maps, height, width]</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">prediction</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_feedforward</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">==</span> <span class="s2">&quot;Binary&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">prediction</span> <span class="o">&gt;</span> <span class="n">threshold</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">pred_format</span> <span class="o">==</span> <span class="s2">&quot;Multi-class&quot;</span><span class="p">:</span>
<span class="n">class_prediction</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">prediction</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">prediction</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="n">class_prediction</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">prediction</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="p">:])]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">class_prediction</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">prediction</span>
<span class="k">def</span> <span class="nf">_accuracy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prediction</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">target</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Calculates accuracy of given prediction to target</span>
<span class="sd"> Parameters:</span>
<span class="sd"> ------------</span>
<span class="sd"> I prediction (np.ndarray): output of predict() fuction</span>
<span class="sd"> (1s and 0s in case of classification, and real numbers in case of regression)</span>
<span class="sd"> II target (np.ndarray): vector of true values (What the network should predict)</span>
<span class="sd"> Returns:</span>
<span class="sd"> ------------</span>
<span class="sd"> A floating point number representing the percentage of correctly classified instances.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">assert</span> <span class="n">prediction</span><span class="o">.</span><span class="n">size</span> <span class="o">==</span> <span class="n">target</span><span class="o">.</span><span class="n">size</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">average</span><span class="p">((</span><span class="n">target</span> <span class="o">==</span> <span class="n">prediction</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_progress_bar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">epoch</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">epochs</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">scores</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Displays progress of training</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">progression</span> <span class="o">=</span> <span class="n">epoch</span> <span class="o">/</span> <span class="n">epochs</span>
<span class="n">epoch</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="n">print_length</span> <span class="o">=</span> <span class="mi">40</span>
<span class="n">num_equals</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">progression</span> <span class="o">*</span> <span class="n">print_length</span><span class="p">)</span>
<span class="n">num_not</span> <span class="o">=</span> <span class="n">print_length</span> <span class="o">-</span> <span class="n">num_equals</span>
<span class="n">arrow</span> <span class="o">=</span> <span class="s2">&quot;&gt;&quot;</span> <span class="k">if</span> <span class="n">num_equals</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="n">bar</span> <span class="o">=</span> <span class="s2">&quot;[&quot;</span> <span class="o">+</span> <span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="p">(</span><span class="n">num_equals</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">+</span> <span class="n">arrow</span> <span class="o">+</span> <span class="s2">&quot;-&quot;</span> <span class="o">*</span> <span class="n">num_not</span> <span class="o">+</span> <span class="s2">&quot;]&quot;</span>
<span class="n">perc_print</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt</span><span class="p">(</span><span class="n">progression</span> <span class="o">*</span> <span class="mi">100</span><span class="p">,</span> <span class="n">N</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
<span class="n">line</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot; </span><span class="si">{</span><span class="n">bar</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">perc_print</span><span class="si">}</span><span class="s2">% &quot;</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">score</span> <span class="ow">in</span> <span class="n">scores</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">score</span><span class="p">[</span><span class="n">epoch</span><span class="p">])</span> <span class="o">==</span> <span class="kc">False</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt</span><span class="p">(</span><span class="n">score</span><span class="p">[</span><span class="n">epoch</span><span class="p">],</span> <span class="n">N</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
<span class="n">line</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">&quot;| </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2"> &quot;</span>
<span class="nb">print</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s2">&quot;</span><span class="se">\r</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_fmt</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">N</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Description:</span>
<span class="sd"> ------------</span>
<span class="sd"> Formats decimal numbers for progress bar</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">value</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">elif</span> <span class="n">value</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="o">-</span><span class="mi">10</span> <span class="o">*</span> <span class="n">value</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">n</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">+</span> <span class="n">math</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span><span class="n">math</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">v</span><span class="p">))</span>
<span class="k">if</span> <span class="n">n</span> <span class="o">&gt;=</span> <span class="n">N</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="c1"># or overflow</span>
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">value</span><span class="si">:</span><span class="s2">.</span><span class="si">{</span><span class="n">N</span><span class="o">-</span><span class="n">n</span><span class="o">-</span><span class="mi">1</span><span class="si">}</span><span class="s2">f</span><span class="si">}</span><span class="s2">&quot;</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="usage-of-cnn-code">
<h3>Usage of CNN code<a class="headerlink" href="#usage-of-cnn-code" title="Link to this heading">#</a></h3>
<p>Using the CNN codebase is very simple. We begin by initiating a CNN
object, which takes a cost function, a scheduler and a seed as its
arguments. If a scheduler is not provided, it will per default
initiate an Adam scheduler with eta=1e-4, and if a seed is not
provided, the CNN will not be seeded, meaning it will run with a
different random seed every run. Below we demonstrate an initiation of
our CNN.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">adam_scheduler</span> <span class="o">=</span> <span class="n">Adam</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-3</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">rho2</span><span class="o">=</span><span class="mf">0.999</span><span class="p">)</span>
<span class="n">cnn</span> <span class="o">=</span> <span class="n">CNN</span><span class="p">(</span><span class="n">cost_func</span><span class="o">=</span><span class="n">CostCrossEntropy</span><span class="p">,</span> <span class="n">scheduler</span><span class="o">=</span><span class="n">adam_scheduler</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="mi">2023</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>Now that we have our CNN object, we can begin to add layers to it!
Many of the add_layer functions have default values, for example
add_Convolution2DLayer() has a default v_stride and h_stride of</p>
<ol class="arabic simple">
<li><p>However, these can of course be set to any value you please. Note
that the input channels of a subsequent convolutional layer must equal
the previous convolutional layers feature maps.</p></li>
</ol>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">cnn</span><span class="o">.</span><span class="n">add_Convolution2DLayer</span><span class="p">(</span>
<span class="n">input_channels</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FlattenLayer</span><span class="p">()</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FullyConnectedLayer</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span> <span class="n">LRELU</span><span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FullyConnectedLayer</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="n">LRELU</span><span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_OutputLayer</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="n">softmax</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>Here we have created a CNN with the following architecture:</p>
<ol class="arabic simple">
<li><p>A convolutional layer with 1 input channel, with a kernel height of 2 and a width of 2, which uses LRELU as its non-linearity function. This layer outputs 1 feature map, which feed into the subsequent layer.</p></li>
<li><p>A flatten layer</p></li>
<li><p>A hidden layer with 30 nodes, with LRELU as its activation function</p></li>
<li><p>Another hidden layer but with 20 nodes</p></li>
<li><p>The output layer, with softmax as its activation function and 10 nodes. We use 10 nodes because we will be using a dataset with 10 classes.</p></li>
</ol>
<p>Now, before we can train the model, we need to load in our data. We
will use the MNIST dataset and use 10000 <span class="math notranslate nohighlight">\(28 \times 28\)</span> images.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">sklearn.datasets</span> <span class="kn">import</span> <span class="n">fetch_openml</span>
<span class="kn">from</span> <span class="nn">sklearn.model_selection</span> <span class="kn">import</span> <span class="n">train_test_split</span>
<span class="k">def</span> <span class="nf">onehot</span><span class="p">(</span><span class="n">target</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">onehot</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">target</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="n">target</span><span class="o">.</span><span class="n">max</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span><span class="p">))</span>
<span class="n">onehot</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">target</span><span class="o">.</span><span class="n">size</span><span class="p">),</span> <span class="n">target</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">onehot</span>
<span class="c1"># get dataset</span>
<span class="n">dataset</span> <span class="o">=</span> <span class="n">fetch_openml</span><span class="p">(</span><span class="s2">&quot;mnist_784&quot;</span><span class="p">,</span> <span class="n">parser</span><span class="o">=</span><span class="s2">&quot;auto&quot;</span><span class="p">)</span>
<span class="n">mnist</span> <span class="o">=</span> <span class="n">dataset</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">to_numpy</span><span class="p">(</span><span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;float&quot;</span><span class="p">)[:</span><span class="mi">10000</span><span class="p">,</span> <span class="p">:]</span>
<span class="c1"># scale data</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">mnist</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
<span class="n">mnist</span><span class="p">[:,</span> <span class="n">i</span><span class="p">]</span> <span class="o">/=</span> <span class="mi">255</span>
<span class="c1"># reshape to add single input channel to data shape [inputs, input_channels, height, width]</span>
<span class="n">mnist</span> <span class="o">=</span> <span class="n">mnist</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">mnist</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">28</span><span class="p">,</span> <span class="mi">28</span><span class="p">)</span>
<span class="c1"># one hot encode target as we are doing multi-class classification</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">onehot</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="nb">int</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">dataset</span><span class="o">.</span><span class="n">target</span><span class="o">.</span><span class="n">to_numpy</span><span class="p">()[:</span><span class="mi">10000</span><span class="p">]]))</span>
<span class="c1"># split into training and validation data</span>
<span class="n">x_train</span><span class="p">,</span> <span class="n">x_val</span><span class="p">,</span> <span class="n">y_train</span><span class="p">,</span> <span class="n">y_val</span> <span class="o">=</span> <span class="n">train_test_split</span><span class="p">(</span><span class="n">mnist</span><span class="p">,</span> <span class="n">target</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>Now we may train our model. Note that we can utilize regularization in
the CNN by using the lam (lambda) parameter in fit(), and utilize
different types of gradient descent by specifying the amount of
batches via the batches parameter as shown below.</p>
<p>The functionfit() returns a score dictionary of the training error and
accuracy (and validation error and accuracy if a validation set is
provided) which can be used to plot the error and accuracy of the
model over epochs.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">scores</span> <span class="o">=</span> <span class="n">cnn</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span>
<span class="n">x_train</span><span class="p">,</span>
<span class="n">y_train</span><span class="p">,</span>
<span class="n">lam</span><span class="o">=</span><span class="mf">1e-5</span><span class="p">,</span>
<span class="n">batches</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">epochs</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span>
<span class="n">X_val</span><span class="o">=</span><span class="n">x_val</span><span class="p">,</span>
<span class="n">t_val</span><span class="o">=</span><span class="n">y_val</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">scores</span><span class="p">[</span><span class="s2">&quot;train_acc&quot;</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="s2">&quot;Training&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">scores</span><span class="p">[</span><span class="s2">&quot;val_acc&quot;</span><span class="p">],</span> <span class="n">label</span><span class="o">=</span><span class="s2">&quot;Validation&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylim</span><span class="p">([</span><span class="mf">0.8</span><span class="p">,</span><span class="mi">1</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="s2">&quot;Epochs&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="s2">&quot;Accuracy&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">legend</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<p>Considering we only trained the model for 100 epochs without any tuning of the hyperparameters, this result is pretty good.</p>
<p>The codebase allows for great flexibility in CNN
architectures. Pooling layers can be added before, inbetween or after
convolutional layers, but due to the great optimizations made within
Convolution2DLayerOPT, we recommend using the v_stride and h_stride
parameters in add_Convolution2DLayer() to reduce the dimentionality of
the problem as the pooling layer is slow in comparison. To use the
unoptimized version of Convolution2DLayer, simply pass optimized=False
as an argument in add_Convolution2DLayer().</p>
<p>If one wishes to perform binary classification using the CNN, simply
use the cost function CostLogReg when initializing the CNN and use 1
node at the OutputLayer.</p>
<p>Below we have created another, more untraditional architecture using
our code to demonstrate its flexibility and different attributes such
as asymmetric stride that might become useful when constructing your
own CNN.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">adam_scheduler</span> <span class="o">=</span> <span class="n">Adam</span><span class="p">(</span><span class="n">eta</span><span class="o">=</span><span class="mf">1e-3</span><span class="p">,</span> <span class="n">rho</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">rho2</span><span class="o">=</span><span class="mf">0.999</span><span class="p">)</span>
<span class="n">cnn</span> <span class="o">=</span> <span class="n">CNN</span><span class="p">(</span><span class="n">cost_func</span><span class="o">=</span><span class="n">CostCrossEntropy</span><span class="p">,</span> <span class="n">scheduler</span><span class="o">=</span><span class="n">adam_scheduler</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="mi">2023</span><span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_Convolution2DLayer</span><span class="p">(</span>
<span class="n">input_channels</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_PoolingLayer</span><span class="p">(</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">pooling</span><span class="o">=</span><span class="s2">&quot;average&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_PoolingLayer</span><span class="p">(</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">pooling</span><span class="o">=</span><span class="s2">&quot;max&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_Convolution2DLayer</span><span class="p">(</span>
<span class="n">input_channels</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
<span class="n">v_stride</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">h_stride</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span>
<span class="n">act_func</span><span class="o">=</span><span class="n">LRELU</span><span class="p">,</span>
<span class="n">optimized</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_Convolution2DLayer</span><span class="p">(</span>
<span class="n">input_channels</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">feature_maps</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">act_func</span><span class="o">=</span><span class="n">sigmoid</span><span class="p">,</span>
<span class="n">optimized</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_PoolingLayer</span><span class="p">(</span>
<span class="n">kernel_height</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">kernel_width</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
<span class="n">pooling</span><span class="o">=</span><span class="s2">&quot;max&quot;</span>
<span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FlattenLayer</span><span class="p">()</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FullyConnectedLayer</span><span class="p">(</span><span class="mi">100</span><span class="p">,</span> <span class="n">LRELU</span><span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FullyConnectedLayer</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="n">sigmoid</span><span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_FullyConnectedLayer</span><span class="p">(</span><span class="mi">101</span><span class="p">,</span> <span class="n">identity</span><span class="p">)</span>
<span class="n">cnn</span><span class="o">.</span><span class="n">add_OutputLayer</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="n">softmax</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<p>Here we see the use of asymmetrical 1D kernels such as the <span class="math notranslate nohighlight">\(7 \times
1\)</span> kernel in the first convolutional layer, both max and average
pooling, asymmetric stride in the unoptimized convolutional layer,
more pooling, a flatten layer, a hidden layer with 100 nodes using
LRELU, another hidden layer with 10 hidden nodes that uses the sigmoid
activation function, and another hidden layer with 101 nodes which
utilizes no activation function (identity). Finally, we arrive at the
output layer with 10 nodes, which uses softmax as its activation
function.</p>
</section>
<section id="additional-remarks">
<h3>Additional Remarks<a class="headerlink" href="#additional-remarks" title="Link to this heading">#</a></h3>
<p>The stride parameter controls the distance between each convolution
and the kernel/filter. If our image is padded, stride is the only
parameter that determines the size of the output from a convolutional
layer. However, if we decide not to perform any padding, the size of
the output feature map depends on both the stride and kernel size. It
is important to note that neither the stride nor the kernel has to be
symmetrical. This means that we can use a rectangular filter if we
choose, and the stride in the vertical direction (axis=0 in Python)
does not need to be the same as the stride in the horizontal direction
(axis=1 in Python). It may even be the case that asymmetric
combinations of stride or kernel dimensions, or both, yield better
results than symmetric values for these parameters.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">convolve</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">,</span> <span class="n">stride</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="n">kernel</span><span class="p">)</span>
<span class="n">k_half_height</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">k_half_width</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">conv_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">pad_image</span> <span class="o">=</span> <span class="n">padding</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">k_half_height</span><span class="p">,</span> <span class="n">conv_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">k_half_height</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">k_half_width</span><span class="p">,</span> <span class="n">conv_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">k_half_width</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="n">conv_image</span><span class="p">[</span><span class="n">i</span> <span class="o">-</span> <span class="n">k_half_height</span><span class="p">,</span> <span class="n">j</span> <span class="o">-</span> <span class="n">k_half_width</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span>
<span class="n">pad_image</span><span class="p">[</span>
<span class="n">i</span> <span class="o">-</span> <span class="n">k_half_height</span> <span class="p">:</span> <span class="n">i</span> <span class="o">+</span> <span class="n">k_half_height</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">j</span> <span class="o">-</span> <span class="n">k_half_width</span> <span class="p">:</span> <span class="n">j</span> <span class="o">+</span> <span class="n">k_half_width</span> <span class="o">+</span> <span class="mi">1</span>
<span class="p">]</span>
<span class="o">*</span> <span class="n">kernel</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">conv_image</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="remarks-on-the-speed">
<h3>Remarks on the speed<a class="headerlink" href="#remarks-on-the-speed" title="Link to this heading">#</a></h3>
<p>Despite the naive convolution algorithm shown above working finely, it
is extremely slow, requiring approximately 20-30 seconds to process a
single image. The time complexity of 2D convolution, which is O(NMnm),
rapidly becomes a constraint and may, at worst, make computations
infeasible. Consequently, optimizing the naive 2D convolution
algorithm is a necessity, as the execution time of the algorithm
significantly increases as the input data size expands. This can pose
a bottleneck in applications that necessitate real-time processing of
large data volumes, such as image and video processing, deep learning,
and scientific simulations.</p>
<p>To address this issue, we shall present two widely used optimization
techniques: the separable kernel approach and Fast Fourier Transform
(FFT). Both of these methods can drastically reduce the computational
complexity of convolution and enhance the overall efficiency of
processing substantial data quantities. While we shall refrain from
delving into the intricacies of these algorithms, we strongly
encourage you to examine at least the application of FFT to optimize
computations.</p>
</section>
<section id="convolution-using-separable-kernels">
<h3>Convolution using separable kernels<a class="headerlink" href="#convolution-using-separable-kernels" title="Link to this heading">#</a></h3>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">conv2DSep</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">,</span> <span class="n">coef</span><span class="p">,</span> <span class="n">stride</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="s2">&quot;zero&quot;</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rot90</span><span class="p">(</span><span class="n">kernel</span><span class="p">)</span>
<span class="c1"># The kernel is quadratic, thus we only need one of its dimensions</span>
<span class="n">half_dim</span> <span class="o">=</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">//</span> <span class="mi">2</span>
<span class="n">ker1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">kernel</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="p">:])</span>
<span class="n">ker2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">kernel</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="n">pad</span> <span class="o">==</span> <span class="s2">&quot;zero&quot;</span><span class="p">:</span>
<span class="n">conv_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">pad_image</span> <span class="o">=</span> <span class="n">padding</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">conv_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
<span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">kernel</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="p">)</span>
<span class="n">pad_image</span> <span class="o">=</span> <span class="n">image</span><span class="p">[:,</span> <span class="p">:]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">half_dim</span><span class="p">,</span> <span class="n">conv_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">half_dim</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">half_dim</span><span class="p">,</span> <span class="n">conv_image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">half_dim</span><span class="p">,</span> <span class="n">stride</span><span class="p">):</span>
<span class="n">conv_image</span><span class="p">[</span><span class="n">i</span> <span class="o">-</span> <span class="n">half_dim</span><span class="p">,</span> <span class="n">j</span> <span class="o">-</span> <span class="n">half_dim</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">pad_image</span><span class="p">[</span>
<span class="n">i</span> <span class="o">-</span> <span class="n">half_dim</span> <span class="p">:</span> <span class="n">i</span> <span class="o">+</span> <span class="n">half_dim</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">j</span> <span class="o">-</span> <span class="n">half_dim</span> <span class="p">:</span> <span class="n">j</span> <span class="o">+</span> <span class="n">half_dim</span> <span class="o">+</span> <span class="mi">1</span>
<span class="p">]</span>
<span class="o">@</span> <span class="n">ker1</span>
<span class="o">@</span> <span class="n">ker2</span><span class="o">.</span><span class="n">T</span>
<span class="o">*</span> <span class="n">coef</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">conv_image</span>
<span class="n">img_path</span> <span class="o">=</span> <span class="n">img_path</span> <span class="o">=</span> <span class="s2">&quot;data/IMG-2167.JPG&quot;</span>
<span class="n">image_of_cute_dog</span> <span class="o">=</span> <span class="n">imageio</span><span class="o">.</span><span class="n">imread</span><span class="p">(</span><span class="n">img_path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;L&quot;</span><span class="p">)</span>
<span class="n">start_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">filtered_image</span> <span class="o">=</span> <span class="n">conv2DSep</span><span class="p">(</span><span class="n">image_of_cute_dog</span><span class="p">,</span> <span class="n">kernel</span><span class="o">=</span><span class="n">sobel_kernel</span><span class="p">,</span> <span class="n">coef</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Time taken for convolution with seperated kernel on 128x128 image </span><span class="si">{</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">start_time</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">filtered_image</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">aspect</span><span class="o">=</span><span class="s2">&quot;auto&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<p>By taking advantage of the capabilities of separable kernels, we can
effectively cut the computational expense of filtering an image in
half. Yet, if we seek even more rapid processing, we can turn to the
Fast Fourier Transform (FFT) algorithm provided by the numpy
library. By utilizing FFT to transform the input image and filter into
the frequency domain, we can perform convolution in this domain. This
approach significantly reduces the number of operations needed and
results in a marked speedup relative to other convolution
techniques. In addition, it is worth noting that the FFT is widely
regarded as one of the most critical algorithms developed to date,
with applications ranging from digital signal processing to scientific
computing.</p>
</section>
<section id="convolution-in-the-fourier-domain">
<h3>Convolution in the Fourier domain<a class="headerlink" href="#convolution-in-the-fourier-domain" title="Link to this heading">#</a></h3>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">start_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">img_fft</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">fft2</span><span class="p">(</span><span class="n">image_of_cute_dog</span><span class="p">)</span>
<span class="n">kernel_fft</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">fft2</span><span class="p">(</span><span class="n">sobel_kernel</span><span class="p">,</span> <span class="n">s</span><span class="o">=</span><span class="n">image_of_cute_dog</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
<span class="n">conv_image</span> <span class="o">=</span> <span class="n">img_fft</span> <span class="o">*</span> <span class="n">kernel_fft</span>
<span class="n">filtered_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">ifft2</span><span class="p">(</span><span class="n">conv_image</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Time take for convolution in the fourier domain: </span><span class="si">{</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">start_time</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">filtered_image</span><span class="o">.</span><span class="n">real</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s2">&quot;gray&quot;</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">aspect</span><span class="o">=</span><span class="s2">&quot;auto&quot;</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<p>It is evident that executing convolution in the Fourier domain yields
the quickest computation time. Nonetheless, one should exercise
caution, particularly when dealing with images of relatively small
dimensions, as one of the other methods may prove to be more
expeditious than FFT-enhanced convolution. The overhead involved in
transferring both the image and filter into the Fourier domain,
followed by their subsequent transformation back into the spatial
domain, results in a minor inconvenience. Therefore, it is imperative
to remain cognizant of this fact when utilizing FFT as the primary
optimization technique.</p>
</section>
</section>
<section id="from-ffnns-and-cnns-to-recurrent-neural-networks-rnns">
<h2>From FFNNs and CNNs to recurrent neural networks (RNNs)<a class="headerlink" href="#from-ffnns-and-cnns-to-recurrent-neural-networks-rnns" title="Link to this heading">#</a></h2>
<p>There are limitation of FFNNs, one of which being that FFNNs are not
designed to handle sequential data (data for which the order matters)
effectively because they lack the capabilities of storing information
about previous inputs; each input is being treated indepen-
dently. This is a limitation when dealing with sequential data where
past information can be vital to correctly process current and future
inputs.</p>
</section>
<section id="feedback-connections">
<h2>Feedback connections<a class="headerlink" href="#feedback-connections" title="Link to this heading">#</a></h2>
<p>In contrast to FFNNs, recurrent networks introduce feedback
connections, meaning the information is allowed to be carried to
subsequent nodes across different time steps. These cyclic or feedback
connections have the objective of providing the network with some kind
of memory, making RNNs particularly suited for time- series data,
natural language processing, speech recognition, and several other
problems for which the order of the data is crucial. The RNN
architectures vary greatly in how they manage information flow and
memory in the network.</p>
</section>
<section id="vanishing-gradients">
<h2>Vanishing gradients<a class="headerlink" href="#vanishing-gradients" title="Link to this heading">#</a></h2>
<p>Different architectures often aim at improving
some sub-optimal characteristics of the network. The simplest form of
recurrent network, commonly called simple or vanilla RNN, for example,
is known to suffer from the problem of vanishing gradients. This
problem arises due to the nature of backpropagation in time. Gradients
of the cost/loss function may get exponentially small (or large) if
there are many layers in the network, which is the case of RNN when
the sequence gets long.</p>
</section>
<section id="recurrent-neural-networks-rnns-overarching-view">
<h2>Recurrent neural networks (RNNs): Overarching view<a class="headerlink" href="#recurrent-neural-networks-rnns-overarching-view" title="Link to this heading">#</a></h2>
<p>Till now our focus has been, including convolutional neural networks
as well, on feedforward neural networks. The output or the activations
flow only in one direction, from the input layer to the output layer.</p>
<p>A recurrent neural network (RNN) looks very much like a feedforward
neural network, except that it also has connections pointing
backward.</p>
<p>RNNs are used to analyze time series data such as stock prices, and
tell you when to buy or sell. In autonomous driving systems, they can
anticipate car trajectories and help avoid accidents. More generally,
they can work on sequences of arbitrary lengths, rather than on
fixed-sized inputs like all the nets we have discussed so far. For
example, they can take sentences, documents, or audio samples as
input, making them extremely useful for natural language processing
systems such as automatic translation and speech-to-text.</p>
</section>
<section id="sequential-data-only">
<h2>Sequential data only?<a class="headerlink" href="#sequential-data-only" title="Link to this heading">#</a></h2>
<p>An important issue is that in many deep learning methods we assume
that the input and output data can be treated as independent and
identically distributed, normally abbreviated to <strong>iid</strong>.
This means that the data we use can be seen as mutually independent.</p>
<p>This is however not the case for most data sets used in RNNs since we
are dealing with sequences of data with strong inter-dependencies.
This applies in particular to time series, which are sequential by
contruction.</p>
</section>
<section id="differential-equations">
<h2>Differential equations<a class="headerlink" href="#differential-equations" title="Link to this heading">#</a></h2>
<p>As an example, the solutions of ordinary differential equations can be
represented as a time series, similarly, how stock prices evolve as
function of time is another example of a typical time series, or voice
records and many other examples.</p>
<p>Not all sequential data may however have a time stamp, texts being a
typical example thereof, or DNA sequences.</p>
<p>The main focus here is on data that can be structured either as time
series or as ordered series of data. We will not focus on for example
natural language processing or similar data sets.</p>
</section>
<section id="a-simple-example">
<h2>A simple example<a class="headerlink" href="#a-simple-example" title="Link to this heading">#</a></h2>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Start importing packages</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">datasets</span><span class="p">,</span> <span class="n">layers</span><span class="p">,</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.layers</span> <span class="kn">import</span> <span class="n">Input</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.models</span> <span class="kn">import</span> <span class="n">Model</span><span class="p">,</span> <span class="n">Sequential</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.layers</span> <span class="kn">import</span> <span class="n">Dense</span><span class="p">,</span> <span class="n">SimpleRNN</span><span class="p">,</span> <span class="n">LSTM</span><span class="p">,</span> <span class="n">GRU</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">optimizers</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">regularizers</span>
<span class="kn">from</span> <span class="nn">tensorflow.keras.utils</span> <span class="kn">import</span> <span class="n">to_categorical</span>
<span class="c1"># convert into dataset matrix</span>
<span class="k">def</span> <span class="nf">convertToMatrix</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">step</span><span class="p">):</span>
<span class="n">X</span><span class="p">,</span> <span class="n">Y</span> <span class="o">=</span><span class="p">[],</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">-</span><span class="n">step</span><span class="p">):</span>
<span class="n">d</span><span class="o">=</span><span class="n">i</span><span class="o">+</span><span class="n">step</span>
<span class="n">X</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">i</span><span class="p">:</span><span class="n">d</span><span class="p">,])</span>
<span class="n">Y</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="n">d</span><span class="p">,])</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">X</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">Y</span><span class="p">)</span>
<span class="n">step</span> <span class="o">=</span> <span class="mi">4</span>
<span class="n">N</span> <span class="o">=</span> <span class="mi">1000</span>
<span class="n">Tp</span> <span class="o">=</span> <span class="mi">800</span>
<span class="n">t</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="n">N</span><span class="p">)</span>
<span class="n">x</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="mf">0.02</span><span class="o">*</span><span class="n">t</span><span class="p">)</span><span class="o">+</span><span class="mi">2</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">N</span><span class="p">)</span>
<span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="n">df</span><span class="o">.</span><span class="n">head</span><span class="p">()</span>
<span class="n">values</span><span class="o">=</span><span class="n">df</span><span class="o">.</span><span class="n">values</span>
<span class="n">train</span><span class="p">,</span><span class="n">test</span> <span class="o">=</span> <span class="n">values</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">Tp</span><span class="p">,:],</span> <span class="n">values</span><span class="p">[</span><span class="n">Tp</span><span class="p">:</span><span class="n">N</span><span class="p">,:]</span>
<span class="c1"># add step elements into train and test</span>
<span class="n">test</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">test</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">test</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,],</span><span class="n">step</span><span class="p">))</span>
<span class="n">train</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">train</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">train</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,],</span><span class="n">step</span><span class="p">))</span>
<span class="n">trainX</span><span class="p">,</span><span class="n">trainY</span> <span class="o">=</span><span class="n">convertToMatrix</span><span class="p">(</span><span class="n">train</span><span class="p">,</span><span class="n">step</span><span class="p">)</span>
<span class="n">testX</span><span class="p">,</span><span class="n">testY</span> <span class="o">=</span><span class="n">convertToMatrix</span><span class="p">(</span><span class="n">test</span><span class="p">,</span><span class="n">step</span><span class="p">)</span>
<span class="n">trainX</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">trainX</span><span class="p">,</span> <span class="p">(</span><span class="n">trainX</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">1</span><span class="p">,</span> <span class="n">trainX</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">testX</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">testX</span><span class="p">,</span> <span class="p">(</span><span class="n">testX</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">1</span><span class="p">,</span> <span class="n">testX</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Sequential</span><span class="p">()</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">SimpleRNN</span><span class="p">(</span><span class="n">units</span><span class="o">=</span><span class="mi">32</span><span class="p">,</span> <span class="n">input_shape</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="n">step</span><span class="p">),</span> <span class="n">activation</span><span class="o">=</span><span class="s2">&quot;relu&quot;</span><span class="p">))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">Dense</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="n">activation</span><span class="o">=</span><span class="s2">&quot;relu&quot;</span><span class="p">))</span>
<span class="n">model</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">Dense</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
<span class="n">model</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">loss</span><span class="o">=</span><span class="s1">&#39;mean_squared_error&#39;</span><span class="p">,</span> <span class="n">optimizer</span><span class="o">=</span><span class="s1">&#39;rmsprop&#39;</span><span class="p">)</span>
<span class="n">model</span><span class="o">.</span><span class="n">summary</span><span class="p">()</span>
<span class="n">model</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">trainX</span><span class="p">,</span><span class="n">trainY</span><span class="p">,</span> <span class="n">epochs</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="n">trainPredict</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">trainX</span><span class="p">)</span>
<span class="n">testPredict</span><span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">testX</span><span class="p">)</span>
<span class="n">predicted</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">((</span><span class="n">trainPredict</span><span class="p">,</span><span class="n">testPredict</span><span class="p">),</span><span class="n">axis</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="n">trainScore</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">trainX</span><span class="p">,</span> <span class="n">trainY</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">trainScore</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">predicted</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</section>
<section id="rnns">
<h2>RNNs<a class="headerlink" href="#rnns" title="Link to this heading">#</a></h2>
<p>RNNs are very powerful, because they
combine two properties:</p>
<ol class="arabic simple">
<li><p>Distributed hidden state that allows them to store a lot of information about the past efficiently.</p></li>
<li><p>Non-linear dynamics that allows them to update their hidden state in complicated ways.</p></li>
</ol>
<p>With enough neurons and time, RNNs
can compute anything that can be
computed by your computer.</p>
</section>
<section id="what-kinds-of-behaviour-can-rnns-exhibit">
<h2>What kinds of behaviour can RNNs exhibit?<a class="headerlink" href="#what-kinds-of-behaviour-can-rnns-exhibit" title="Link to this heading">#</a></h2>
<ol class="arabic simple">
<li><p>They can oscillate.</p></li>
<li><p>They can settle to point attractors.</p></li>
<li><p>They can behave chaotically.</p></li>
<li><p>RNNs could potentially learn to implement lots of small programs that each capture a nugget of knowledge and run in parallel, interacting to produce very complicated effects.</p></li>
</ol>
<p>But the extensive computational needs of RNNs makes them very hard to train.</p>
</section>
<section id="basic-layout-figures-from-sebastian-rashcka-et-al-machine-learning-with-sickit-learn-and-pytorch">
<h2>Basic layout, <a class="reference external" href="https://sebastianraschka.com/blog/2022/ml-pytorch-book.html">Figures from Sebastian Rashcka et al, Machine learning with Sickit-Learn and PyTorch</a><a class="headerlink" href="#basic-layout-figures-from-sebastian-rashcka-et-al-machine-learning-with-sickit-learn-and-pytorch" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN1.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN1.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="solving-differential-equations-with-rnns">
<h2>Solving differential equations with RNNs<a class="headerlink" href="#solving-differential-equations-with-rnns" title="Link to this heading">#</a></h2>
<p>To gain some intuition on how we can use RNNs for time series, let us
tailor the representation of the solution of a differential equation
as a time series.</p>
<p>Consider the famous differential equation (Newtons equation of motion for damped harmonic oscillations, scaled in terms of dimensionless time)</p>
<div class="math notranslate nohighlight">
\[
\frac{d^2x}{dt^2}+\eta\frac{dx}{dt}+x(t)=F(t),
\]</div>
<p>where <span class="math notranslate nohighlight">\(\eta\)</span> is a constant used in scaling time into a dimensionless variable and <span class="math notranslate nohighlight">\(F(t)\)</span> is an external force acting on the system.
The constant <span class="math notranslate nohighlight">\(\eta\)</span> is a so-called damping.</p>
</section>
<section id="two-first-order-differential-equations">
<h2>Two first-order differential equations<a class="headerlink" href="#two-first-order-differential-equations" title="Link to this heading">#</a></h2>
<p>In solving the above second-order equation, it is common to rewrite it in terms of two coupled first-order equations
with the velocity</p>
<div class="math notranslate nohighlight">
\[
v(t)=\frac{dx}{dt},
\]</div>
<p>and the acceleration</p>
<div class="math notranslate nohighlight">
\[
\frac{dv}{dt}=F(t)-\eta v(t)-x(t).
\]</div>
<p>With the initial conditions <span class="math notranslate nohighlight">\(v_0=v(t_0)\)</span> and <span class="math notranslate nohighlight">\(x_0=x(t_0)\)</span> defined, we can integrate these equations and find their respective solutions.</p>
</section>
<section id="velocity-only">
<h2>Velocity only<a class="headerlink" href="#velocity-only" title="Link to this heading">#</a></h2>
<p>Let us focus on the velocity only. Discretizing and using the simplest
possible approximation for the derivative, we have Eulers forward
method for the updated velocity at a time step <span class="math notranslate nohighlight">\(i+1\)</span> given by</p>
<div class="math notranslate nohighlight">
\[
v_{i+1}=v_i+\Delta t \frac{dv}{dt}_{\vert_{v=v_i}}=v_i+\Delta t\left(F_i-\eta v_i-x_i\right).
\]</div>
<p>Defining a function</p>
<div class="math notranslate nohighlight">
\[
h_i(x_i,v_i,F_i)=v_i+\Delta t\left(F_i-\eta v_i-x_i\right),
\]</div>
<p>we have</p>
<div class="math notranslate nohighlight">
\[
v_{i+1}=h_i(x_i,v_i,F_i).
\]</div>
</section>
<section id="linking-with-rnns">
<h2>Linking with RNNs<a class="headerlink" href="#linking-with-rnns" title="Link to this heading">#</a></h2>
<p>The equation</p>
<div class="math notranslate nohighlight">
\[
v_{i+1}=h_i(x_i,v_i,F_i).
\]</div>
<p>can be used to train a feed-forward neural network with inputs <span class="math notranslate nohighlight">\(v_i\)</span> and outputs <span class="math notranslate nohighlight">\(v_{i+1}\)</span> at a time <span class="math notranslate nohighlight">\(t_i\)</span>. But we can think of this also as a recurrent neural network
with inputs <span class="math notranslate nohighlight">\(v_i\)</span>, <span class="math notranslate nohighlight">\(x_i\)</span> and <span class="math notranslate nohighlight">\(F_i\)</span> at each time step <span class="math notranslate nohighlight">\(t_i\)</span>, and producing an output <span class="math notranslate nohighlight">\(v_{i+1}\)</span>.</p>
<p>Noting that</p>
<div class="math notranslate nohighlight">
\[
v_{i}=v_{i-1}+\Delta t\left(F_{i-1}-\eta v_{i-1}-x_{i-1}\right)=h_{i-1}.
\]</div>
<p>we have</p>
<div class="math notranslate nohighlight">
\[
v_{i}=h_{i-1}(x_{i-1},v_{i-1},F_{i-1}),
\]</div>
<p>and we can rewrite</p>
<div class="math notranslate nohighlight">
\[
v_{i+1}=h_i(x_i,h_{i-1},F_i).
\]</div>
</section>
<section id="minor-rewrite">
<h2>Minor rewrite<a class="headerlink" href="#minor-rewrite" title="Link to this heading">#</a></h2>
<p>We can thus set up a recurring series which depends on the inputs <span class="math notranslate nohighlight">\(x_i\)</span> and <span class="math notranslate nohighlight">\(F_i\)</span> and the previous values <span class="math notranslate nohighlight">\(h_{i-1}\)</span>.
We assume now that the inputs at each step (or time <span class="math notranslate nohighlight">\(t_i\)</span>) is given by <span class="math notranslate nohighlight">\(x_i\)</span> only and we denote the outputs for <span class="math notranslate nohighlight">\(\tilde{y}_i\)</span> instead of <span class="math notranslate nohighlight">\(v_{i_1}\)</span>, we have then the compact equation for our outputs at each step <span class="math notranslate nohighlight">\(t_i\)</span></p>
<div class="math notranslate nohighlight">
\[
y_{i}=h_i(x_i,h_{i-1}).
\]</div>
<p>We can think of this as an element in a recurrent network where our
network (our model) produces an output <span class="math notranslate nohighlight">\(y_i\)</span> which is then compared
with a target value through a given cost/loss function that we
optimize. The target values at a given step <span class="math notranslate nohighlight">\(t_i\)</span> could be the results
of a measurement or simply the analytical results of a differential
equation.</p>
</section>
<section id="rnns-in-more-detail">
<h2>RNNs in more detail<a class="headerlink" href="#rnns-in-more-detail" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN2.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN2.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="rnns-in-more-detail-part-2">
<h2>RNNs in more detail, part 2<a class="headerlink" href="#rnns-in-more-detail-part-2" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN3.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN3.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="rnns-in-more-detail-part-3">
<h2>RNNs in more detail, part 3<a class="headerlink" href="#rnns-in-more-detail-part-3" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN4.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN4.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="rnns-in-more-detail-part-4">
<h2>RNNs in more detail, part 4<a class="headerlink" href="#rnns-in-more-detail-part-4" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN5.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN5.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="rnns-in-more-detail-part-5">
<h2>RNNs in more detail, part 5<a class="headerlink" href="#rnns-in-more-detail-part-5" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN6.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN6.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="rnns-in-more-detail-part-6">
<h2>RNNs in more detail, part 6<a class="headerlink" href="#rnns-in-more-detail-part-6" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN7.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN7.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="rnns-in-more-detail-part-7">
<h2>RNNs in more detail, part 7<a class="headerlink" href="#rnns-in-more-detail-part-7" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN8.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN8.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="backpropagation-through-time">
<h2>Backpropagation through time<a class="headerlink" href="#backpropagation-through-time" title="Link to this heading">#</a></h2>
<p>We can think of the recurrent net as a layered, feed-forward
net with shared weights and then train the feed-forward net
with weight constraints.</p>
<p>We can also think of this training algorithm in the time domain:</p>
<ol class="arabic simple">
<li><p>The forward pass builds up a stack of the activities of all the units at each time step.</p></li>
<li><p>The backward pass peels activities off the stack to compute the error derivatives at each time step.</p></li>
<li><p>After the backward pass we add together the derivatives at all the different times for each weight.</p></li>
</ol>
</section>
<section id="the-backward-pass-is-linear">
<h2>The backward pass is linear<a class="headerlink" href="#the-backward-pass-is-linear" title="Link to this heading">#</a></h2>
<ol class="arabic simple">
<li><p>There is a big difference between the forward and backward passes.</p></li>
<li><p>In the forward pass we use squashing functions (like the logistic) to prevent the activity vectors from exploding.</p></li>
<li><p>The backward pass, is completely linear. If you double the error derivatives at the final layer, all the error derivatives will double.</p></li>
</ol>
<p>The forward pass determines the slope of the linear function used for
backpropagating through each neuron</p>
</section>
<section id="the-problem-of-exploding-or-vanishing-gradients">
<h2>The problem of exploding or vanishing gradients<a class="headerlink" href="#the-problem-of-exploding-or-vanishing-gradients" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>What happens to the magnitude of the gradients as we backpropagate through many layers?</p></li>
</ul>
<p>a. If the weights are small, the gradients shrink exponentially.</p>
<p>b. If the weights are big the gradients grow exponentially.</p>
<ul class="simple">
<li><p>Typical feed-forward neural nets can cope with these exponential effects because they only have a few hidden layers.</p></li>
<li><p>In an RNN trained on long sequences (e.g. 100 time steps) the gradients can easily explode or vanish.</p></li>
</ul>
<p>a. We can avoid this by initializing the weights very carefully.</p>
<ul class="simple">
<li><p>Even with good initial weights, its very hard to detect that the current target output depends on an input from many time-steps ago.</p></li>
</ul>
<p>RNNs have difficulty dealing with long-range dependencies.</p>
</section>
<section id="mathematical-setup">
<h2>Mathematical setup<a class="headerlink" href="#mathematical-setup" title="Link to this heading">#</a></h2>
<p>The expression for the simplest Recurrent network resembles that of a
regular feed-forward neural network, but now with
the concept of temporal dependencies</p>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{align*}
\mathbf{a}^{(t)} &amp; = U * \mathbf{x}^{(t)} + W * \mathbf{h}^{(t-1)} + \mathbf{b}, \notag \\
\mathbf{h}^{(t)} &amp;= \sigma_h(\mathbf{a}^{(t)}), \notag\\
\mathbf{y}^{(t)} &amp;= V * \mathbf{h}^{(t)} + \mathbf{c}, \notag\\
\mathbf{\hat{y}}^{(t)} &amp;= \sigma_y(\mathbf{y}^{(t)}).
\end{align*}
\end{split}\]</div>
</section>
<section id="back-propagation-in-time-through-figures-part-1">
<h2>Back propagation in time through figures, part 1<a class="headerlink" href="#back-propagation-in-time-through-figures-part-1" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN9.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN9.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="back-propagation-in-time-part-2">
<h2>Back propagation in time, part 2<a class="headerlink" href="#back-propagation-in-time-part-2" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN10.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN10.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="back-propagation-in-time-part-3">
<h2>Back propagation in time, part 3<a class="headerlink" href="#back-propagation-in-time-part-3" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN11.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN11.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="back-propagation-in-time-part-4">
<h2>Back propagation in time, part 4<a class="headerlink" href="#back-propagation-in-time-part-4" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/RNN12.png, width=700 frac=0.9] -->
<!-- begin figure -->
<p><img src="figslides/RNN12.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="back-propagation-in-time-in-equations">
<h2>Back propagation in time in equations<a class="headerlink" href="#back-propagation-in-time-in-equations" title="Link to this heading">#</a></h2>
<p>To derive the expression of the gradients of <span class="math notranslate nohighlight">\(\mathcal{L}\)</span> for
the RNN, we need to start recursively from the nodes closer to the
output layer in the temporal unrolling scheme - such as <span class="math notranslate nohighlight">\(\mathbf{y}\)</span>
and <span class="math notranslate nohighlight">\(\mathbf{h}\)</span> at final time <span class="math notranslate nohighlight">\(t = \tau\)</span>,</p>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{align*}
(\nabla_{ \mathbf{y}^{(t)}} \mathcal{L})_{i} &amp;= \frac{\partial \mathcal{L}}{\partial L^{(t)}}\frac{\partial L^{(t)}}{\partial y_{i}^{(t)}}, \notag\\
\nabla_{\mathbf{h}^{(\tau)}} \mathcal{L} &amp;= \mathbf{V}^\mathsf{T}\nabla_{ \mathbf{y}^{(\tau)}} \mathcal{L}.
\end{align*}
\end{split}\]</div>
</section>
<section id="chain-rule-again">
<h2>Chain rule again<a class="headerlink" href="#chain-rule-again" title="Link to this heading">#</a></h2>
<p>For the following hidden nodes, we have to iterate through time, so by the chain rule,</p>
<div class="math notranslate nohighlight">
\[
\begin{align*}
\nabla_{\mathbf{h}^{(t)}} \mathcal{L} &amp;= \left(\frac{\partial\mathbf{h}^{(t+1)}}{\partial\mathbf{h}^{(t)}}\right)^\mathsf{T}\nabla_{\mathbf{h}^{(t+1)}}\mathcal{L} + \left(\frac{\partial\mathbf{y}^{(t)}}{\partial\mathbf{h}^{(t)}}\right)^\mathsf{T}\nabla_{ \mathbf{y}^{(t)}} \mathcal{L}.
\end{align*}
\]</div>
</section>
<section id="gradients-of-loss-functions">
<h2>Gradients of loss functions<a class="headerlink" href="#gradients-of-loss-functions" title="Link to this heading">#</a></h2>
<p>Similarly, the gradients of <span class="math notranslate nohighlight">\(\mathcal{L}\)</span> with respect to the weights and biases follow,</p>
<!-- Equation labels as ordinary links -->
<div id="eq:rnn_gradients3"></div>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{align*}
\nabla_{\mathbf{c}} \mathcal{L} &amp;=\sum_{t}\left(\frac{\partial \mathbf{y}^{(t)}}{\partial \mathbf{c}}\right)^\mathsf{T} \nabla_{\mathbf{y}^{(t)}} \mathcal{L} \notag\\
\nabla_{\mathbf{b}} \mathcal{L} &amp;=\sum_{t}\left(\frac{\partial \mathbf{h}^{(t)}}{\partial \mathbf{b}}\right)^\mathsf{T} \nabla_{\mathbf{h}^{(t)}} \mathcal{L} \notag\\
\nabla_{\mathbf{V}} \mathcal{L} &amp;=\sum_{t}\sum_{i}\left(\frac{\partial \mathcal{L}}{\partial y_i^{(t)} }\right)\nabla_{\mathbf{V}^{(t)}}y_i^{(t)} \notag\\
\nabla_{\mathbf{W}} \mathcal{L} &amp;=\sum_{t}\sum_{i}\left(\frac{\partial \mathcal{L}}{\partial h_i^{(t)}}\right)\nabla_{\mathbf{w}^{(t)}} h_i^{(t)} \notag\\
\nabla_{\mathbf{U}} \mathcal{L} &amp;=\sum_{t}\sum_{i}\left(\frac{\partial \mathcal{L}}{\partial h_i^{(t)}}\right)\nabla_{\mathbf{U}^{(t)}}h_i^{(t)}.
\label{eq:rnn_gradients3} \tag{1}
\end{align*}
\end{split}\]</div>
</section>
<section id="summary-of-rnns">
<h2>Summary of RNNs<a class="headerlink" href="#summary-of-rnns" title="Link to this heading">#</a></h2>
<p>Recurrent neural networks (RNNs) have in general no probabilistic component
in a model. With a given fixed input and target from data, the RNNs learn the intermediate
association between various layers.
The inputs, outputs, and internal representation (hidden states) are all
real-valued vectors.</p>
<p>In a traditional NN, it is assumed that every input is
independent of each other. But with sequential data, the input at a given stage <span class="math notranslate nohighlight">\(t\)</span> depends on the input from the previous stage <span class="math notranslate nohighlight">\(t-1\)</span></p>
</section>
<section id="summary-of-a-typical-rnn">
<h2>Summary of a typical RNN<a class="headerlink" href="#summary-of-a-typical-rnn" title="Link to this heading">#</a></h2>
<ol class="arabic simple">
<li><p>Weight matrices <span class="math notranslate nohighlight">\(U\)</span>, <span class="math notranslate nohighlight">\(W\)</span> and <span class="math notranslate nohighlight">\(V\)</span> that connect the input layer at a stage <span class="math notranslate nohighlight">\(t\)</span> with the hidden layer <span class="math notranslate nohighlight">\(h_t\)</span>, the previous hidden layer <span class="math notranslate nohighlight">\(h_{t-1}\)</span> with <span class="math notranslate nohighlight">\(h_t\)</span> and the hidden layer <span class="math notranslate nohighlight">\(h_t\)</span> connecting with the output layer at the same stage and producing an output <span class="math notranslate nohighlight">\(\tilde{y}_t\)</span>, respectively.</p></li>
<li><p>The output from the hidden layer <span class="math notranslate nohighlight">\(h_t\)</span> is oftem modulated by a <span class="math notranslate nohighlight">\(\tanh{}\)</span> function <span class="math notranslate nohighlight">\(h_t=\sigma_h(x_t,h_{t-1})=\tanh{(Ux_t+Wh_{t-1}+b)}\)</span> with <span class="math notranslate nohighlight">\(b\)</span> a bias value</p></li>
<li><p>The output from the hidden layer produces <span class="math notranslate nohighlight">\(\tilde{y}_t=\sigma_y(Vh_t+c)\)</span> where <span class="math notranslate nohighlight">\(c\)</span> is a new bias parameter.</p></li>
<li><p>The output from the training at a given stage is in turn compared with the observation <span class="math notranslate nohighlight">\(y_t\)</span> thorugh a chosen cost function.</p></li>
</ol>
<p>The function <span class="math notranslate nohighlight">\(g\)</span> can any of the standard activation functions, that is a Sigmoid, a Softmax, a ReLU and other.
The parameters are trained through the so-called back-propagation through time (BPTT) algorithm.</p>
</section>
<section id="four-effective-ways-to-learn-an-rnn-and-preparing-for-next-week">
<h2>Four effective ways to learn an RNN and preparing for next week<a class="headerlink" href="#four-effective-ways-to-learn-an-rnn-and-preparing-for-next-week" title="Link to this heading">#</a></h2>
<ol class="arabic simple">
<li><p>Long Short Term Memory Make the RNN out of little modules that are designed to remember values for a long time.</p></li>
<li><p>Hessian Free Optimization: Deal with the vanishing gradients problem by using a fancy optimizer that can detect directions with a tiny gradient but even smaller curvature.</p></li>
<li><p>Echo State Networks: Initialize the input a hidden and hidden-hidden and output-hidden connections very carefully so that the hidden state has a huge reservoir of weakly coupled oscillators which can be selectively driven by the input.</p></li>
</ol>
<ul class="simple">
<li><p>ESNs only need to learn the hidden-output connections.</p></li>
</ul>
<ol class="arabic simple" start="4">
<li><p>Good initialization with momentum Initialize like in Echo State Networks, but then learn all of the connections using momentum</p></li>
</ol>
</section>
<section id="gating-mechanism-long-short-term-memory-lstm">
<h2>Gating mechanism: Long Short Term Memory (LSTM)<a class="headerlink" href="#gating-mechanism-long-short-term-memory-lstm" title="Link to this heading">#</a></h2>
<p>Besides a simple recurrent neural network layer, as discussed above, there are two other
commonly used types of recurrent neural network layers: Long Short
Term Memory (LSTM) and Gated Recurrent Unit (GRU). For a short
introduction to these layers see <a class="reference external" href="https://medium.com/mindboard/lstm-vs-gru-experimental-comparison-955820c21e8b">https://medium.com/mindboard/lstm-vs-gru-experimental-comparison-955820c21e8b</a>
and <a class="reference external" href="https://medium.com/mindboard/lstm-vs-gru-experimental-comparison-955820c21e8b">https://medium.com/mindboard/lstm-vs-gru-experimental-comparison-955820c21e8b</a>.</p>
<p>LSTM uses a memory cell for
modeling long-range dependencies and avoid vanishing gradient
problems.
Capable of modeling longer term dependencies by having
memory cells and gates that controls the information flow along
with the memory cells.</p>
<ol class="arabic simple">
<li><p>Introduced by Hochreiter and Schmidhuber (1997) who solved the problem of getting an RNN to remember things for a long time (like hundreds of time steps).</p></li>
<li><p>They designed a memory cell using logistic and linear units with multiplicative interactions.</p></li>
<li><p>Information gets into the cell whenever its “write” gate is on.</p></li>
<li><p>The information stays in the cell so long as its <strong>keep</strong> gate is on.</p></li>
<li><p>Information can be read from the cell by turning on its <strong>read</strong> gate.</p></li>
</ol>
</section>
<section id="implementing-a-memory-cell-in-a-neural-network">
<h2>Implementing a memory cell in a neural network<a class="headerlink" href="#implementing-a-memory-cell-in-a-neural-network" title="Link to this heading">#</a></h2>
<p>To preserve information for a long time in
the activities of an RNN, we use a circuit
that implements an analog memory cell.</p>
<ol class="arabic simple">
<li><p>A linear unit that has a self-link with a weight of 1 will maintain its state.</p></li>
<li><p>Information is stored in the cell by activating its write gate.</p></li>
<li><p>Information is retrieved by activating the read gate.</p></li>
<li><p>We can backpropagate through this circuit because logistics are have nice derivatives.</p></li>
</ol>
</section>
<section id="lstm-details">
<h2>LSTM details<a class="headerlink" href="#lstm-details" title="Link to this heading">#</a></h2>
<p>The LSTM is a unit cell that is made of three gates:</p>
<ol class="arabic simple">
<li><p>the input gate,</p></li>
<li><p>the forget gate,</p></li>
<li><p>and the output gate.</p></li>
</ol>
<p>It also introduces a cell state <span class="math notranslate nohighlight">\(c\)</span>, which can be thought of as the
long-term memory, and a hidden state <span class="math notranslate nohighlight">\(h\)</span> which can be thought of as
the short-term memory.</p>
</section>
<section id="basic-layout">
<h2>Basic layout<a class="headerlink" href="#basic-layout" title="Link to this heading">#</a></h2>
<!-- dom:FIGURE: [figslides/lstm.png, width=700 frac=1.0] -->
<!-- begin figure -->
<p><img src="figslides/lstm.png" width="700"><p style="font-size: 0.9em"><i>Figure 1: </i></p></p>
<!-- end figure --></section>
<section id="more-lstm-details">
<h2>More LSTM details<a class="headerlink" href="#more-lstm-details" title="Link to this heading">#</a></h2>
<p>The first stage is called the forget gate, where we combine the input
at (say, time <span class="math notranslate nohighlight">\(t\)</span>), and the hidden cell state input at <span class="math notranslate nohighlight">\(t-1\)</span>, passing
it through the Sigmoid activation function and then performing an
element-wise multiplication, denoted by <span class="math notranslate nohighlight">\(\otimes\)</span>.</p>
<p>It follows</p>
<div class="math notranslate nohighlight">
\[
\mathbf{f}^{(t)} = \sigma(W_f\mathbf{x}^{(t)} + U_f\mathbf{h}^{(t-1)} + \mathbf{b}_f)
\]</div>
<p>where <span class="math notranslate nohighlight">\(W\)</span> and <span class="math notranslate nohighlight">\(U\)</span> are the weights respectively.</p>
</section>
<section id="the-forget-gate">
<h2>The forget gate<a class="headerlink" href="#the-forget-gate" title="Link to this heading">#</a></h2>
<p>This is called the forget gate since the Sigmoid activation functions
outputs are very close to <span class="math notranslate nohighlight">\(0\)</span> if the argument for the function is very
negative, and <span class="math notranslate nohighlight">\(1\)</span> if the argument is very positive. Hence we can
control the amount of information we want to take from the long-term
memory.</p>
</section>
<section id="input-gate">
<h2>Input gate<a class="headerlink" href="#input-gate" title="Link to this heading">#</a></h2>
<p>The next stage is the input gate, which consists of both a Sigmoid
function (<span class="math notranslate nohighlight">\(\sigma_i\)</span>), which decide what percentage of the input will
be stored in the long-term memory, and the <span class="math notranslate nohighlight">\(\tanh_i\)</span> function, which
decide what is the full memory that can be stored in the long term
memory. When these results are calculated and multiplied together, it
is added to the cell state or stored in the long-term memory, denoted
as <span class="math notranslate nohighlight">\(\oplus\)</span>.</p>
<p>We have</p>
<div class="math notranslate nohighlight">
\[
\mathbf{i}^{(t)} = \sigma_g(W_i\mathbf{x}^{(t)} + U_i\mathbf{h}^{(t-1)} + \mathbf{b}_i),
\]</div>
<p>and</p>
<div class="math notranslate nohighlight">
\[
\mathbf{\tilde{c}}^{(t)} = \tanh(W_c\mathbf{x}^{(t)} + U_c\mathbf{h}^{(t-1)} + \mathbf{b}_c),
\]</div>
<p>again the <span class="math notranslate nohighlight">\(W\)</span> and <span class="math notranslate nohighlight">\(U\)</span> are the weights.</p>
</section>
<section id="forget-and-input">
<h2>Forget and input<a class="headerlink" href="#forget-and-input" title="Link to this heading">#</a></h2>
<p>The forget gate and the input gate together also update the cell state with the following equation,</p>
<div class="math notranslate nohighlight">
\[
\mathbf{c}^{(t)} = \mathbf{f}^{(t)} \otimes \mathbf{c}^{(t-1)} + \mathbf{i}^{(t)} \otimes \mathbf{\tilde{c}}^{(t)},
\]</div>
<p>where <span class="math notranslate nohighlight">\(f^{(t)}\)</span> and <span class="math notranslate nohighlight">\(i^{(t)}\)</span> are the outputs of the forget gate and the input gate, respectively.</p>
</section>
<section id="output-gate">
<h2>Output gate<a class="headerlink" href="#output-gate" title="Link to this heading">#</a></h2>
<p>The final stage of the LSTM is the output gate, and its purpose is to
update the short-term memory. To achieve this, we take the newly
generated long-term memory and process it through a hyperbolic tangent
(<span class="math notranslate nohighlight">\(\tanh\)</span>) function creating a potential new short-term memory. We then
multiply this potential memory by the output of the Sigmoid function
(<span class="math notranslate nohighlight">\(\sigma_o\)</span>). This multiplication generates the final output as well
as the input for the next hidden cell (<span class="math notranslate nohighlight">\(h^{\langle t \rangle}\)</span>) within
the LSTM cell.</p>
<p>We have</p>
<div class="math notranslate nohighlight">
\[\begin{split}
\begin{aligned}
\mathbf{o}^{(t)} &amp;= \sigma_g(W_o\mathbf{x}^{(t)} + U_o\mathbf{h}^{(t-1)} + \mathbf{b}_o), \\
\mathbf{h}^{(t)} &amp;= \mathbf{o}^{(t)} \otimes \sigma_h(\mathbf{c}^{(t)}). \\
\end{aligned}
\end{split}\]</div>
<p>where <span class="math notranslate nohighlight">\(\mathbf{W_o,U_o}\)</span> are the weights of the output gate and <span class="math notranslate nohighlight">\(\mathbf{b_o}\)</span> is the bias of the output gate.</p>
</section>
</section>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
name: "python3",
path: "./."
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="week44.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Week 44, Convolutional Neural Networks (CNN)</p>
</div>
</a>
<a class="right-next"
href="week46.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Week 46: Decision Trees, Ensemble methods and Random Forests</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#plans-for-week-45">Plans for week 45</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#material-for-the-lab-sessions-additional-ways-to-present-classification-results-and-other-practicalities">Material for the lab sessions, additional ways to present classification results and other practicalities</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#material-for-lecture-monday-november-4">Material for Lecture Monday November 4</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#convolutional-neural-networks-recognizing-images">Convolutional Neural Networks (recognizing images)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-is-the-difference">What is the Difference</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#neural-networks-vs-cnns">Neural Networks vs CNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-cnns-for-images-sound-files-medical-images-from-ct-scans-etc">Why CNNS for images, sound files, medical images from CT scans etc?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#regular-nns-dont-scale-well-to-full-images">Regular NNs dont scale well to full images</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#d-volumes-of-neurons">3D volumes of neurons</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#layers-used-to-build-cnns">Layers used to build CNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cnns-in-brief">CNNs in brief</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-deep-cnn-model-from-raschka-et-al">A deep CNN model (From Raschka et al)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#key-idea">Key Idea</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-convolutional-neural-networks-in-tensorflow-and-keras">Building convolutional neural networks in Tensorflow and Keras</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-it-up">Setting it up</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-mnist-dataset-again">The MNIST dataset again</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#strong-correlations">Strong correlations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#layers-of-a-cnn">Layers of a CNN</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#systematic-reduction">Systematic reduction</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#prerequisites-collect-and-pre-process-data">Prerequisites: Collect and pre-process data</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#importing-keras-and-tensorflow">Importing Keras and Tensorflow</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#running-with-keras">Running with Keras</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#final-part">Final part</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#final-visualization">Final visualization</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-cifar01-data-set">The CIFAR01 data set</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#verifying-the-data-set">Verifying the data set</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#set-up-the-model">Set up the model</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#add-dense-layers-on-top">Add Dense layers on top</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#compile-and-train-the-model">Compile and train the model</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#finally-evaluate-the-model">Finally, evaluate the model</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-our-own-cnn-code">Building our own CNN code</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#list-of-contents">List of contents:</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#schedulers">Schedulers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-schedulers">Usage of schedulers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#cost-functions">Cost functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-cost-functions">Usage of cost functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#activation-functions">Activation functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-activation-functions">Usage of activation functions</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution">Convolution</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#layers">Layers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution2dlayer-convolution-in-a-hidden-layer">Convolution2DLayer: convolution in a hidden layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#backpropagation-in-the-convolutional-layer">Backpropagation in the convolutional layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#demonstration">Demonstration</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pooling-layer">Pooling Layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#flattening-layer">Flattening Layer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#fully-connected-layers">Fully Connected Layers</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#optimized-convolution2dlayer">Optimized Convolution2DLayer</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-convolutional-neural-network-cnn">The Convolutional Neural Network (CNN)</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-of-cnn-code">Usage of CNN code</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-remarks">Additional Remarks</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#remarks-on-the-speed">Remarks on the speed</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution-using-separable-kernels">Convolution using separable kernels</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#convolution-in-the-fourier-domain">Convolution in the Fourier domain</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#from-ffnns-and-cnns-to-recurrent-neural-networks-rnns">From FFNNs and CNNs to recurrent neural networks (RNNs)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#feedback-connections">Feedback connections</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#vanishing-gradients">Vanishing gradients</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#recurrent-neural-networks-rnns-overarching-view">Recurrent neural networks (RNNs): Overarching view</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sequential-data-only">Sequential data only?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#differential-equations">Differential equations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#a-simple-example">A simple example</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns">RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-kinds-of-behaviour-can-rnns-exhibit">What kinds of behaviour can RNNs exhibit?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#basic-layout-figures-from-sebastian-rashcka-et-al-machine-learning-with-sickit-learn-and-pytorch">Basic layout, Figures from Sebastian Rashcka et al, Machine learning with Sickit-Learn and PyTorch</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#solving-differential-equations-with-rnns">Solving differential equations with RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#two-first-order-differential-equations">Two first-order differential equations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#velocity-only">Velocity only</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#linking-with-rnns">Linking with RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#minor-rewrite">Minor rewrite</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail">RNNs in more detail</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-2">RNNs in more detail, part 2</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-3">RNNs in more detail, part 3</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-4">RNNs in more detail, part 4</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-5">RNNs in more detail, part 5</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-6">RNNs in more detail, part 6</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rnns-in-more-detail-part-7">RNNs in more detail, part 7</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#backpropagation-through-time">Backpropagation through time</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-backward-pass-is-linear">The backward pass is linear</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-problem-of-exploding-or-vanishing-gradients">The problem of exploding or vanishing gradients</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#mathematical-setup">Mathematical setup</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-through-figures-part-1">Back propagation in time through figures, part 1</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-part-2">Back propagation in time, part 2</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-part-3">Back propagation in time, part 3</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-part-4">Back propagation in time, part 4</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#back-propagation-in-time-in-equations">Back propagation in time in equations</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#chain-rule-again">Chain rule again</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#gradients-of-loss-functions">Gradients of loss functions</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary-of-rnns">Summary of RNNs</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary-of-a-typical-rnn">Summary of a typical RNN</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#four-effective-ways-to-learn-an-rnn-and-preparing-for-next-week">Four effective ways to learn an RNN and preparing for next week</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#gating-mechanism-long-short-term-memory-lstm">Gating mechanism: Long Short Term Memory (LSTM)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#implementing-a-memory-cell-in-a-neural-network">Implementing a memory cell in a neural network</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#lstm-details">LSTM details</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#basic-layout">Basic layout</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#more-lstm-details">More LSTM details</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-forget-gate">The forget gate</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#input-gate">Input gate</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#forget-and-input">Forget and input</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#output-gate">Output gate</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Morten Hjorth-Jensen
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2023.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>
<footer class="bd-footer">
</footer>
</body>
</html>