Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

First, we have already decided we are going to change the ‘detect’ function of the FaceDetectionComponent. So secondlynext, we create a ‘custom_components’ folder in our repo if we do not have one already, and within that add a ‘custom_{COMPONENT}’ script:

...

Info

There also needs to be an ‘__init__.py’ script within the custom_components folder. This script should be empty, but it needs to be there for Python to recognize this folder as a module.

...

Now run ‘pip install -e .’ within your SIC repository. This will create a link in your environment to the custom_components folder so that you can easily import your custom components within your other scripts.

Writing the new component (steps 3, 4, and 5)

...

The work on the new custom component is done. Now, you must change the scripts that you want to use the new component. Here the demo_desktop_camera_facedetection.py is used as an example.

First, make sure the script is able to find your new component. Here is one way of doing so:

Code Block
import sys
from pathlib import Path
# Get the absolute path to the custom_components folder
custom_components_path = Path(__file__).resolve().parent.parent.parent / "custom_components"
sys.path.append(str(custom_components_path))

Next, import the new connector rather than the old one

import the new connector rather than the old one

Info

Make sure you ran ‘pip install -e .’ within the directory so that the ‘custom_components’ folder is linked to your environment’s packages.

Code Block
### from sic_framework.services.face_detection.face_detection import FaceDetection
from custom_components.custom_face_detection import CustomFaceDetection

...