Skip to content

openscm_calibration.typing#

Types used throughout

Classes:

Name Description
SupportsCostCalculation

Class that supports cost calculations
SupportsModelRun

Class that supports model runs
SupportsNegativeLogLikelihoodCalculation

Class that supports negative log likelihood calculations

SupportsCostCalculation #

Bases: Protocol[DataContainer_contra]

Class that supports cost calculations

Methods:

Name Description
calculate_cost

Calculate cost function
Source code in src/openscm_calibration/typing.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class SupportsCostCalculation(Protocol[DataContainer_contra]):
    """
    Class that supports cost calculations
    """

    def calculate_cost(self, model_results: DataContainer_contra) -> float:
        """
        Calculate cost function

        Parameters
        ----------
        model_results
            Model results for which to calculate the cost

        Returns
        -------
        :
            Cost function value
        """

calculate_cost #

calculate_cost(
    model_results: DataContainer_contra,
) -> float

Calculate cost function

Parameters:

Name Type Description Default
model_results DataContainer_contra

Model results for which to calculate the cost

 required

Returns:

Type Description
float

Cost function value
Source code in src/openscm_calibration/typing.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def calculate_cost(self, model_results: DataContainer_contra) -> float:
    """
    Calculate cost function

    Parameters
    ----------
    model_results
        Model results for which to calculate the cost

    Returns
    -------
    :
        Cost function value
    """

SupportsModelRun #

Bases: Protocol[DataContainer_co]

Class that supports model runs

Methods:

Name Description
run_model

Calculate cost function
Source code in src/openscm_calibration/typing.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class SupportsModelRun(Protocol[DataContainer_co]):
    """
    Class that supports model runs
    """

    def run_model(
        self,
        x: nptype.NDArray[np.number[Any]],
    ) -> DataContainer_co:
        """
        Calculate cost function

        Parameters
        ----------
        x
            Parameter values

        Returns
        -------
        :
            Results of model run
        """

run_model #

run_model(x: NDArray[number[Any]]) -> DataContainer_co

Calculate cost function

Parameters:

Name Type Description Default
x NDArray[number[Any]]

Parameter values

 required

Returns:

Type Description
DataContainer_co

Results of model run
Source code in src/openscm_calibration/typing.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def run_model(
    self,
    x: nptype.NDArray[np.number[Any]],
) -> DataContainer_co:
    """
    Calculate cost function

    Parameters
    ----------
    x
        Parameter values

    Returns
    -------
    :
        Results of model run
    """

SupportsNegativeLogLikelihoodCalculation #

Bases: Protocol[DataContainer_contra]

Class that supports negative log likelihood calculations

Methods:

Name Description
calculate_negative_log_likelihood

Calculate negative log likelihood
Source code in src/openscm_calibration/typing.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
class SupportsNegativeLogLikelihoodCalculation(Protocol[DataContainer_contra]):
    """
    Class that supports negative log likelihood calculations
    """

    def calculate_negative_log_likelihood(
        self, model_results: DataContainer_contra
    ) -> float:
        """
        Calculate negative log likelihood

        Parameters
        ----------
        model_results
            Model results for which to calculate the cost

        Returns
        -------
        :
            Negative log likelihood
        """

calculate_negative_log_likelihood #

calculate_negative_log_likelihood(
    model_results: DataContainer_contra,
) -> float

Calculate negative log likelihood

Parameters:

Name Type Description Default
model_results DataContainer_contra

Model results for which to calculate the cost

 required

Returns:

Type Description
float

Negative log likelihood
Source code in src/openscm_calibration/typing.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def calculate_negative_log_likelihood(
    self, model_results: DataContainer_contra
) -> float:
    """
    Calculate negative log likelihood

    Parameters
    ----------
    model_results
        Model results for which to calculate the cost

    Returns
    -------
    :
        Negative log likelihood
    """