ProtoPNet

ProtoPNet is a website that allows users to upload images of birds and get predictions of their species using a deep learning model called ProtoPNet.

Features

• Upload your own bird images and get the top 5 predictions of the bird's species
• Along with the predictions, you can see which parts of the image affected the model's decision the most in form of a heatmap
• See to what countries the bird is native to on a map (either a globe or a flat map)

How to use

Either visit the demo or follow the installation instructions below to run the website locally.

Requirements

• Python 3.11
• Node.js 18
• Make
• pipenv
• pnpm

Installation

1. Clone the repo: git clone <repo_url>
2. Change directory: cd ProtoPNet
3. Install dependencies: make install

Backend

1. Modify .env.example and rename it to .env
2. make backend to start the backend server

Alternatively, use the docker image or build your own as shown in the docker compose file.

Frontend

1. make frontend to start the frontend server

License

Distributed under the MIT License. See LICENSE for more information.