Skip to content

Adding uncertainties to mammos-ai #40

Description

@samjrholt

The next version of the BSW model includes uncertainties on the values produced which means we need to decide an interface for these:

Option 1

result = mammos_ai.Hc_Mr_BHmax_from_Ms_A_K(Ms, A, K)

result.Hc
result.Mr
result.BHmax
result.Hc_error
result.Mr_error
result.BHmax_error

Pros: Closest to current user experience,
Cons: Possible changed needed in mammos-analysis

Option 2

result = mammos_ai.Hc_Mr_BHmax_from_Ms_A_K(Ms, A, K)

result.properties.Hc
result.properties.Mr
result.properties.BHmax

result.errors.Hc
result.errors.Mr
result.errors.BHmax

Pros: Keeps current ExtrinsicProperties object unchanged so no changes needed in mammos-analysis
Cons: Backward incompatible unless we add a passthrough

Option 3

result = mammos_ai.Hc_Mr_BHmax_from_Ms_A_K(Ms, A, K)

result.Hc
result.Mr
result.BHmax

where

result.Hc.value
result.Hc.uncertainty # Or
result.Hc.error

Pros: Keeps prediction and uncertainty together
Cons: Larger changes to mammos-entity

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions