Welcome to SimpleNet’s documentation!

SimpleNet

master: master branch build status

A simple neural network in Python

Features

  • Simple interface

  • Minimal dependencies (numpy)

  • Runs on Pythonista on iOS

  • Attempts to verify accuracy by comparing results with popular frameworks Keras and Tensorflow

Introduction

This is a simple multilayer perceptron that I decided to build as I learned a little bit about machine learning and neural networks. It doesn’t have many features.

Dependencies

  • Python >= 3.8

  • numpy

Quickstart

  1. pip3 install simplenet

  2. See examples/

Development Setup

  1. Clone the repo: git clone https://github.com/n8henrie/simplenet && cd simplenet

  2. Make a virtualenv: python3 -m venv .venv

  3. source venv/bin/activate

  4. pip install -e .[dev]

Acknowledgements

  • Andrew Ng’s Coursera courses

TODO

I don’t really know any Latex, so if anybody wants to help me fill out some of the other docstrings with pretty equations, feel free. I’m also not a mathematician, so if anything doesn’t seem quite right, feel free to speak up.

Troubleshooting / FAQ

  • How can I install an older / specific version of SimpleNet?

    • Install from a tag:

      • pip install git+git://github.com/n8henrie/simplenet.git@v0.1.0

    • Install from a specific commit:

      • pip install git+git://github.com/n8henrie/simplenet.git@aabc123def456ghi789

Changelog

0.1.4 :: 20220-06-19

  • Fix README error, version bump for pypi

0.1.3 :: 20220-06-19

  • Update dependencies and tests to run on modern python and tensorflow

  • Deprecate python3.5-3.7 due to numpy dependency

  • Use GitHub Actions instead of Travis

  • Add an experimental Dockerfile for reproducibility with tests

0.1.2 :: 2017-12-12

  • Update initialization (now uses something like Xavier)

0.1.0 :: 2017-11-02

  • First release on PyPI / GitHub.

Indices and tables