Definition of Demonstrations

Demonstration Files

delphyne.core.demos

Delphyne Demonstrations.

A demonstration file can be directly parsed as a value of type DemoFile. Thus, field names are optimized to make for a pleasant YAML syntax.

DemoFile

DemoFile: list[Demo]

A demonstration file is a sequence of demonstrations. Demonstrations are independent and can thus be separately evaluted.

Demo

Demo: QueryDemo | StrategyDemo

A demonstration is either a standalone query demonstration or a strategy demonstration.

StrategyDemo dataclass

A strategy demonstration.

For a given strategy instance, a strategy demonstration gathers a sequence of relevant query demonstrations, along with a sequence of unit tests that combine them into coherent scenarios of navigating the strategy tree.

Attributes:

Name	Type	Description
strategy	str	The name of the strategy function.
args	dict[str, Any]	Arguments to pass to the strategy function.
tests	list[TestCommandString]	A sequence of unit tests that describe navigation scenarios in the strategy tree.
queries	list[QueryDemo]	A sequence of query demonstrations. Featured answers are used when executing the tests.
demonstration	str | None	An optional label for the demonstration (usually specified first in YAML syntax)

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

@dataclass
class StrategyDemo:
    """
    A strategy demonstration.

    For a given strategy instance, a strategy demonstration gathers a
    sequence of relevant query demonstrations, along with a sequence of
    unit tests that combine them into coherent scenarios of navigating
    the strategy tree.

    Attributes:
        strategy: The name of the strategy function.
        args: Arguments to pass to the strategy function.
        tests: A sequence of unit tests that describe navigation
            scenarios in the strategy tree.
        queries: A sequence of query demonstrations. Featured answers
            are used when executing the tests.
        demonstration: An optional label for the demonstration (usually
            specified first in YAML syntax)
    """

    strategy: str
    args: dict[str, Any]
    tests: list[TestCommandString]
    queries: list[QueryDemo]
    demonstration: str | None = None  # optional label

QueryDemo dataclass

A query demonstration.

A query demonstration describes a query and associates answers to it. It can stand alone in a demonstration file, or be part of a strategy demonstration.

Attributes:

Name	Type	Description
query	str	The query name.
args	dict[str, Any]	The query arguments.
answers	list[Answer]	A sequence of quer answers.
demonstration	str | None	For standalone query demonstrations, an optional demonstration label (usully specified first in YAML syntax).

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

@dataclass
class QueryDemo:
    """
    A query demonstration.

    A query demonstration describes a query and associates answers to
    it. It can stand alone in a demonstration file, or be part of a
    strategy demonstration.

    Attributes:
        query: The query name.
        args: The query arguments.
        answers: A sequence of quer answers.
        demonstration: For standalone query demonstrations, an optional
            demonstration label (usully specified first in YAML syntax).
    """

    query: str
    args: dict[str, Any]
    answers: list[Answer]
    demonstration: str | None = None  # optional label

Answer dataclass

A query answer.

Attributes:

Name	Type	Description
answer	str | object	The answer content, which can be a string or a structured JSON object. When a string is provided, the structured field is used to desambiguate whether or not the content should be interpreted as structured data.
call	Sequence[ToolCall]	A sequence of tool calls. mode: the answer mode (None by default), which determines in particular how the answer must be parsed.
label	str | None	An optional label for the answer, which can be referenced in demonstration tests.
example	bool | None	A boolean value indicating whether the answer should be usable as a few-shot exmple (some answers are only used s negative examples or to describe alternative paths in the strategy tree and thus should not be used as examples).
tags	Sequence[str]	A sequence of example tags that can be used by policies to select appropriate examples.
justification	str | None	An optional justification for the answer (see delphyne.core.refs.Answer).

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

@dataclass
class Answer:
    """
    A query answer.

    Attributes:
        answer: The answer content, which can be a string or a
            structured JSON object. When a string is provided, the
            `structured` field is used to desambiguate whether or not the
            content should be interpreted as structured data.
        call: A sequence of tool calls. mode: the answer mode (`None` by
            default), which determines in particular how the answer must
            be parsed.
        label: An optional label for the answer, which can be referenced
            in demonstration tests.
        example: A boolean value indicating whether the answer should be
            usable as a few-shot exmple (some answers are only used s
            negative examples or to describe alternative paths in the
            strategy tree and thus should not be used as examples).
        tags: A sequence of example tags that can be used by policies to
            select appropriate examples.
        justification: An optional justification for the answer (see
            [`delphyne.core.refs.Answer`][]).
    """

    answer: str | object
    call: Sequence[ToolCall] = ()
    structured: Literal["auto", True] = "auto"
    mode: str | None = None
    label: str | None = None
    example: bool | None = None
    tags: Sequence[str] = ()
    justification: str | None = None

ToolCall dataclass

A tool call, as a part of a query answer.

Attributes:

Name	Type	Description
tool	str	The name of the tool to call.
args	dict[str, Any]	The arguments to pass to the tool.

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

@dataclass
class ToolCall:
    """
    A tool call, as a part of a query answer.

    Attributes:
        tool: The name of the tool to call.
        args: The arguments to pass to the tool.
    """

    tool: str
    args: dict[str, Any]

TestCommandString

TestCommandString: str

A non-parsed test command (TestCommand).

Demonstration Tests

TestCommand

TestCommand: Sequence[TestStep]

A test command is a sequence of test instructions.

