API Reference

The public API is available from the top-level updatesupport package. The module pages below document the core implementation areas directly.

• High-Level API
• Data Compilation
  • DataDiagnostic
  • DataDiagnostics
  • GroupedProblem
  • from_dataframe()
  • RowMetric
  • row_metric()
  • target_name()
  • target_description()
  • evaluate_target()
• Reports And Recommendations
  • PublicFiberDiagnostic
  • WitnessCellShift
  • WitnessFiberShift
  • WitnessReport
  • RefinementCandidate
  • InteractionRefinementCandidate
  • InteractionRefinementReport
  • RefinementCoalitionEvaluation
  • RefinementAttribution
  • RefinementAttributionReport
  • RefinementSensitivityCandidate
  • RefinementSensitivityRow
  • RefinementSensitivityScenario
  • RefinementSensitivityReport
  • StatisticalUncertainty
  • EstimatorUncertaintyAdjustment
  • CausalReportingStabilitySuite
  • PublicDescentReport
  • public_descent_report()
  • witness_report()
  • audit_effects()
  • causal_reporting_stability()
  • public_fiber_diagnostics()
  • recommend_refinements()
  • recommend_refinement_interactions()
  • attribute_refinement_ambiguity()
  • recommend_refinements_sensitivity()
  • SensitivityRow
  • SensitivitySummary
  • SensitivityReport
  • sensitivity_report()
  • RepresentationStabilityCertificate
  • certify_public_representation()
• Problems, Presets, And Environments
  • TooManyPartitions
  • FiniteProblem
  • ProblemReport
  • QPreset
  • QEnvironment
  • CvxpyAdmissibleSetSpec
  • q_saturated()
  • q_observed()
  • q_intersection()
  • q_bounded_shift()
  • q_fiber_support_floor()
  • q_tv_budget()
  • q_chi_square_budget()
  • q_kl_budget()
  • q_l2_budget()
  • q_covariate_balance()
  • q_mahalanobis_budget()
  • q_wasserstein()
  • cvxpy_admissible_set_spec()
  • resolve_q_environment()
  • normalize_q_preset()
  • q_name()
  • q_description()
  • LPError
  • CvxpyError
  • Environment
  • CvxpyConstraintMetadata
  • cvxpy_constraint()
  • SupportFunctionResult
  • SupportFunctionIntervalResult
  • SupportFunctionTargetInterval
  • SupportFunctionReport
  • ConvexAdmissibleSet
  • LinearConstraint
  • linear_constraint()
  • leq()
  • geq()
  • eq()
  • PublicFiberSaturated
  • FiniteEnvironments
  • LineSegment
  • PolytopeEnvironments
  • CvxpyEnvironments
  • SupportFunctionBackend
  • support_function_report()
  • BatchedCvxpyEnvironments
  • ParameterizedCvxpyEnvironments
  • Witness
  • AdequacyResult
  • LeastSupportResult
  • ConstraintDual
  • TransportResult
  • UncertainLinearConfidenceCoreResult
  • CardinalGapResult
• Targets
  • UnsupportedTargetError
  • TargetCapabilities
  • TargetContract
  • UnsupportedTarget
  • ProcedureTargetContext
  • ProcedureTarget
  • LinearTarget
  • UncertainLinearTarget
  • MomentTransformTarget
  • RatioTarget
  • coerce_linear_target()
  • coerce_target()
  • raise_if_unsupported_target()
  • declared_target_contract()
• Historical Calibration
  • HistoricalTVTransition
  • RollingTVBacktest
  • HistoricalTVCalibrationReport
  • calibrate_tv_radius()
• Public Representation Frontier
  • FrontierScenarioResult
  • FrontierSearchTrace
  • FrontierScreeningSummary
  • FrontierScreenedRefinement
  • PublicRepresentationCandidate
  • FrontierScenarioComparison
  • FrontierCloseAlternative
  • FrontierCandidateExplanation
  • PublicRepresentationFrontier
  • public_representation_frontier()
• Categorical Rollup Design
  • CategoricalRollupCandidate
  • CategoricalRollupDesign
  • design_categorical_rollup()
• Claim Portfolios
  • ClaimPortfolio
  • PortfolioClaimScenarioResult
  • PortfolioClaimCandidateResult
  • SharedRepresentationCandidate
  • SharedRepresentationDesign
  • claim_portfolio()
  • design_shared_representation()
• Calibrated Public-Report Design
  • CalibratedClaimDesignResult
  • CalibratedPublicReportDesign
  • design_calibrated_public_report()
• Minimum Claim-Breaking Witnesses
  • ClaimBreakingCellShift
  • ClaimBreakingTransfer
  • MinimumClaimBreakingWitnessReport
  • minimum_claim_breaking_witness()
• Breakdown Analysis
  • BreakdownCurvePoint
  • BreakdownPointReport
  • breakdown_point()
• Robust Comparison
  • ComparisonItemResult
  • PairwiseComparisonResult
  • RobustComparisonReport
  • robust_comparison_report()
  • robust_ranking_report()
• Estimator Adapters
  • EstimatorAdapterResult
  • ConformalAdapterResult
  • adapt_dataframe_effects()
  • adapt_conformal_regression()
  • adapt_conformal_classification()
  • adapt_econml_effects()
  • adapt_dowhy_effects()
  • adapt_doubleml_effects()
  • DoWhyRepresentationAudit
  • audit_dowhy_effects()
  • dowhy_refutation_from_report()
• Conformal Prediction
  • ConformalTargetSpec
  • ConformalTargetAudit
  • ConformalReportingStabilityReport
  • conformal_reporting_stability()
• Claim Audits
  • ClaimAudit
  • ClaimNode
  • ClaimNodeAudit
  • ClaimRepairOption
  • ClaimRepairPlan
  • ClaimRefinementRecommendation
  • ClaimScreeningResult
  • ClaimSpec
  • ClaimTree
  • ClaimTreeAudit
  • DecisionResult
  • DecisionRule
  • ModelAssistedDrawResult
  • ModelAssistedStabilitySummary
  • PublicReportDesign
  • audit_claim()
  • audit_claim_tree()
  • claim()
  • claim_tree()
  • design_public_report()
  • plan_claim_repair()
  • threshold_decision()
• Model-Assisted Joint Analysis
  • HiddenCompositionUncertaintyReport
  • HiddenCompositionUncertaintyRow
  • JointCell
  • JointDistributionDraw
  • NonparametricJointDistribution
  • UncertaintyMetricSummary
  • fit_joint_distribution()
  • hidden_composition_uncertainty()
  • joint_draw_records()
• Named Linear Feasibility
• Plugins
  • PluginMetadata
  • UpdateSupportPlugin
  • PluginValidationIssue
  • PluginValidationReport
  • PluginRegistry
  • register_plugin()
  • unregister_plugin()
  • get_plugin()
  • list_plugins()
  • discover_plugins()
  • validate_plugin()
  • assert_valid_plugin()
  • plugin_metric()
  • plugin_q_preset()
  • plugin_report_profile()
  • plugin_compiler()
• Structured Exports
  • report_to_json()
  • report_tables()
  • report_dataframes()
  • tables_to_dataframes()
• Audit Specs
  • QSpec
  • AuditSpec
  • AuditRun
  • run_audit()