mirror of
https://github.com/serengil/deepface.git
synced 2025-06-07 12:05:22 +00:00
updating docstrings to appease linter
This commit is contained in:
parent
7112766966
commit
86fa2dfa83
@ -176,9 +176,9 @@ 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 or IO[bytes]): 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
|
||||||
or a base64 encoded image. If the source image contains multiple faces, the result will
|
in BGR format, or a base64 encoded image. If the source image contains multiple faces,
|
||||||
include information for each detected face.
|
the result will include information for each detected face.
|
||||||
|
|
||||||
actions (tuple): Attributes to analyze. The default is ('age', 'gender', 'emotion', 'race').
|
actions (tuple): Attributes to analyze. The default is ('age', 'gender', 'emotion', 'race').
|
||||||
You can exclude some of these attributes from the analysis if needed.
|
You can exclude some of these attributes from the analysis if needed.
|
||||||
@ -281,9 +281,9 @@ def find(
|
|||||||
"""
|
"""
|
||||||
Identify individuals in a database
|
Identify individuals in a database
|
||||||
Args:
|
Args:
|
||||||
img_path (str or np.ndarray or IO[bytes]): 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
|
||||||
or a base64 encoded image. If the source image contains multiple faces, the result will
|
in BGR format, or a base64 encoded image. If the source image contains multiple
|
||||||
include information for each detected face.
|
faces, the result will include information for each detected face.
|
||||||
|
|
||||||
db_path (string): Path to the folder containing image files. All detected faces
|
db_path (string): Path to the folder containing image files. All detected faces
|
||||||
in the database will be considered in the decision-making process.
|
in the database will be considered in the decision-making process.
|
||||||
@ -383,9 +383,9 @@ 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 or IO[bytes]): 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
|
||||||
or a base64 encoded image. If the source image contains multiple faces, the result will
|
in BGR format, or a base64 encoded image. If the source image contains multiple faces,
|
||||||
include information for each detected face.
|
the result will include information for each detected face.
|
||||||
|
|
||||||
model_name (str): Model for face recognition. Options: VGG-Face, Facenet, Facenet512,
|
model_name (str): Model for face recognition. Options: VGG-Face, Facenet, Facenet512,
|
||||||
OpenFace, DeepFace, DeepID, Dlib, ArcFace, SFace and GhostFaceNet
|
OpenFace, DeepFace, DeepID, Dlib, ArcFace, SFace and GhostFaceNet
|
||||||
|
Loading…
x
Reference in New Issue
Block a user