Source code for sail_on_client.agent.ond_agent

"""Abstract interface for an agent that works under OND."""

from sail_on_client.agent.visual_agent import VisualAgent
from typing import Dict
from abc import abstractmethod


class ONDAgent(VisualAgent):
    """Abstract class for OND agent."""

    def get_config(self) -> Dict:
        """Return a default configuration dictionary."""
        return {}

    @abstractmethod
    def novelty_classification(self, ncl_toolset: Dict) -> str:
        """
        Abstract method for novelty classification.

        Args:
            ncl_toolset: Parameters for feature extraction

        Returns:
            Path to results for novelty classification.
        """
        pass

    @abstractmethod
    def novelty_adaptation(self, na_toolset: Dict) -> None:
        """
        Abstract method for novelty adaptation.

        Args:
            na_toolset: Parameters for novelty adaptation

        Returns:
            None
        """
        pass

    @abstractmethod
    def novelty_characterization(self, nc_toolset: Dict) -> str:
        """
        Abstract method for novelty novelty_characterization.

        Args:
            nc_toolset: Parameters for feature extraction

        Returns:
            Path to results for novelty characterization.
        """
        pass