Class swarmauri_standard.evaluator_results.EvalResult.EvalResult

swarmauri_standard.evaluator_results.EvalResult.EvalResult

EvalResult(score, metadata, program)

Bases: EvalResultBase

Concrete implementation of EvalResultBase.

This class holds a program reference, scalar score, and metadata. It provides a fully implemented evaluation result object.

Attributes

type : Literal["EvalResult"] Type identifier for this component _score : float The numerical evaluation score _metadata : Dict[str, Any] Dictionary containing metadata about the evaluation _program : IProgram The program that was evaluated _metadata_schema : ClassVar[Dict[str, Any]] Schema for validating metadata structure

Initialize a new evaluation result with score, metadata, and program.

Parameters

score : float The numerical evaluation score metadata : Dict[str, Any] Dictionary containing metadata about the evaluation program : IProgram The program that was evaluated

Raises

TypeError If score is not a float or if metadata keys are not strings ValueError If program is None

Source code in swarmauri_standard/evaluator_results/EvalResult.py

def __init__(self, score: float, metadata: Dict[str, Any], program: IProgram):
    """
    Initialize a new evaluation result with score, metadata, and program.

    Parameters
    ----------
    score : float
        The numerical evaluation score
    metadata : Dict[str, Any]
        Dictionary containing metadata about the evaluation
    program : IProgram
        The program that was evaluated

    Raises
    ------
    TypeError
        If score is not a float or if metadata keys are not strings
    ValueError
        If program is None
    """
    # Validate score is a real number
    if not isinstance(score, (int, float)):
        logger.error(f"Score must be a number, got {type(score)}")
        raise TypeError(f"Score must be a number, got {type(score)}")

    # Validate program is not None
    if program is None:
        logger.error("Program cannot be None")
        raise ValueError("Program cannot be None")

    # Validate metadata keys are strings
    if not all(isinstance(key, str) for key in metadata.keys()):
        logger.error("All metadata keys must be strings")
        raise TypeError("All metadata keys must be strings")

    super().__init__(score, metadata, program)
    logger.debug(f"Created EvalResult with score {score} for program {program}")

type class-attribute instance-attribute

type = 'EvalResult'

model_config class-attribute instance-attribute

model_config = ConfigDict(
    extra="allow", arbitrary_types_allowed=True
)

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

default_logger class-attribute

default_logger = None

logger class-attribute instance-attribute

logger = None

name class-attribute instance-attribute

name = None

resource class-attribute instance-attribute

resource = EVALUATOR_RESULT.value

version class-attribute instance-attribute

version = '0.1.0'

score property

score

Get the evaluation score.

Returns

float The numerical score of the evaluation.

metadata property

metadata

Get additional metadata about the evaluation.

Returns

Dict[str, Any] Dictionary containing metadata about the evaluation.

program property

program

Get the program associated with this evaluation result.

Returns

IProgram The program that was evaluated.

update_metadata

update_metadata(new_metadata)

Update the evaluation result metadata with new values.

Parameters

new_metadata : Dict[str, Any] New metadata to add or update

Raises

TypeError If new metadata keys are not strings

Source code in swarmauri_standard/evaluator_results/EvalResult.py

def update_metadata(self, new_metadata: Dict[str, Any]) -> None:
    """
    Update the evaluation result metadata with new values.

    Parameters
    ----------
    new_metadata : Dict[str, Any]
        New metadata to add or update

    Raises
    ------
    TypeError
        If new metadata keys are not strings
    """
    # Validate new metadata keys
    if not all(isinstance(key, str) for key in new_metadata.keys()):
        logger.error("All metadata keys must be strings")
        raise TypeError("All metadata keys must be strings")

    # Update metadata
    self._metadata.update(new_metadata)
    logger.debug(f"Updated metadata with {len(new_metadata)} new entries")

compare_to

compare_to(other)

Compare this evaluation result to another based on score.

Parameters

other : EvalResult Another evaluation result to compare with

Returns

int 1 if this result is better, -1 if other is better, 0 if equal

Raises

TypeError If other is not an EvalResult

Source code in swarmauri_standard/evaluator_results/EvalResult.py

def compare_to(self, other: "EvalResult") -> int:
    """
    Compare this evaluation result to another based on score.

    Parameters
    ----------
    other : EvalResult
        Another evaluation result to compare with

    Returns
    -------
    int
        1 if this result is better, -1 if other is better, 0 if equal

    Raises
    ------
    TypeError
        If other is not an EvalResult
    """
    if not isinstance(other, EvalResult):
        logger.error(f"Cannot compare EvalResult with {type(other)}")
        raise TypeError(f"Cannot compare EvalResult with {type(other)}")

    # Higher scores are better
    if self.score > other.score:
        return 1
    elif self.score < other.score:
        return -1
    else:
        return 0

register_model classmethod

register_model()

Decorator to register a base model in the unified registry.

RETURNS	DESCRIPTION
Callable	A decorator function that registers the model class. TYPE: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type classmethod

register_type(resource_type=None, type_name=None)

Decorator to register a subtype under one or more base models in the unified registry.

PARAMETER	DESCRIPTION
resource_type	The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. TYPE: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_toml

model_dump_toml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a TOML representation of the model.

Source code in swarmauri_base/TomlMixin.py

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a YAML representation of the model.

Source code in swarmauri_base/YamlMixin.py

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger