Metadata-Version: 2.1
Name: ovos-face-embeddings-plugin
Version: 0.0.0a2
Summary: A face recognition plugin for OVOS
Home-page: https://github.com/TigreGotico/ovos-face-embeddings-plugin
Author: jarbasai
Author-email: jarbasai@mailfence.com
License: MIT
Description: # FaceEmbeddingsRecognitionPlugin
        
        The `FaceEmbeddingsRecognitionPlugin` is a plugin designed for recognizing and managing face embeddings. 
        
        It uses [face_recognition](https://github.com/ageitgey/face_recognition) to extract face embeddings and integrates with  [ovos-chromadb-embeddings-plugin](https://github.com/TigreGotico/ovos-chromadb-embeddings-plugin) for storing and retrieving voice embeddings. 
        
        ## Features
        
        - **Face Embeddings Extraction**: Converts images into face embeddings using the `face_recognition` library.
        - **Face Data Storage**: Stores and retrieves face embeddings using `ChromaEmbeddingsDB`.
        - **Face Data Management**: Provides methods to add, query, and delete face embeddings associated with user IDs.
        
        **Note:** `face_recognition` also requires `dlib`, which may require additional setup. Please refer to the [face_recognition installation instructions](https://github.com/ageitgey/face_recognition#installation) for detailed steps.
        
        ## Usage
        
        Here is a quick example of how to use the `FaceEmbeddingsRecognitionPlugin`:
        
        ```python
        from ovos_face_embeddings import FaceEmbeddingsRecognitionPlugin
        from ovos_chromadb_embeddings import ChromaEmbeddingsDB
        
        db = ChromaEmbeddingsDB("./face_db")
        f = FaceEmbeddingsRecognitionPlugin(db)
        
        a = "/home/miro/PycharmProjects/ovos-user-id/a1.jpg"
        a2 = "/home/miro/PycharmProjects/ovos-user-id/a2.jpg"
        b = "/home/miro/PycharmProjects/ovos-user-id/b.jpg"
        
        import face_recognition # helper to load from file easily
        e1 = face_recognition.load_image_file(a)
        e2 = face_recognition.load_image_file(a2)
        b = face_recognition.load_image_file(b)
        
        f.add_face("arnold", e1)
        f.add_face("silvester", b)
        print(f.query(e1))
        print(f.query(e2))
        print(f.query(b))
        ```
        
Keywords: OVOS openvoiceos plugin face recognition
Platform: UNKNOWN
Description-Content-Type: text/markdown
