Raja4321123 commited on
Commit
be72b00
·
1 Parent(s): 109be61

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -110
README.md CHANGED
@@ -1,110 +1,9 @@
1
-
2
- # Anidex
3
-
4
- Welcome to the Anidex repository, which is a real life pokedex for knowing about animals on the spot with scanning or clicking the picture of the animal.
5
- Then the app will respond which possible animal is it with few basic details in both text in screen and as voice message like any voice assistant <be>
6
-
7
- You need to setup the API keys for ANIMAL_API_TOKEN from the [free live animal api](https://api-ninjas.com/api/animals) you can use it for free and HUGGINGFACEHUB_APT_TOKEN from [HUGGINGFACEHUB](https://huggingface.co/)
8
-
9
- ## Table of Contents
10
-
11
- - [Anidex](#anidex)
12
- - [Table of Contents](#table-of-contents)
13
- - [Installation and Dependencies](#installation-and-dependencies)
14
- - [Working with the code](#working-with-the-code)
15
- - [Image](#image)
16
- - [Contributing](#contributing)
17
- - [License](#license)
18
-
19
-
20
- ## Installation and Dependencies
21
-
22
- These are some required packages for our program which are mentioned in the Requirements.txt file
23
-
24
- - flask
25
- - fastapi
26
- - python-multipart
27
- - pillow
28
- - tensorflow-serving-api
29
- - matplotlib
30
- - numpy
31
- - requests
32
- - python-dotenv
33
- - langchain
34
- - speechRecognition
35
- - pyttsx3
36
- - tensorflow
37
- - uvicorn
38
- - typing-inspect
39
- - typing_extensions
40
-
41
-
42
-
43
-
44
-
45
- ## Working with the code
46
-
47
-
48
- I have commented most of the neccesary information in the respective files.
49
-
50
- To run this project locally, please follow these steps:-
51
-
52
- 1. Clone the repository:
53
-
54
- ```shell
55
- git clone https://github.com/Rajarshi12321/Anidex
56
- ```
57
-
58
-
59
- 2. Activating the env
60
-
61
- ```shell
62
- conda activate <your-env-name>
63
- ```
64
-
65
- 3. Install the required dependencies by running:
66
- ```shell
67
- pip install -r requirements.txt
68
- ```
69
- Ensure you have Python installed on your system (Python 3.9 or higher is recommended).<br />
70
- Once the dependencies are installed, you're ready to use the project.
71
-
72
-
73
-
74
- 4. Run the Flask app: Execute the following code in your terminal.
75
- ```shell
76
- python app.py
77
- ```
78
-
79
-
80
- 5. Access the app: Open your web browser and navigate to http://localhost:5000/ to use the Anidex app for uploading image file.
81
-
82
-
83
- ## Image
84
-
85
- Home Page:
86
- ![image](https://github.com/Rajarshi12321/Anidex/assets/94736350/a011627b-70aa-4daa-a8ab-e8c8e76bb588)
87
-
88
- Prediction Result Page:
89
- ![image](https://github.com/Rajarshi12321/Anidex/assets/94736350/7d02e7d1-fe51-4a8c-9f33-5d46ad2eb6ff)
90
-
91
-
92
-
93
- ## Contributing
94
- I welcome contributions to improve the functionality and performance of the app. If you'd like to contribute, please follow these guidelines:
95
-
96
- 1. Fork the repository and create a new branch for your feature or bug fix.
97
-
98
- 2. Make your changes and ensure that the code is well-documented.
99
-
100
- 3. Test your changes thoroughly to maintain app reliability.
101
-
102
- 4. Create a pull request, detailing the purpose and changes made in your contribution.
103
-
104
-
105
-
106
- ## License
107
- This project is licensed under the MIT License. Feel free to modify and distribute it as per the terms of the license.
108
-
109
- I hope this README provides you with the necessary information to get started with the Anidex project.
110
-
 
1
+ ---
2
+ title: Anidex App
3
+ emoji: 📚
4
+ colorFrom: red
5
+ colorTo: yellow
6
+ sdk: docker
7
+ pinned: false
8
+ license: mit
9
+ ---