Update README.md

This commit is contained in:
Nabil Ould Hamou 2025-01-28 11:50:18 +01:00
parent 6828ac686d
commit 7a402ea834

View File

@ -1,17 +1,34 @@
# Cats and Dogs Classification
---
This project is meant as a way to gradually bring improvements on the bayesian network until it is as good as I can make it. All papers that I use will be featured in the README. There will also be a report on how the project went and what I learned and improved on.
Quick and dirty *Bayesian Network* that classifies pictures of cats and dogs. Works okay *-ish* ...
## Table of Contents
* [Objectives 🎯](#objectives)
* [Running the project 🚀](#running-the-project)
* [Development 🔨](#development)
* [Requirements 📋](#requirements)
* [Citations 📝](#citations)
## Running the project (Using VENV)
## Objectives 🎯
- [ ] Pretrain some models
- [ ] Generate some graphs to visualize the data
- [ ] Make a CLI
## Running the project 🚀
```sh
python -m venv .venv
source .venv/bin/activate
pip install requirements.txt
python train.py
python train.py # If you want to train your own model
python main.py
```
```
## Development 🔨
### Requirements 📋
## Citations 📝