Skip to content

LMCompletionConfig

dendron.configs.lm_completion_config.LMCompletionConfig dataclass

Configuration for CompletionConditionNode that controls Hugging Face model settings and blackboard interactions for completion evaluation.

Parameters:

Name Type Description Default
node_name str

The name of the node that will use this configuration.

 required
completions_key Optional[str]

The blackboard key for reading and writing completions to evaluate. The value should be a list of strings, each representing one completion. Defaults to "completions_in".

 'completions_in'
logprobs_out_key Optional[str]

The blackboard key where the output log probabilities dictionary will be written. Defaults to "probs_out".

 'probs_out'
success_fn_key Optional[str]

The blackboard key for the success predicate function. The predicate should accept a completion string and return a NodeStatus. Defaults to "success_fn".

 'success_fn'
input_key Optional[str]

The blackboard key used to read the input text that the model will process. Defaults to "in".

 'in'
Source code in src/dendron/configs/lm_completion_config.py 
 7
 8
 9
10
11
12
13
14
15
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
@dataclass
class LMCompletionConfig:
    """
    Configuration for CompletionConditionNode that controls Hugging Face model settings
    and blackboard interactions for completion evaluation.

    Args:
        node_name (str):
            The name of the node that will use this configuration.

        completions_key (Optional[str]):
            The blackboard key for reading and writing completions to evaluate.
            The value should be a list of strings, each representing one completion.
            Defaults to "completions_in".

        logprobs_out_key (Optional[str]):
            The blackboard key where the output log probabilities dictionary will be written.
            Defaults to "probs_out".

        success_fn_key (Optional[str]):
            The blackboard key for the success predicate function. The predicate should
            accept a completion string and return a NodeStatus.
            Defaults to "success_fn".

        input_key (Optional[str]):
            The blackboard key used to read the input text that the model will process.
            Defaults to "in".
    """
    _node_name: str
    _completions_key: Optional[str] = field(default="completions_in")
    _logprobs_out_key: Optional[str] = field(default="probs_out")
    _success_fn_key: Optional[str] = field(default="success_fn")
    _input_key: Optional[str] = field(default="in")

    def __init__(
        self,
        node_name: str,
        completions_key: Optional[str] = "completions_in",
        logprobs_out_key: Optional[str] = "probs_out",
        success_fn_key: Optional[str] = "success_fn",
        input_key: Optional[str] = "in",
    ):
        self._node_name = node_name
        self._completions_key = completions_key
        self._logprobs_out_key = logprobs_out_key
        self._success_fn_key = success_fn_key
        self._input_key = input_key

    @property
    def node_name(self):
        return self._node_name

    @property
    def completions_key(self):
        return self._completions_key

    @property
    def logprobs_out_key(self):
        return self._logprobs_out_key

    @property
    def success_fn_key(self):
        return self._success_fn_key

    @property
    def input_key(self):
        return self._input_key

    def to_dict(self) -> dict:
        return {
            "node_name": self.node_name,
            "completions_key": self.completions_key,
            "logprobs_out_key": self.logprobs_out_key,
            "success_fn_key": self.success_fn_key,
            "input_key": self.input_key,
        }

node_name property

completions_key property

logprobs_out_key property

success_fn_key property

input_key property

to_dict()

Source code in src/dendron/configs/lm_completion_config.py 
75
76
77
78
79
80
81
82
def to_dict(self) -> dict:
    return {
        "node_name": self.node_name,
        "completions_key": self.completions_key,
        "logprobs_out_key": self.logprobs_out_key,
        "success_fn_key": self.success_fn_key,
        "input_key": self.input_key,
    }