voiage.experimental.study_portfolio.allocate_coss_portfolio
allocate_coss_portfolio
Section titled “allocate_coss_portfolio”allocate_coss_portfolio([keyword-only] candidates: Sequence[CossPortfolioCandidateV1] = None, [keyword-only] constraints: Sequence[PortfolioCapacityConstraintV1] = (), [keyword-only] absolute_tolerance: float = _DEFAULT_ATOL, [keyword-only] relative_tolerance: float = _DEFAULT_RTOL) -> StudyPortfolioResultV1Maximize additive signed ENBS over COSS optima under hard constraints.
The empty portfolio is always admissible. Consequently, a study with negative incremental ENBS is never funded merely because spare capacity is available. Ties are resolved by lower total cost and then the lexicographically ordered study-ID tuple.
Parameters:
candidatesSequence[CossPortfolioCandidateV1]constraintsSequence[PortfolioCapacityConstraintV1](default:())absolute_tolerancefloat(default:_DEFAULT_ATOL)relative_tolerancefloat(default:_DEFAULT_RTOL)
Returns: StudyPortfolioResultV1