github/deepface
1
1
Fork 0
mirror of https://github.com/serengil/deepface.git synced 2025-06-07 12:05:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated docstrings for fucntions that now accept IO[bytes]

Browse Source
This commit is contained in:
Samuel J. Woodward 2025-01-10 11:21:01 -05:00
parent 39173b748b
commit f3da544812
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
deepface/DeepFace.py
View File

@ -84,11 +84,11 @@ def verify(
""" """
Verify if an image pair represents the same person or different persons. Verify if an image pair represents the same person or different persons.
Args: Args:
img1_path (str or np.ndarray or List[float]): Path to the first image. img1_path (str or np.ndarray or IO[bytes] or List[float]): Path to the first image.
Accepts exact image path as a string, numpy array (BGR), base64 encoded images Accepts exact image path as a string, numpy array (BGR), base64 encoded images
or pre-calculated embeddings. or pre-calculated embeddings.
img2_path (str or np.ndarray or List[float]): Path to the second image. img2_path (str or np.ndarray or IO[bytes] or List[float]): Path to the second image.
Accepts exact image path as a string, numpy array (BGR), base64 encoded images Accepts exact image path as a string, numpy array (BGR), base64 encoded images
or pre-calculated embeddings. or pre-calculated embeddings.
@ -176,7 +176,7 @@ def analyze(
""" """
Analyze facial attributes such as age, gender, emotion, and race in the provided image. Analyze facial attributes such as age, gender, emotion, and race in the provided image.
Args: Args:
img_path (str or np.ndarray): The exact path to the image, a numpy array in BGR format, img_path (str or np.ndarray or IO[bytes]): The exact path to the image, a numpy array in BGR format,
or a base64 encoded image. If the source image contains multiple faces, the result will or a base64 encoded image. If the source image contains multiple faces, the result will
include information for each detected face. include information for each detected face.
@ -281,7 +281,7 @@ def find(
""" """
Identify individuals in a database Identify individuals in a database
Args: Args:
img_path (str or np.ndarray): The exact path to the image, a numpy array in BGR format, img_path (str or np.ndarray or IO[bytes]): The exact path to the image, a numpy array in BGR format,
or a base64 encoded image. If the source image contains multiple faces, the result will or a base64 encoded image. If the source image contains multiple faces, the result will
include information for each detected face. include information for each detected face.
@ -383,7 +383,7 @@ def represent(
Represent facial images as multi-dimensional vector embeddings. Represent facial images as multi-dimensional vector embeddings.
Args: Args:
img_path (str or np.ndarray): The exact path to the image, a numpy array in BGR format, img_path (str or np.ndarray or IO[bytes]): The exact path to the image, a numpy array in BGR format,
or a base64 encoded image. If the source image contains multiple faces, the result will or a base64 encoded image. If the source image contains multiple faces, the result will
include information for each detected face. include information for each detected face.
@ -519,7 +519,7 @@ def extract_faces(
Extract faces from a given image Extract faces from a given image
Args: Args:
img_path (str or np.ndarray): Path to the first image. Accepts exact image path img_path (str or np.ndarray or IO[bytes]): Path to the first image. Accepts exact image path
as a string, numpy array (BGR), or base64 encoded images. as a string, numpy array (BGR), or base64 encoded images.
detector_backend (string): face detector backend. Options: 'opencv', 'retinaface', detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',

2
deepface/modules/detection.py
View File

@ -34,7 +34,7 @@ def extract_faces(
Extract faces from a given image Extract faces from a given image
Args: Args:
img_path (str or np.ndarray): Path to the first image. Accepts exact image path img_path (str or np.ndarray or IO[bytes]): Path to the first image. Accepts exact image path
as a string, numpy array (BGR), or base64 encoded images. as a string, numpy array (BGR), or base64 encoded images.
detector_backend (string): face detector backend. Options: 'opencv', 'retinaface', detector_backend (string): face detector backend. Options: 'opencv', 'retinaface',