Simple Neural Network Project

A simple, hand-rolled neural network project for testing and exploration.

Prerequisites

You need to have Python 3.10 or newer installed on your system to run this project. This project uses Poetry for dependency management.

Installing

First, clone the repository to your local machine:

git clone https://github.com/DeepBlockDeepak/my-neural-network.git
cd my-neural-network

Then, install the dependencies using Poetry:

poetry install

This will create a virtual environment and install all required dependencies into it.

Running Tests

This project uses pytest for running unit tests. To run the unit tests, use:

poetry run test

Generating Coverage Reports

To generate and view a coverage report, run:

poetry run coverage

This will generate a coverage report and save it as an HTML file in a directory called coverage_html.

Formatting and Linting

This project uses isort and black for formatting and ruff for linting. You can format and lint the code using the provided custom Poetry scripts:

To Format:

poetry run format

To Lint:

poetry run lint

To perform formatting, linting, and unit-testing sequentially, you can run:

poetry run all-checks

CI/CD

Continuous Integration is set up with GitHub Actions, which will format, lint, and run tests on the codebase when pushed to the repository.

See ci.yml for details.