Skip to content
voiage

voiage.methods.distributional_information.value_of_distributional_information

value_of_distributional_information

Section titled “value_of_distributional_information”
value_of_distributional_information([positional or keyword] conditional_values: Sequence[Sequence[float]] | np.ndarray = None, [positional or keyword] model_ids: Sequence[str] = None, [positional or keyword] alternative_names: Sequence[str] = None, [positional or keyword] model_probabilities: Sequence[float] = None, [positional or keyword] value_unit: str = None, [positional or keyword] provenance: Mapping[str, str] = None, [keyword-only] model_labels: Mapping[str, str] = None, [keyword-only] model_definitions: Sequence[Mapping[str, str]] = None, [keyword-only] conditional_value_assurance: Mapping[str, object] = None, [keyword-only] comparability: Mapping[str, object] = None, [keyword-only] analysis_id: str = 'distribution-family-information-analysis', [keyword-only] direction: str = 'maximize', [keyword-only] information_cost: float = 0.0, [keyword-only] absolute_tolerance: float = 1e-12, [keyword-only] relative_tolerance: float = 1e-12, [keyword-only] probability_sum_tolerance: float = 1e-12) -> DistributionalInformationResult

Value perfect knowledge of a finite model-family index.

Every row must already contain within-family conditional expected values. This function never optimizes within family draws and never infers or renormalizes model probabilities.

Parameters:

  • conditional_values Sequence[Sequence[float]] | np.ndarray
  • model_ids Sequence[str]
  • alternative_names Sequence[str]
  • model_probabilities Sequence[float]
  • value_unit str
  • provenance Mapping[str, str]
  • model_labels Mapping[str, str]
  • model_definitions Sequence[Mapping[str, str]]
  • conditional_value_assurance Mapping[str, object]
  • comparability Mapping[str, object]
  • analysis_id str (default: 'distribution-family-information-analysis')
  • direction str (default: 'maximize')
  • information_cost float (default: 0.0)
  • absolute_tolerance float (default: 1e-12)
  • relative_tolerance float (default: 1e-12)
  • probability_sum_tolerance float (default: 1e-12)

Returns: DistributionalInformationResult