CatDogVision / README.md
Whtery1087's picture
Update README.md
4704540
---
license: mit
language:
- en
pipeline_tag: image-classification
---
![CatDogVision](https://i.imgur.com/tFclZGq.png)
# Cat Dog Vision
CatDogVision is a project focused on recognizing images of dogs and cats using a neural network. This project was created for fun and educational purposes.
The goal of this project is to develop a deep learning model that can classify images as either "dog" or "cat" with high accuracy. It serves as a great opportunity to learn about neural networks and image classification.
> **Note:** For relatively good results, it is recommended to train the model for around 100 epochs.
## πŸ”¨ Requirements
- Python **3.11** or lower (⚠️ Maximum)
- Required Python libraries: Numpy, Tensorflow
## 😊 Getting Started
1. Clone this repository to your local machine.
2. Ensure you have **Python 3.11** or lower installed.
3. Install the necessary dependencies by running the following command:
- `pip install -r requirements.txt` - Install all required libraries.
- `python train.py` - Train your model.
- `python test.py` - Test your model.
4. You can now start working with the project.
## πŸ’‘ Usage
1. Make sure to have your dataset of dog and cat images in the "data/train" directory.
2. Customize the neural network model in the `train.py` file to suit your needs.
3. Train the model by running:
4. Once the model is trained, you can use it for image classification.
## ⭐ Contributing
Any suggestions for changes are welcome, if you would like to know what else we would like to do in this project here is a link to the [todo list.](https://github.com/Whtery1087/CatDogVision/blob/main/TODO.md)
## πŸ“œ Credits
This project is made possible with the help of the following libraries:
- Numpy: [https://numpy.org/](https://numpy.org/)
- Tensorflow: [https://www.tensorflow.org/](https://www.tensorflow.org/)
Feel free to explore and expand upon this project for your own learning and enjoyment!