Remove abc.ABC in favor of ConfigBase pattern - use _is_base_class flag

Co-authored-by: shaahji <96227573+shaahji@users.noreply.github.com>

Author: Copilot

olive/evaluator/accuracy.py

@@ -2,9 +2,7 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 # --------------------------------------------------------------------------
-import inspect
 import logging
-from abc import ABC, abstractmethod
 from inspect import isfunction, signature
 from typing import Any, Callable, ClassVar, Optional, Union
 
@@ -17,9 +15,12 @@
 logger = logging.getLogger(__name__)
 
 
-class AccuracyBase(ABC):
+class AccuracyBase:
+    """Base class for accuracy metrics."""
+
     registry: ClassVar[dict[str, type["AccuracyBase"]]] = {}
     name: Optional[str] = None
+    _is_base_class: bool = True
     metric_cls_map: ClassVar[dict[str, Union[torchmetrics.Metric, Callable]]] = {
         "accuracy_score": torchmetrics.Accuracy,
         "f1_score": torchmetrics.F1Score,
@@ -40,7 +41,10 @@ def __init__(self, config: Union[ConfigBase, dict[str, Any]] = None) -> None:
     def __init_subclass__(cls, **kwargs) -> None:
         """Register the metric."""
         super().__init_subclass__(**kwargs)
-        if inspect.isabstract(cls):
+        # Subclasses should not be considered base classes unless explicitly set
+        if '_is_base_class' not in cls.__dict__:
+            cls._is_base_class = False
+        if cls._is_base_class:
             return
         name = cls.name if cls.name is not None else cls.__name__.lower()
         cls.registry[name] = cls
@@ -78,7 +82,10 @@ def _metric_config_from_torch_metrics(cls):
     @classmethod
     def get_config_class(cls) -> type[ConfigBase]:
         """Get the configuration class."""
-        assert not inspect.isabstract(cls), "Cannot get config class for abstract class"
+        if '_is_base_class' not in cls.__dict__:
+            cls._is_base_class = False
+        if cls._is_base_class:
+            raise TypeError(f"Cannot get config class for base class {cls.__name__}")
         default_config = cls._metric_config_from_torch_metrics()
         return create_config_class(f"{cls.__name__}Config", default_config, ConfigBase, {})
 
@@ -90,9 +97,19 @@ def prepare_tensors(preds, target, dtypes=torch.int):
         target = torch.tensor(target, dtype=dtypes[1]) if not isinstance(target, torch.Tensor) else target.to(dtypes[1])
         return preds, target
 
-    @abstractmethod
     def measure(self, model_output, target):
-        raise NotImplementedError
+        """Measure the metric.
+        
+        Subclasses must implement this method.
+        
+        Args:
+            model_output: Model output
+            target: Target values
+            
+        Returns:
+            Measured metric value
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} must implement measure")
 
 
 class AccuracyScore(AccuracyBase):

olive/evaluator/metric_backend.py

@@ -2,8 +2,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 # --------------------------------------------------------------------------
-import inspect
-from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING, Any, ClassVar, NamedTuple, Optional, Union
 
 from olive.common.config_utils import ConfigBase
@@ -19,9 +17,12 @@ class MetricBackendConfig(ConfigBase):
 
 
 
-class MetricBackend(ABC):
+class MetricBackend:
+    """Base class for metric backends."""
+
     registry: ClassVar[dict[str, type["MetricBackend"]]] = {}
     name: Optional[str] = None
+    _is_base_class: bool = True
 
     def __init__(self, config: Optional[Union[ConfigBase, dict[str, Any]]] = None) -> None:
         config = config or {}
@@ -33,7 +34,10 @@ def __init__(self, config: Optional[Union[ConfigBase, dict[str, Any]]] = None) -
     def __init_subclass__(cls, **kwargs) -> None:
         """Register the metric backend."""
         super().__init_subclass__(**kwargs)
-        if inspect.isabstract(cls):
+        # Subclasses should not be considered base classes unless explicitly set
+        if '_is_base_class' not in cls.__dict__:
+            cls._is_base_class = False
+        if cls._is_base_class:
             return
         name = cls.name if cls.name is not None else cls.__name__.lower()
         cls.registry[name] = cls
@@ -43,12 +47,22 @@ def get_config_class(cls) -> type[ConfigBase]:
         """Get the configuration class."""
         return MetricBackendConfig
 
-    @abstractmethod
     def measure_sub_metric(
         self, model_output: Union[tuple, NamedTuple], targets: Any, sub_metric: "SubMetric"
     ) -> SubMetricResult:
-        # model_output: (preds, logits)
-        raise NotImplementedError
+        """Measure a sub-metric.
+        
+        Subclasses must implement this method.
+        
+        Args:
+            model_output: (preds, logits)
+            targets: Target values
+            sub_metric: Sub-metric to measure
+            
+        Returns:
+            SubMetricResult with the measurement
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} must implement measure_sub_metric")
 
     def measure(self, model_output, targets, metrics: "Metric") -> MetricResult:
         metric_results_dict = {}

olive/resource_path.py

@@ -2,11 +2,9 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 # --------------------------------------------------------------------------
-import inspect
 import logging
 import shutil
 import tempfile
-from abc import ABC, abstractmethod
 from copy import deepcopy
 from pathlib import Path
 from typing import Any, Callable, ClassVar, Optional, Union
