Skip to content

chronulus_core.types.risk

RiskCategory

Bases: BaseModel

Describes a Risk Category referenced in a risk Scorecard

Parameters:

Name Type Description Default
name str

Name of the category

 required
score

Numeric score of the category

 required
max_score float

The maximum score achievable in this category

 required
risks

The list of risk factors identified in this category

 required
Source code in src2/chronulus_core/types/risk.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class RiskCategory(BaseModel):
    """Describes a Risk Category referenced in a risk Scorecard

    Parameters
    ----------
    name : str
        Name of the category
    score: float
        Numeric score of the category
    max_score : float
        The maximum score achievable in this category
    risks: List[str]
        The list of risk factors identified in this category

    """
    name: str = Field(description="Name of the risk category")
    score: float = Field(description="Score of the risk category")
    max_score: float = Field(description="Max possible score for the risk category", default=5.0)
    risks: List[str] = Field(description="List of identified risk factors")

Scorecard

Bases: BaseModel

The risk assessment scorecard for a Session

Our risk scorecard is based on the Responsible Forecast framework (Rostami-Tabar et al., 2024).

Citations

Rostami-Tabar, B., Greene, T., Shmueli, G., & Hyndman, R. J. (2024). Responsible forecasting: identifying and typifying forecasting harms. arXiv preprint arXiv:2411.16531.

Parameters:

Name Type Description Default
categories List[RiskCategory]

A list of categories

 required
assessment

Overall assessment of the risk for the session

 required
recommendation str

Recommendations and risk mitigation strategies for risks highlighted in the assessment

 required

Attributes:

Name Type Description
categories List[RiskCategory]

A list of categories
assessment str

Overall assessment of the risk for the session
recommendation str

Recommendations and risk mitigation strategies for risks highlighted in the assessment
Source code in src2/chronulus_core/types/risk.py 
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
class Scorecard(BaseModel):
    """The risk assessment scorecard for a Session

    Our risk scorecard is based on the Responsible Forecast framework (Rostami-Tabar et al., 2024).

    Citations
    ---------
    Rostami-Tabar, B., Greene, T., Shmueli, G., & Hyndman, R. J.
    (2024). Responsible forecasting: identifying and typifying forecasting harms.
    arXiv preprint arXiv:2411.16531.

    Parameters
    ----------
    categories : List[RiskCategory]
        A list of categories
    assessment: str
        Overall assessment of the risk for the session
    recommendation : str
        Recommendations and risk mitigation strategies for risks highlighted in the assessment


    Attributes
    ----------
    categories : List[RiskCategory]
        A list of categories
    assessment: str
        Overall assessment of the risk for the session
    recommendation : str
        Recommendations and risk mitigation strategies for risks highlighted in the assessment

    """
    categories: List[RiskCategory] = Field(description="Risk categories")
    assessment: str = Field(description="Overall Assessment")
    recommendation: str = Field(description="Mitigation Recommendations")