Adding Type Hints for Enhanced Code Clarity and Maintenance

[RazaProdigy]

Objective:
This pull request introduces type hints to the existing codebase for deepface.py. The addition of type hints aims to enhance code clarity, facilitate maintenance, and improve the development experience for contributors and users of the repository.

Key Changes:

• Added type hints to function parameters and return types across various modules.
• Ensured compatibility with existing code by performing thorough checks and adhering to the current logic and structure.
• Enhanced readability and understandability of the code, especially in complex functions.

No Breaking Changes: These additions are non-intrusive and backward compatible. They do not alter the logic or functionality of the existing code.

Request for Review:
I request the maintainers to review these changes. Feedback and suggestions for further refinement are highly appreciated.

[serengil]

all image path variables (img_path, img1_path, img2_path) can be string or numpy array. So, these should accept numpy array as

from typing import Union
import numpy as np

def verify(img1_path: Union[str, np.ndarray]):
   pass

[serengil]

build_model returns one of these objects:

• keras.engine.functional.Functional
• deepface.basemodels.DlibResNet.DlibResNet
• deepface.basemodels.SFace.SFaceModel

So, this should be typed as

from typing import Union
from keras.engine.functional import Functional
from deepface.basemodels import DlibResNet, SFace

def build_model(model_name: str) -> Union[Functional, DlibResNet.DlibResNet, SFace.SFaceModel]:
    pass

We should then get rid of Any import in this module.

[serengil]

Or you may consider to use Functional and any. Because except 2 models, this function returns Functional.

Union[Functional, Any]

[RazaProdigy]

I've updated the type hints in the image paths and build_model function as per your suggestions. The new commit is pushed to this PR. Could you please take another look when you have a chance?

Thank you!

[serengil]

Double comma at the end of the line breaks the code