contango.trading.analysis.data.graphing_experiment

contango.trading.analysis.data.graphing_experiment

GraphingExperiment

Bases: NamedTuple

A single experiment when graphing.

Attributes:

Name	Type	Description
name	str	The name for the experiment.
metrics	Metrics	The metrics for the experiment.
parameters	Mapping[str, Any]	A dict mapping strings to the parameters for the experiment.

__repr__

__repr__() -> str

Returns a string representation of the experiment.

Source code in src\contango\trading\analysis\data\graphing_experiment.py

def __repr__(self) -> str:
    """
    Returns a string representation of the experiment.
    """
    return (
        f"Name: {self.name}\n"
        f"Parameters: {dict(self.parameters)}\n"
        f"Metrics: \n{self.metrics}\n"
    )

from_experiment_result classmethod

from_experiment_result(result: ExperimentResult) -> GraphingExperiment

Returns a GraphingExperiment from an ExperimentResult.

Source code in src\contango\trading\analysis\data\graphing_experiment.py

@classmethod
def from_experiment_result(cls, result: ExperimentResult) -> GraphingExperiment:
    """
    Returns a `GraphingExperiment` from an `ExperimentResult`.
    """
    return GraphingExperiment(result.label, result.metrics, result.kwargs)

from_experiment_results classmethod

from_experiment_results(results: list[ExperimentResult]) -> list[GraphingExperiment]

Returns a list of GraphingExperiment instances from a list of ExperimentResult instances.

Source code in src\contango\trading\analysis\data\graphing_experiment.py

@classmethod
def from_experiment_results(cls, results: list[ExperimentResult]) -> list[GraphingExperiment]:
    """
    Returns a list of `GraphingExperiment` instances from a list of `ExperimentResult` instances.
    """
    return [cls.from_experiment_result(result) for result in results]