https://github.com/puravparab/whatanimal
Machine learning web application that classifies animal images using CNNs
https://github.com/puravparab/whatanimal
deep-learning django machine-learning python react tensorflow
Last synced: 3 months ago
JSON representation
Machine learning web application that classifies animal images using CNNs
- Host: GitHub
- URL: https://github.com/puravparab/whatanimal
- Owner: puravparab
- License: mit
- Created: 2022-08-10T23:26:57.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-23T22:33:24.000Z (about 3 years ago)
- Last Synced: 2025-02-05T07:28:42.073Z (over 1 year ago)
- Topics: deep-learning, django, machine-learning, python, react, tensorflow
- Language: JavaScript
- Homepage: https://whatanimal.vercel.app/
- Size: 62.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
WHATANIMAL
Image recognition web app that guesses animals from uploaded images using CNNs
REQUIREMENTS
|
INSTALLATION
|
LICENSE
|
Model
# Requirements:
- `python 3.10`
- `node v18.16.0`
- `npm 9.5.1`
- `tensorflow`
- `AWS S3`
---
# Installation:
Clone the respository
```
git clone https://github.com/puravparab/whatanimal.git
cd whatanimal
```
## Using Docker Compose
Run docker compose to run the application
```
docker compose up --build
// or run in detached mode
docker compose up --build -d
```
Stop running application
```
docker compose down
```
---
## Without Docker Compose
### 1. API only
#### - (Without Docker):
Run virtual environment using pipenv
```
cd api
pip install --user pipenv
pipenv shell
pipenv sync
```
Rename .env.template to .env and enter your credentials
Run the following commands
(You might have to restart the virtual environment to load the env variables)
```
python manage.py collectstatic
python manage.py migrate
```
Run the server at http://127.0.0.1:8000 or http://localhost:8000
```
python manage.py runserver 0.0.0.0:8000
```
#### - (With Docker):
Create Image
```
cd api
docker build -t whatanimal-api .
```
Create and run container
```
docker run --env-file .env -p 8000:8000 whatanimal-api
```
---
### 2. Client only
#### - (Without Docker):
Install dependencies
```
cd client
npm ci
```
Run client
```
npm run dev
```
#### - (With Docker):
Create Image
```
cd api
docker build -t whatanimal-api .
```
Create and run container
```
docker run --env-file .env -p 8000:8000 whatanimal-api
```
---
# LICENSE
MIT License
Copyright (c) 2023 WHATANIMAL
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
---
Original Creator - [Purav Parab](https://github.com/puravparab)