pyvisim 0.1.0__py3-none-any.whl

pyvisim/__init__.py

@@ -0,0 +1,5 @@
+"""
+PyVisim: A Python library for image similarity analysis using Image Encoders and Neural Networks.
+"""
+
+__all__ = ['datasets', 'encoders', 'features', 'eval']

pyvisim/_base_classes.py

@@ -0,0 +1,51 @@
+import abc
+import logging
+
+import numpy as np
+
+class SimilarityMetric(abc.ABC):
+    """
+    Abstract base for all similarity encoders.
+
+    All concrete similarity metric classes must inherit from this class.
+    """
+    _logger = logging.getLogger('Similarity_Metrics')
+    @abc.abstractmethod
+    def similarity_score(self, image1: np.ndarray, image2: np.ndarray) -> float:
+        """
+        Compute a similarity score between two images.
+
+        :param image1: First image
+        :param image2: Second image
+        :return: A similarity score
+        """
+        pass
+
+class FeatureExtractorBase(abc.ABC):
+    """
+    Abstract interface for extracting features from images.
+
+    A feature extractor transforms an image (NumPy array) into a
+    set of feature vectors (NumPy array).
+    """
+    _logger = logging.getLogger("Feature_Extractor")
+    def __init__(self):
+        pass
+
+    @abc.abstractmethod
+    def __call__(self, image: np.ndarray) -> np.ndarray:
+        """
+        Extracts features from an image.
+
+        :param image: Input image (NumPy array).
+        :return: Feature descriptors (NumPy array).
+        """
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def output_dim(self) -> int:
+        """
+        The dimensionality (D) of each feature vector, i.e., shape[1] of the output.
+        """
+        raise NotImplementedError

pyvisim/_config.py

@@ -0,0 +1,56 @@
+import logging
+import logging.config
+import pathlib
+
+import yaml
+import torch
+
+# -Config for the dataset- #
+ROOT = pathlib.Path(__file__).parent.parent
+LOG_FILE_PATH = ROOT / "res/logs/log_msgs.log"
+
+# - Device - #
+ENFORCE_CUDA = True
+
+def get_device():
+    """Get device (if available)"""
+    global ENFORCE_CUDA
+    if ENFORCE_CUDA:
+        if not torch.cuda.is_available():
+            raise RuntimeError("CUDA is not available. Please check your computer's configuration.")
+        return torch.device("cuda")
+    return torch.device("cuda" if torch.cuda.is_available() else "cpu")
+
+DEVICE = get_device()
+print(f"Device used: {DEVICE}")
+
+# -Paths for the Excavator dataset- #
+TRAIN_IMG_DATA_PATH_EXCAVATOR= rf"{ROOT}/excavator_dataset_w_masks/train"
+TRAIN_MASK_DATA_PATH_EXCAVATOR = rf"{ROOT}/excavator_dataset_w_masks/train_annot"
+TEST_IMG_DATA_PATH_EXCAVATOR = rf"{ROOT}/excavator_dataset_w_masks/test"
+TEST_MASK_DATA_PATH_EXCAVATOR = rf"{ROOT}/excavator_dataset_w_masks/test_annot"
+VALID_IMG_DATA_PATH_EXCAVATOR = None
+VALID_MASK_DATA_PATH_EXCAVATOR = None
+
+# -Paths for the Flower dataset- #
+IMG_DATA_PATH_FLOWER = rf"{ROOT}/oxford_flower_dataset/images"
+LABELS_PATH_FLOWER = rf"{ROOT}/oxford_flower_dataset/imagelabels.mat"
+SETID_PATH_FLOWER = rf"{ROOT}/oxford_flower_dataset/setid.mat"
+
+
+# - Logging - #
+def setup_logging(default_path=rf"{ROOT}/res/logging_config.yaml", default_level=logging.INFO):
+    """Setup logging configuration"""
+    try:
+        with open(default_path, 'rt') as f:
+            config = yaml.safe_load(f.read())
+        try:
+            config["handlers"]["file_handler"]["filename"] = str(LOG_FILE_PATH)
+        except Exception as e:
+            print(f"Error in Logging Configuration: {e}. Cannot set output path for log file.")
+        logging.config.dictConfig(config)
+    except Exception as e:
+        print(f"Error in Logging Configuration: {e}")
+        logging.basicConfig(level=default_level, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+

pyvisim/_errors.py

@@ -0,0 +1,10 @@
+"""
+Includes exceptions for the package.
+"""
+
+class InvalidImageError(Exception):
+    """
+    Raised when an image is not provided.
+    """
+    def __init__(self, message: str = "Input is not a valid image."):
+        super().__init__(message)