Method encode_images

imagededup/methods/cnn.py:231–267

Generate CNN encodings for all images in a given directory of images. Test. Args: image_dir: Path to the image directory. recursive: Optional, find images recursively in a nested image directory structure, set to False by default. num_enc_workers: Optiona

(
        self,
        image_dir: Union[PurePath, str],
        recursive: Optional[bool] = False,
        num_enc_workers: int = 0,
    )

        )

    def encode_images(
        self,
        image_dir: Union[PurePath, str],
        recursive: Optional[bool] = False,
        num_enc_workers: int = 0,
    ) -> Dict:
        """Generate CNN encodings for all images in a given directory of images. Test.

        Args:
            image_dir: Path to the image directory.
            recursive: Optional, find images recursively in a nested image directory structure, set to False by default.
            num_enc_workers: Optional, number of cpu cores to use for multiprocessing encoding generation (supported only on linux platform), set to 0 by default. 0 disables multiprocessing.

        Returns:
            dictionary: Contains a mapping of filenames and corresponding numpy array of CNN encodings.
        Example:
            ```
            from imagededup.methods import CNN
            myencoder = CNN()
            encoding_map = myencoder.encode_images(image_dir='path/to/image/directory')
            ```
        """
        if isinstance(image_dir, str):
            image_dir = Path(image_dir)

        if not image_dir.is_dir():
            raise ValueError("Please provide a valid directory path!")

        if num_enc_workers != 0 and sys.platform != "linux":
            num_enc_workers = 0
            self.logger.info(
                f"Setting num_enc_workers to 0, CNN encoding generation parallelization support available on linux platform .."
            )

        return self._get_cnn_features_batch(
            image_dir=image_dir, recursive=recursive, num_workers=num_enc_workers
        )

    @staticmethod
    def _check_threshold_bounds(thresh: float) -> None: