Skip to content
voiage

voiage.contracts.perspective.run_perspective

run_perspective

Section titled “run_perspective”
run_perspective([positional or keyword] net_benefits: ValueArray | NDArray[np.generic] = None, [keyword-only] analysis_id: str = None, [keyword-only] decision_problem_id: str = None, [keyword-only] parameters: ParameterSet | Mapping[str, NDArray[np.generic]] | NDArray[np.generic] | None = None, [keyword-only] perspectives: PerspectiveSet | Sequence[Perspective | str] | None = None, [keyword-only] strategy_names: Sequence[str] | None = None, [keyword-only] perspective_names: Sequence[str] | None = None, [keyword-only] perspective_weights: Sequence[float] | Mapping[str, float] | None = None, [keyword-only] reference_perspective: str | int | None = None, [keyword-only] tie_policy: str = 'first', [keyword-only] tie_tolerance: float = 1e-12, [keyword-only] policy: NumericalPolicy | None = None) -> AnalysisResult[PerspectivePayload]

Run perspective VOI and return an opt-in canonical envelope.

Parameters:

  • net_benefits ValueArray | NDArray[np.generic]
  • analysis_id str
  • decision_problem_id str
  • parameters ParameterSet | Mapping[str, NDArray[np.generic]] | NDArray[np.generic] | None (default: None)
  • perspectives PerspectiveSet | Sequence[Perspective | str] | None (default: None)
  • strategy_names Sequence[str] | None (default: None)
  • perspective_names Sequence[str] | None (default: None)
  • perspective_weights Sequence[float] | Mapping[str, float] | None (default: None)
  • reference_perspective str | int | None (default: None)
  • tie_policy str (default: 'first')
  • tie_tolerance float (default: 1e-12)
  • policy NumericalPolicy | None (default: None)

Returns: AnalysisResult[PerspectivePayload]