It describes a path in the strategy tree, starting from the root and reaching a destination node. A test can succeed, error or be stuck (i.e., reach a node where it cannot make further progress due to a missing answer in the queries section). It can also emit various warnings (i.e., a hint was not used).

TestStep

TestStep: Run | IsSuccess | IsFailure | SelectSpace | Save | Load

A test instruction.

Each instruction updates the current node position in the strategy tree. In addition, instructions can error or get stuck.

Run dataclass

Walk through the tree, using local node navigation functions along with the content of the demonstration's query section to answer queries.

Depending on whether until is provided, this corresponds to either the "run" or "at" instruction in concrete syntax.

Attributed

hints: Whenever a query must be answered, the first answer provided in the query section is used, unless an answer whose label matches the first remaining hint exists, in which case it is used insted and the hint is consumed. This mechanism allows concisely describing alternative paths in the tree that only differ from the default path in a small number of key decisions. until: When provided, the walk stops when the current node matches the provided description (see NodeSelector).

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

@dataclass
class Run:
    """
    Walk through the tree, using local node navigation functions along
    with the content of the demonstration's `query` section to answer
    queries.

    Depending on whether `until` is provided, this corresponds to either
    the "run" or "at" instruction in concrete syntax.

    Attributed:
        hints: Whenever a query must be answered, the first answer
            provided in the `query` section is used, unless an answer
            whose label matches the first remaining hint exists, in
            which case it is used insted and the hint is consumed. This
            mechanism allows concisely describing alternative paths in
            the tree that only differ from the default path in a small
            number of key decisions.
        until: When provided, the walk stops when the current node
            matches the provided description (see `NodeSelector`).
    """

    hints: Sequence[Hint]
    until: NodeSelector | None

IsSuccess dataclass

Do not move but fail if the current node is not a success leaf.

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

@dataclass
class IsSuccess:
    """
    Do not move but fail if the current node is *not* a success leaf.
    """

    pass

IsFailure dataclass

Do not move but fail if the current node is not a failure node (i.e., a leaf node that is not a success leaf).

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

@dataclass
class IsFailure:
    """
    Do not move but fail if the current node is *not* a failure node
    (i.e., a leaf node that is not a success leaf).
    """

    pass

SelectSpace dataclass

Select a particular local space of the current node, using a hint-based reference.

Depending on the value of expects_query, this corresponds to either the "go" or the "answer" instruction in concrete syntax.

Attributes:

Name	Type	Description
space	SpaceRef	Local, hint-based reference for the space to select.
expects_query	bool	Whether the space is expected to be induced by a query. When true, the current node position is left unchanged and the instruction fails if the selected space is not induced by a query or if this query is not answered. When set to false, the current node position is updated to the root of the tree inducing the selected space (the instruction fails if this space is induced by a query).

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

@dataclass
class SelectSpace:
    """
    Select a particular local space of the current node, using a
    hint-based reference.

    Depending on the value of `expects_query`, this corresponds to
    either the "go" or the "answer" instruction in concrete syntax.

    Attributes:
        space: Local, hint-based reference for the space to select.
        expects_query: Whether the space is expected to be induced by a
            query. When true, the current node position is left
            unchanged and the instruction fails if the selected space is
            not induced by a query or if this query is not answered.
            When set to false, the current node position is updated to
            the root of the tree inducing the selected space (the
            instruction fails if this space is induced by a query).
    """

    space: SpaceRef
    expects_query: bool

Save dataclass

Save the current node under a given name.

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

@dataclass
class Save:
    """
    Save the current node under a given name.
    """

    name: str

Load dataclass

Go to a tree node that was previously saved under a given name.

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

@dataclass
class Load:
    """
    Go to a tree node that was previously saved under a given name.
    """

    name: str

Node and Space Selectors

NodeSelector

NodeSelector: TagSelectors | WithinSpace

Describes a node as a path of tags from the current tree.

A node selector either denotes a node that matches a series of tags in the surrounding tree (TagSelectors), or a node within nested tree, which induces a space that is itself described by a series of tags (WithinSpace).

TagSelectors

TagSelectors: Sequence[TagSelector]

A series of tag selectors that must all be matched.

Tag selectors apply to either nodes or spaces.

TagSelector dataclass

A tag selector consists in a tag along with an optional occurence number.

Attributes:

Name	Type	Description
tag	str	The tag to match.
num	int | None	An optional occurence number. When equal to integer n, the selector does not match the first occurence of the tag (along the walked path) but the n-th occurence instead.

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

@dataclass(frozen=True)
class TagSelector:
    """
    A tag selector consists in a tag along with an optional occurence
    number.

    Attributes:
        tag: The tag to match.
        num: An optional occurence number. When equal to integer `n`,
            the selector does not match the first occurence of the tag
            (along the walked path) but the `n`-th occurence instead.
    """

    tag: str
    num: int | None

WithinSpace dataclass

A node selector that matches a node within a particular space of the surrounding tree.

Attributes:

Name	Type	Description
space	TagSelectors	A conjunction of tags describing a space in the surrounding tree.
selector	NodeSelector	A node selector, relative to the tree that induces the aforementioned space.

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

@dataclass
class WithinSpace:
    """
    A node selector that matches a node within a particular space of the
    surrounding tree.

    Attributes:
        space: A conjunction of tags describing a space in the
            surrounding tree.
        selector: A node selector, relative to the tree that induces the
            aforementioned space.
    """

    space: TagSelectors
    selector: NodeSelector