Policy Types

AbstractPolicy

Bases: Generic[E, N, P], ABC

A policy maps a tree with a given signature (contravariant parameter N) and inner policy type (covariant parameter P) to a search stream.

Note

We use an abstract class instead of a protocol to allow isinstance checks when loading policies dynamically.

Source code in src/delphyne/core/policies.py

class AbstractPolicy(Generic[E, N, P], ABC):
    """
    A policy maps a tree with a given signature (contravariant parameter
    N) and inner policy type (covariant parameter P) to a search stream.

    !!! note
        We use an abstract class instead of a protocol to allow
        `isinstance` checks when loading policies dynamically.
    """

    @abstractmethod
    def __call__[T](self, tree: "Tree[N, P, T]", env: E) -> AbstractStream[T]:
        pass

AbstractSearchPolicy

Bases: Generic[E, N], ABC

A search policy takes as arguments a tree with a given signature (covariant type parameter N), a global policy environment, and an inner policy with appropriate type, and returns a search stream.

Source code in src/delphyne/core/policies.py

class AbstractSearchPolicy(Generic[E, N], ABC):
    """
    A search policy takes as arguments a tree with a given signature
    (covariant type parameter `N`), a global policy environment, and an
    inner policy with appropriate type, and returns a search stream.
    """

    @abstractmethod
    def __call__[P, T](
        self, tree: "Tree[N, P, T]", env: E, policy: P
    ) -> AbstractStream[T]:
        pass

AbstractPromptingPolicy

Bases: Generic[E], ABC

A prompting policy takes as arguments a query (attached to a specific node) and a global policy environment, and returns a search stream.

Source code in src/delphyne/core/policies.py

class AbstractPromptingPolicy(Generic[E], ABC):
    """
    A prompting policy takes as arguments a query (attached to a
    specific node) and a global policy environment, and returns a search
    stream.
    """

    @abstractmethod
    def __call__[T](
        self, query: AttachedQuery[T], env: E
    ) -> AbstractStream[T]:
        pass