Create Readme
Browse files
Readme
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
To create a README file for your Streamlit application, you can provide a brief overview of the application, its features, and how to run it. Here's an example README file for your application:
|
| 2 |
+
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
# Insta's EYE - Face Recognition and Person Management
|
| 6 |
+
|
| 7 |
+
Insta's EYE is a Streamlit application that allows users to manage a database of people along with their Instagram handles and perform face recognition on uploaded images. The application integrates with Firebase for authentication and database management.
|
| 8 |
+
|
| 9 |
+
## Features
|
| 10 |
+
|
| 11 |
+
- **User Authentication:** Users can sign up and log in to manage their set of images and profiles.
|
| 12 |
+
- **Add Person:** Users can add a person to the database along with their name, image, and Instagram handle.
|
| 13 |
+
- **Recognize Face:** Users can upload an image and the application will recognize the person in the image, if present in the database.
|
| 14 |
+
- **Recognize Face (Optimal):** Users can upload an image and the application will find the best match in the database based on the similarity of facial features.
|
| 15 |
+
- **Delete Person:** Users can delete a person from the database.
|
| 16 |
+
|
| 17 |
+
## Getting Started
|
| 18 |
+
|
| 19 |
+
1. Clone the repository:
|
| 20 |
+
```sh
|
| 21 |
+
git clone https://github.com/your_username/instas-eye.git
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
2. Install the required dependencies:
|
| 25 |
+
```sh
|
| 26 |
+
pip install -r requirements.txt
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
3. Run the Streamlit application:
|
| 30 |
+
```sh
|
| 31 |
+
streamlit run app.py
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
4. Access the application in your web browser at `http://localhost:8501`.
|
| 35 |
+
|
| 36 |
+
## Dependencies
|
| 37 |
+
|
| 38 |
+
- Streamlit
|
| 39 |
+
- Firebase Admin SDK
|
| 40 |
+
- Face Recognition
|
| 41 |
+
- dlib
|
| 42 |
+
- OpenCV
|
| 43 |
+
- PIL
|
| 44 |
+
|
| 45 |
+
## License
|
| 46 |
+
|
| 47 |
+
This project is licensed under the MIT License - see the `LICENSE` file for details.
|
| 48 |
+
|
| 49 |
+
---
|
| 50 |
+
|
| 51 |
+
You can customize this README file further based on your specific application details and requirements.
|