thecodermaniac / FaceApi

FaceApi

Project Description

FaceApi project is a Python server powered by FastAPI, tailored for machine learning tasks encompassing image type identification, face detection, and speech recognition. In its early stages, the project currently excels at identifying objects within images and has plans to expand its capabilities with upcoming features such as face detection and speech recognition. Designed to be a versatile tool for various AI-related tasks, FaceAPI welcomes contributions from the community and aims to evolve into a comprehensive solution for diverse applications.

Table of Contents

• Getting Started
• Prerequisites
• Installation
• Contribution Guides

Getting Started

Start by configuring and launching the project on your local machine after following the Prerequisites !

Prerequisites

Before you begin, ensure you have the following prerequisites installed on your system / local machines.

• Python (Python 3.10.7 preferred)
• Visual Studio (for C++ build tools)
• Knowledge of Machine Learning models and how to use model in the application.
• FastAPI Knowledge

Installation

Follow these steps to get the project up and running:

• Installing depenedencies :

  pip install -r requirements.txt

• Initializing server :

  uvicorn src.app:app --reload

Wanna Contribute to Face Api ?

Thank you for your interest in becoming a contributor. We're thrilled to have you on board! Before diving in, please take a moment to peruse this guide, which will provide you with valuable insights on how to get involved and make meaningful contributions to our project.

To Contribute

1. Fork the repository to your own GitHub account.

2. Clone the forked repository to your local machine:

   git clone https://github.com/<your_github_id>/FaceApi.git

3. Create an issue explaining the new api endpoints to be added or any issue in any previously added api endpoints.

4. Make the necessary changes you want to make in your local repository after making thorough checks.

5. Create a Pull Request [PR] using one of our templates after making a commit from your systems.

6. Before raising PR always attach images of your contribution for recieiving a quick response from us.

Best of Luck 🎉 and be sure to start the repo 🤩

Hacktoberfest 2023 ⭐

This repository is participating in Hacktoberfest 2023 ! So you can make contributions in accordance with Hacktoberfest as well.

References

• FastAPI [Website]
• NumPy [Documentation]