xwhy.core.explainer

Base class for all xwhy explainers.

BaseExplainer

Bases: ABC

Abstract base class for all xwhy explainers.

This class provides the common interface shared by all explainers. Concrete explainers are responsible for initializing their own runtime state (models, providers, embeddings, etc.).

Source code in src/xwhy/core/explainer.py

class BaseExplainer(ABC):
    """Abstract base class for all xwhy explainers.

    This class provides the common interface shared by all explainers.
    Concrete explainers are responsible for initializing their own runtime
    state (models, providers, embeddings, etc.).
    """

    def __init__(
        self,
        config: ExplainerConfig | None = None,
    ) -> None:
        """Initialize the explainer.

        Args:
            config: Explainer configuration object.

        """
        self.config = config

    @abstractmethod
    def explain(
        self,
        instance: Any,  # noqa: ANN401
        **kwargs: Any,  # noqa: ANN401
    ) -> BaseXWhyResult:
        """Generate an explanation for the given input instance.

        Args:
            instance: Input instance to explain.
            **kwargs: Additional explainer-specific arguments.

        Returns:
            Structured explanation result.

        Raises:
            NotImplementedError:
                If the subclass does not implement this method.

        """
        raise NotImplementedError("Subclasses must implement explain method.")

__init__(config=None)

Initialize the explainer.

Parameters:

Name	Type	Description	Default
config	ExplainerConfig | None	Explainer configuration object.	None

Source code in src/xwhy/core/explainer.py

def __init__(
    self,
    config: ExplainerConfig | None = None,
) -> None:
    """Initialize the explainer.

    Args:
        config: Explainer configuration object.

    """
    self.config = config

explain(instance, **kwargs) abstractmethod

Generate an explanation for the given input instance.

Parameters:

Name	Type	Description	Default
instance	Any	Input instance to explain.	required
**kwargs	Any	Additional explainer-specific arguments.	{}

Returns:

Type	Description
BaseXWhyResult	Structured explanation result.

Raises:

Type	Description
NotImplementedError	If the subclass does not implement this method.

Source code in src/xwhy/core/explainer.py

@abstractmethod
def explain(
    self,
    instance: Any,  # noqa: ANN401
    **kwargs: Any,  # noqa: ANN401
) -> BaseXWhyResult:
    """Generate an explanation for the given input instance.

    Args:
        instance: Input instance to explain.
        **kwargs: Additional explainer-specific arguments.

    Returns:
        Structured explanation result.

    Raises:
        NotImplementedError:
            If the subclass does not implement this method.

    """
    raise NotImplementedError("Subclasses must implement explain method.")