ExactMatch reward

ExactMatch

Bases: RewardFunctionWrapper

Computes the exact match between y_true and y_pred.

Example:

program.compile(
    reward=synalinks.rewards.ExactMatch(),
    optimizer=synalinks.optimizers.RandomFewShot(),
)

Parameters:

Name	Type	Description	Default
name	str	Optional. string name of the reward instance.	'exact_match'
in_mask	list	Optional. list of keys to keep to compute the reward.	None
out_mask	list	Optional. list of keys to remove to compute the reward.	None

Source code in synalinks/src/rewards/exact_match.py

@synalinks_export("synalinks.rewards.ExactMatch")
class ExactMatch(RewardFunctionWrapper):
    """Computes the exact match between `y_true` and `y_pred`.

    Example:

    ```python
    program.compile(
        reward=synalinks.rewards.ExactMatch(),
        optimizer=synalinks.optimizers.RandomFewShot(),
    )
    ```

    Args:
        name (str): Optional. string name of the reward instance.
        in_mask (list): Optional. list of keys to keep to compute the reward.
        out_mask (list): Optional. list of keys to remove to compute the reward.
    """

    def __init__(
        self,
        name="exact_match",
        in_mask=None,
        out_mask=None,
    ):
        super().__init__(
            fn=exact_match,
            name=name,
            in_mask=in_mask,
            out_mask=out_mask,
        )

    def get_config(self):
        return {
            "name": self.name,
            "in_mask": self.in_mask,
            "out_mask": self.out_mask,
        }

    @classmethod
    def from_config(cls, config):
        return cls(**config)

exact_match(y_true, y_pred) async

Computes the exact match between y_true and y_pred.

If their values are equal, it returns a reward of 1.0; otherwise, it returns 0.0.

Parameters:

Name	Type	Description	Default
y_true	JsonDataModel	The ground truth JSON data_model.	required
y_pred	JsonDataModel	The predicted JSON data_model.	required

Returns:

Type	Description
float	The reward value, which is 1.0 if the values match exactly, and 0.0 otherwise.

Source code in synalinks/src/rewards/exact_match.py

@synalinks_export("synalinks.rewards.exact_match")
async def exact_match(y_true, y_pred):
    """
    Computes the exact match between `y_true` and `y_pred`.

    If their values are equal, it returns a reward of 1.0; otherwise, it returns 0.0.

    Args:
        y_true (JsonDataModel): The ground truth JSON data_model.
        y_pred (JsonDataModel): The predicted JSON data_model.

    Returns:
        (float): The reward value, which is 1.0 if the values match exactly,
            and 0.0 otherwise.
    """
    reward = 0.0
    if y_pred is not None:
        if y_pred.json() == y_true.json():
            reward = 1.0
    return reward