|
| 1 | +# ML-Based-Dog-Breed-Identifier |
| 2 | +This is a Django Based Web Site To Identify the Breed of which your DOG belogs All You Need To Do is to Follow These Steps |
| 3 | + |
| 4 | +## Home Page |
| 5 | +<img src="https://github.com/Knighthawk-Leo/ML-Based-Dog-Breed-Identifier/blob/main/Images/home.png"> |
| 6 | + |
| 7 | +## Result Page |
| 8 | +<img src="https://github.com/Knighthawk-Leo/ML-Based-Dog-Breed-Identifier/blob/main/Images/Result.png"> |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +## Setup Discription |
| 13 | +### you need to install following libraries to run this python program in cmd |
| 14 | +``` |
| 15 | +
|
| 16 | +pip install tensorflow |
| 17 | +pip install keras |
| 18 | +pip install django |
| 19 | +pip install numpy |
| 20 | +
|
| 21 | +``` |
| 22 | +## 🚀 Quick Start : |
| 23 | + |
| 24 | +#### Step 1: Forking the repository : |
| 25 | + |
| 26 | +To work on this project, you will first need to make your copy of the repository. To do this, you should fork the repository and then clone it so that you have a local working copy. |
| 27 | + |
| 28 | +Get your own Fork/Copy of repository by clicking `Fork` button right upper corner.<br><br> |
| 29 | + |
| 30 | +#### Step 2: Clone the Forked Repository |
| 31 | + |
| 32 | +After the repository is forked, you can now clone it so that you have a local working copy of the codebase. |
| 33 | + |
| 34 | +To make your local copy of the repository follow the steps: |
| 35 | +- Open the Command Prompt |
| 36 | +- Type this command: |
| 37 | + |
| 38 | +```bash |
| 39 | +$ git clone https://github.com/<your-github-username>/ML-Based-Dog-Breed-Identifier |
| 40 | +``` |
| 41 | + |
| 42 | + |
| 43 | +#### Step 3: Creating a new branch (IMP) |
| 44 | +This is one of the very important step that you should follow to contribute. A branch helps to manage the workflow, isolate your code and does not creates a mess. To create a new branch: |
| 45 | + |
| 46 | +```bash |
| 47 | +$ git branch <name_of_branch> |
| 48 | +$ git checkout -b <name_of_branch> |
| 49 | +``` |
| 50 | + |
| 51 | +Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) |
| 52 | +```bash |
| 53 | +git pull origin main |
| 54 | +``` |
| 55 | + |
| 56 | +#### Step 4: Setting up Project |
| 57 | + |
| 58 | +##### For Django: |
| 59 | +**1. Create a Virtual Environment** |
| 60 | + |
| 61 | +- *On macOS and Linux:* |
| 62 | + ```bash |
| 63 | + python3 -m venv env |
| 64 | + ``` |
| 65 | +- *Windows* |
| 66 | + ```bash |
| 67 | + py -m venv env |
| 68 | + ```` |
| 69 | + |
| 70 | +**2. Activate the Virtual Environment** |
| 71 | + - *On Windows* |
| 72 | + ```bash |
| 73 | + .\env\Scripts\activate |
| 74 | + ``` |
| 75 | + - *On macOS and Linux:* |
| 76 | + ```bash |
| 77 | + source env/bin/activate |
| 78 | + ``` |
| 79 | + |
| 80 | +**4. Make Migrations** |
| 81 | + |
| 82 | +```bash |
| 83 | + python manage.py makemigrations |
| 84 | + python manage.py migrate |
| 85 | +``` |
| 86 | +**5. Run Server** |
| 87 | + |
| 88 | +```bash |
| 89 | + python manage.py runserver |
| 90 | +``` |
| 91 | + |
| 92 | + |
| 93 | +**5.** Go to ` http://127.0.0.1:8000/` and enjoy the application |
| 94 | + |
| 95 | +## How to Contribute 🤔 |
| 96 | + |
| 97 | +You can contribute by adding new scripts, improving current scripts or documentation. Here are some instructions |
| 98 | +before making a Pull Request: |
| 99 | + |
| 100 | +- Take a look at the Existing Issues or create your own [Issues](https://github.com/Knighthawk-Leo/ML-Based-Dog-Breed-Identifier/issues)! |
| 101 | +- Wait for the Issue to be assigned to you after which you can start working on it. |
| 102 | +- Fork the Repo and create a Branch for any Issue that you are working upon. |
| 103 | +- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it. |
| 104 | + |
| 105 | +### Steps to take to contribute 👣 |
| 106 | + |
| 107 | +- [x] Create an issue for making any changes to code. When the issue is approved you can make changes. |
| 108 | +- [x] Pull latest change from upstream branch before starting the changing of code. |
| 109 | +- [x] Add your file in a properly named directory (lowercase) with a README.md in it.Add requirements.txt if needed. |
| 110 | + |
| 111 | +## Report a Bug 🐛 |
| 112 | + |
| 113 | +- Help us improve scripts. Report bugs [here](https://github.com/Knighthawk-Leo/ML-Based-Dog-Breed-Identifier/issues). <br/> |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | +## |
| 121 | +[](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com) |
1 | 122 |
|
0 commit comments