Skip to content

outlines_core

Backend class for Outlines Core.

OutlinesCoreBackend

Bases: BaseBackend

Backend for Outlines Core.

Source code in outlines/backends/outlines_core.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
class OutlinesCoreBackend(BaseBackend):
    """Backend for Outlines Core."""

    def __init__(self, model: SteerableModel):
        """
        Parameters
        ----------
        model
            The Outlines model of the user.

        """
        self.tokenizer = model.tokenizer
        self.tensor_library_name = model.tensor_library_name

    def get_json_schema_logits_processor(
        self, json_schema: str
    ) -> RegexLogitsProcessor:
        """Create a logits processor from a JSON schema.

        Parameters
        ----------
        json_schema: str
            The JSON schema to create a logits processor from.

        Returns
        -------
        LogitsProcessor
            The logits processor to use to constrain the generation.

        """
        regex = build_regex_from_schema(json_schema)
        return self.get_regex_logits_processor(regex)

    def get_regex_logits_processor(self, regex: str) -> RegexLogitsProcessor:
        """Create a logits processor from a regex.

        Parameters
        ----------
        regex: str
            The regex to create a logits processor from.

        Returns
        -------
        LogitsProcessor
            The logits processor to use to constrain the generation.

        """
        return RegexLogitsProcessor(
            regex,
            self.tokenizer,
            self.tensor_library_name,
        )

    def get_cfg_logits_processor(self, grammar: str) -> CFGLogitsProcessor:
        """Create a logits processor from a context-free grammar.

        Parameters
        ----------
        grammar: str
            The context-free grammar to create a logits processor from. For
            Outlines Core, the grammar must use the Lark format.

        Returns
        -------
        LogitsProcessor
            The logits processor to use to constrain the generation.

        """
        return CFGLogitsProcessor(
            grammar,
            self.tokenizer,
            self.tensor_library_name,
        )

    def get_fsm_logits_processor(self, fsm: FSM) -> GuideLogitsProcessor:
        """Create a logits processor from an interegular FSM.

        Parameters
        ----------
        fsm: interegular.fsm.FSM
            The interegular FSM to create a logits processor from.

        Returns
        -------
        LogitsProcessor
            The logits processor to use to constrain the generation.

        """
        guide = RegexGuide.from_interegular_fsm(fsm, self.tokenizer)
        return GuideLogitsProcessor(
            self.tokenizer,
            guide,
            self.tensor_library_name,
        )

__init__(model)

Parameters:

Name Type Description Default
model SteerableModel

The Outlines model of the user.

 required
Source code in outlines/backends/outlines_core.py 
19
20
21
22
23
24
25
26
27
28
def __init__(self, model: SteerableModel):
    """
    Parameters
    ----------
    model
        The Outlines model of the user.

    """
    self.tokenizer = model.tokenizer
    self.tensor_library_name = model.tensor_library_name

get_cfg_logits_processor(grammar)

Create a logits processor from a context-free grammar.

Parameters:

Name Type Description Default
grammar str

The context-free grammar to create a logits processor from. For Outlines Core, the grammar must use the Lark format.

 required

Returns:

Type Description
LogitsProcessor

The logits processor to use to constrain the generation.
Source code in outlines/backends/outlines_core.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def get_cfg_logits_processor(self, grammar: str) -> CFGLogitsProcessor:
    """Create a logits processor from a context-free grammar.

    Parameters
    ----------
    grammar: str
        The context-free grammar to create a logits processor from. For
        Outlines Core, the grammar must use the Lark format.

    Returns
    -------
    LogitsProcessor
        The logits processor to use to constrain the generation.

    """
    return CFGLogitsProcessor(
        grammar,
        self.tokenizer,
        self.tensor_library_name,
    )

get_fsm_logits_processor(fsm)

Create a logits processor from an interegular FSM.

Parameters:

Name Type Description Default
fsm FSM

The interegular FSM to create a logits processor from.

 required

Returns:

Type Description
LogitsProcessor

The logits processor to use to constrain the generation.
Source code in outlines/backends/outlines_core.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def get_fsm_logits_processor(self, fsm: FSM) -> GuideLogitsProcessor:
    """Create a logits processor from an interegular FSM.

    Parameters
    ----------
    fsm: interegular.fsm.FSM
        The interegular FSM to create a logits processor from.

    Returns
    -------
    LogitsProcessor
        The logits processor to use to constrain the generation.

    """
    guide = RegexGuide.from_interegular_fsm(fsm, self.tokenizer)
    return GuideLogitsProcessor(
        self.tokenizer,
        guide,
        self.tensor_library_name,
    )

get_json_schema_logits_processor(json_schema)

Create a logits processor from a JSON schema.

Parameters:

Name Type Description Default
json_schema str

The JSON schema to create a logits processor from.

 required

Returns:

Type Description
LogitsProcessor

The logits processor to use to constrain the generation.
Source code in outlines/backends/outlines_core.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def get_json_schema_logits_processor(
    self, json_schema: str
) -> RegexLogitsProcessor:
    """Create a logits processor from a JSON schema.

    Parameters
    ----------
    json_schema: str
        The JSON schema to create a logits processor from.

    Returns
    -------
    LogitsProcessor
        The logits processor to use to constrain the generation.

    """
    regex = build_regex_from_schema(json_schema)
    return self.get_regex_logits_processor(regex)

get_regex_logits_processor(regex)

Create a logits processor from a regex.

Parameters:

Name Type Description Default
regex str

The regex to create a logits processor from.

 required

Returns:

Type Description
LogitsProcessor

The logits processor to use to constrain the generation.
Source code in outlines/backends/outlines_core.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def get_regex_logits_processor(self, regex: str) -> RegexLogitsProcessor:
    """Create a logits processor from a regex.

    Parameters
    ----------
    regex: str
        The regex to create a logits processor from.

    Returns
    -------
    LogitsProcessor
        The logits processor to use to constrain the generation.

    """
    return RegexLogitsProcessor(
        regex,
        self.tokenizer,
        self.tensor_library_name,
    )