@@ -37,9 +35,12 @@ class ResourceType(CaseInsensitiveEnum):
 LOCAL_RESOURCE_TYPES = (ResourceType.LocalFile, ResourceType.LocalFolder)
 
 
-class ResourcePath(ABC):
+class ResourcePath:
+    """Base class for resource paths."""
+
     registry: ClassVar[dict[str, type["ResourcePath"]]] = {}
     name: Optional[ResourceType] = None
+    _is_base_class: bool = True
 
     def __init__(self, config: Union[ConfigBase, dict[str, Any]]) -> None:
         if isinstance(config, dict):
@@ -50,16 +51,21 @@ def __init__(self, config: Union[ConfigBase, dict[str, Any]]) -> None:
     def __init_subclass__(cls, **kwargs) -> None:
         """Register the resource path."""
         super().__init_subclass__(**kwargs)
-        if inspect.isabstract(cls):
+        # Subclasses should not be considered base classes unless explicitly set
+        if '_is_base_class' not in cls.__dict__:
+            cls._is_base_class = False
+        if cls._is_base_class:
             return
         name = cls.name if cls.name is not None else cls.__name__.lower()
         cls.registry[name] = cls
 
     @classmethod
-    @abstractmethod
     def _default_config(cls) -> dict[str, ConfigParam]:
-        """Get the default configuration for the class."""
-        raise NotImplementedError
+        """Get the default configuration for the class.
+        
+        Subclasses must implement this method.
+        """
+        raise NotImplementedError(f"{cls.__name__} must implement _default_config")
 
     @classmethod
     def _validators(cls) -> dict[str, Callable]:
@@ -69,7 +75,10 @@ def _validators(cls) -> dict[str, Callable]:
     @classmethod
     def get_config_class(cls) -> type[ConfigBase]:
         """Get the configuration class."""
-        assert not inspect.isabstract(cls), "Cannot get config class for abstract class"
+        if '_is_base_class' not in cls.__dict__:
+            cls._is_base_class = False
+        if cls._is_base_class:
+            raise TypeError(f"Cannot get config class for base class {cls.__name__}")
         return create_config_class(f"{cls.__name__}Config", cls._default_config(), ConfigBase, cls._validators())
 
     def __repr__(self) -> str:
@@ -79,15 +88,19 @@ def __repr__(self) -> str:
     def type(self) -> Optional[ResourceType]:
         return self.name
 
-    @abstractmethod
     def get_path(self) -> str:
-        """Return the resource path as a string."""
-        raise NotImplementedError
+        """Return the resource path as a string.
+        
+        Subclasses must implement this method.
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} must implement get_path")
 
-    @abstractmethod
     def save_to_dir(self, dir_path: Union[Path, str], name: Optional[str] = None, overwrite: bool = False) -> str:
-        """Save the resource to a directory."""
-        raise NotImplementedError
+        """Save the resource to a directory.
+        
+        Subclasses must implement this method.
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} must implement save_to_dir")
 
     def is_local_resource(self) -> bool:
         """Return True if the resource is a local resource."""

olive/search/samplers/search_sampler.py

@@ -2,8 +2,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 # --------------------------------------------------------------------------
-import inspect
-from abc import ABC, abstractmethod
 from collections import OrderedDict
 from typing import TYPE_CHECKING, Any, ClassVar, Optional, Union
 
@@ -21,11 +19,12 @@ class SearchSamplerConfig(ConfigBase):
     max_samples: int = 0
 
 
-class SearchSampler(ABC):
-    """Abstract base class for searchers."""
+class SearchSampler:
+    """Base class for search samplers."""
 
     registry: ClassVar[dict[str, type["SearchSampler"]]] = {}
     name: Optional[str] = None
+    _is_base_class: bool = True
 
     def __init__(
         self,
@@ -52,7 +51,10 @@ def __init__(
     def __init_subclass__(cls, **kwargs) -> None:
         """Register the search sampler."""
         super().__init_subclass__(**kwargs)
-        if inspect.isabstract(cls):
+        # Subclasses should not be considered base classes unless explicitly set
+        if '_is_base_class' not in cls.__dict__:
+            cls._is_base_class = False
+        if cls._is_base_class:
             return
         name = cls.name if cls.name is not None else cls.__name__.lower()
         cls.registry[name] = cls
@@ -63,10 +65,12 @@ def get_config_class(cls) -> type[ConfigBase]:
         return SearchSamplerConfig
 
     @property
-    @abstractmethod
     def num_samples_suggested(self) -> int:
-        """Returns the number of samples suggested so far."""
-        return 0
+        """Returns the number of samples suggested so far.
+        
+        Subclasses must implement this property.
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} must implement num_samples_suggested")
 
     @property
     def max_samples(self) -> int:
@@ -82,10 +86,12 @@ def should_stop(self) -> bool:
             or ((self.max_samples > 0) and (self.num_samples_suggested >= self.max_samples))
         )
 
-    @abstractmethod
     def suggest(self) -> "SearchPoint":
-        """Suggest a new configuration to try."""
-        return None
+        """Suggest a new configuration to try.
+        
+        Subclasses must implement this method.
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} must implement suggest")
 
     def record_feedback_signal(self, search_point_index: int, signal: "MetricResult", should_prune: bool = False):
         """Report the result of a configuration."""