https://github.com/kaungkhantkyaw1997/face_recognition

https://github.com/kaungkhantkyaw1997/face_recognition

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kaungkhantkyaw1997/face_recognition
• Owner: KaungKhantKyaw1997
• Created: 2024-05-24T05:36:31.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-05T18:53:01.000Z (3 months ago)
• Last Synced: 2024-08-05T22:01:03.121Z (3 months ago)
• Language: Python
• Size: 1.52 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Face Recognition

Implemented for identifying characters in images, falling under Computer Vision.

## Requirements

1. Ensure you have Python version 3.11.0 installed.

2. (Optional) Consider using `pyenv` for managing Python versions.

3. Ensure you have `pip` for installing dependencies.

## Setup Instructions

1. **Clone the repository to your local machine:**

   ```sh

   git clone https://github.com/KaungKhantKyaw1997/face_recognition.git

   ```

2. **Navigate to the project directory:**

   ```sh

   cd face_recognition

   ```

3. **Create a virtual environment:**

   ```sh

   python -m venv .venv

   ```

4. **Activate the virtual environment:**

   - On macOS and Linux:

     ```sh

     source .venv/bin/activate

     ```

   - On Windows:

     ```sh

     ".\\.venv\\Scripts\\activate"

     ```

5. **Install required libraries:**

   ```sh

   pip install -r requirements.txt

   ```

6. **Run the script:**

   ```sh

   python main.py

   ```

## Additional Notes

- It’s recommended to use a virtual environment to avoid conflicts with system-wide packages.

- Ensure your Python version (3.11.0) is compatible with the packages used in this project.

## API Example

To process an image, follow these steps:

1. **Send a POST request to the following endpoint:**

   ```sh

   POST http://127.0.0.1:5001/process_image

   ```

2. **Request Body Example:**

   ```json

   {

     "unknown_faces_dir": "/path/to/unknown_faces",

     "known_faces_dir": "/path/to/known_faces"

   }

   ```