refactor: add evaluators module with cross-validation and hold-out validation functions; update documentation and tests

Author: janezlapajne

docs/api/optimizers/evaluators.md

@@ -0,0 +1 @@
+::: siapy.optimizers.evaluators

docs/api/utils/evaluators.md

@@ -100,14 +100,14 @@ nav:
           - Metrics: api/models/metrics.md
       - Optimizers:
           - Configs: api/optimizers/configs.md
+          - Evaluators: api/optimizers/evaluators.md
           - Optimizers: api/optimizers/optimizers.md
           - Parameters: api/optimizers/parameters.md
           - Scorers: api/optimizers/scorers.md
       - Transformations:
           - Corregistrator: api/transformations/corregistrator.md
           - Image: api/transformations/image.md
       - Utils:
-          - Evaluators: api/utils/evaluators.md
           - Images: api/utils/images.md
           - Plots: api/utils/plots.md
   - Release Notes: changelog.md

mkdocs.yml

@@ -12,8 +12,7 @@
 from siapy.core import logger
 from siapy.core.exceptions import InvalidInputError
 from siapy.core.types import ArrayLike1dType, ArrayLike2dType
-
-from .validators import check_model_prediction_methods
+from siapy.utils.validators import check_model_prediction_methods
 
 __all__ = [
     "cross_validation",

siapy/utils/evaluators.py siapy/optimizers/evaluators.pysiapy/utils/evaluators.py renamed to siapy/optimizers/evaluators.py

@@ -6,7 +6,7 @@
 from sklearn.base import BaseEstimator
 
 from siapy.core.types import ArrayLike1dType, ArrayLike2dType
-from siapy.utils.evaluators import (
+from siapy.optimizers.evaluators import (
     ScorerFuncType,
     cross_validation,
     hold_out_validation,

siapy/optimizers/scorers.py

@@ -1,4 +1,5 @@
 import sys
+from enum import Enum, auto
 from typing import Any
 
 import matplotlib.pyplot as plt
@@ -13,7 +14,6 @@
 from siapy.core.types import ImageType
 from siapy.datasets.schemas import ClassificationTarget, TabularDatasetData
 from siapy.entities import Pixels
-from siapy.utils.enums import InteractiveButtonsEnum
 from siapy.utils.validators import validate_image_to_numpy_3channels
 
 __all__ = [
@@ -22,6 +22,7 @@
     "display_image_with_areas",
     "display_multiple_images_with_areas",
     "display_signals",
+    "InteractiveButtonsEnum",
 ]
 
 
@@ -151,6 +152,12 @@ def display_image_with_areas(
     plt.show()
 
 
+class InteractiveButtonsEnum(Enum):
+    SAVE = auto()
+    REPEAT = auto()
+    SKIP = auto()
+
+
 def display_multiple_images_with_areas(
     images_with_areas: list[tuple[ImageType, Pixels | list[Pixels]]],
     *,

siapy/utils/enums.py

@@ -7,7 +7,7 @@
 from sklearn.svm import SVC
 
 from siapy.core.exceptions import InvalidInputError
-from siapy.utils.evaluators import (
+from siapy.optimizers.evaluators import (
     cross_validation,
     hold_out_validation,
 )

siapy/utils/plots.py

@@ -5,8 +5,8 @@
     RegressionTarget,
     TabularDatasetData,
 )
-from siapy.utils.enums import InteractiveButtonsEnum
 from siapy.utils.plots import (
+    InteractiveButtonsEnum,
     display_image_with_areas,
     display_multiple_images_with_areas,
     display_signals,