Python API#
Use this reference to look up a class, method, function, parameter, or return value. Start with Study design and identification for the main workflow. Each category says when its objects enter that workflow.
The reference is generated from the installed package. Its signatures and docstrings therefore match the documented checkout. Objects in the object index form the supported public API. Specialized objects remain in their named submodules.
- Study design and identification
- Estimands
- Estimation methods
- Results and assessment
- Learners
- Interventions
- Sensitivity and validation
- Synthetic datasets
- Exceptions and warnings
- Object index
- cleverly.CausalStudy
- cleverly.StudyProtocol
- cleverly.PointTreatment
- cleverly.LongitudinalTreatment
- cleverly.Repeated
- cleverly.TimeToEvent
- cleverly.LongPanel
- cleverly.longitudinal.PanelLayout
- cleverly.longitudinal.LongitudinalData.from_long_panel
- cleverly.longitudinal.LongitudinalData.to_long_panel
- cleverly.Estimand
- cleverly.IdentificationProvider
- cleverly.ExplicitAdjustmentProvider
- cleverly.IdentifiedEffect
- cleverly.CausalResult
- cleverly.estimators.TMLEResult
- cleverly.longitudinal.LongitudinalResult
- cleverly.fluctuation.Fluctuation
- cleverly.fluctuation.FoldFluctuation
- cleverly.ParameterKey
- cleverly.Provenance
- cleverly.ATE
- cleverly.ATT
- cleverly.ATC
- cleverly.BackdoorMeanContrast
- cleverly.CounterfactualMean
- cleverly.NaturalCourseMean
- cleverly.PopulationAttributableRisk
- cleverly.PopulationAttributableFraction
- cleverly.RiskRatio
- cleverly.OddsRatio
- cleverly.RegimeMean
- cleverly.RegimeContrast
- cleverly.LearnedRuleValue
- cleverly.ModifiedTreatmentPolicy
- cleverly.ModifiedTreatmentPolicyEffect
- cleverly.targets.Interpretation
- cleverly.IncrementalMean
- cleverly.IncrementalEffect
- cleverly.MSMProjection
- cleverly.ControlledDirectEffect
- cleverly.EstimationMethod
- cleverly.TMLEMethod
- cleverly.CollaborativeTMLEMethod
- cleverly.DRTMLEMethod
- cleverly.SDRMethod
- cleverly.IPSIMethod
- cleverly.GComputationMethod
- cleverly.IPWMethod
- cleverly.ParametricGFormulaMethod
- cleverly.ModelSpec
- cleverly.CrossFitting
- cleverly.SplitPlan
- cleverly.Targeting
- cleverly.Inference
- cleverly.Runtime
- cleverly.MethodAvailability
- cleverly.ParameterEstimate
- cleverly.AssessmentCapability
- cleverly.AssessmentReport
- cleverly.AssessmentStatus
- cleverly.DiagnosticReport
- cleverly.ValidationReport
- cleverly.Replayability
- cleverly.VariableImportanceEntry
- cleverly.VariableImportanceResult
- cleverly.variable_importance
- cleverly.load
- cleverly.SuperLearner
- cleverly.CleverlyError
- cleverly.CapabilityError
- cleverly.DataError
- cleverly.MethodConfigurationError
- cleverly.NotFittedError
- cleverly.ConvergenceWarning
- cleverly.MonteCarloWarning
- cleverly.ParameterSpaceWarning
- cleverly.PositivityWarning
- cleverly.SparseInfluenceWarning
- cleverly.VersionMismatchWarning
- cleverly.WeightingWarning
- cleverly.exceptions.Refusal
- cleverly.exceptions.RefusalReason
- cleverly.learners.SuperLearnerDiagnostics
- cleverly.learners.CorrelationScreener
- cleverly.learners.ParametricOutcome
- cleverly.learners.ParametricMechanism
- cleverly.learners.ParametricFitDiagnostics
- cleverly.learners.CrossFitPlan
- cleverly.learners.Folds
- cleverly.learners.FoldOrigin
- cleverly.learners.ConditionalDensity
- cleverly.learners.DensityDiagnostics
- cleverly.learners.default_library
- cleverly.learners.make_folds
- cleverly.learners.random_partition
- cleverly.learners.thread_limit
- cleverly.learners.set_thread_limit
- cleverly.learners.get_thread_limit
- cleverly.interventions.Intervention
- cleverly.interventions.Static
- cleverly.interventions.Rule
- cleverly.interventions.Stochastic
- cleverly.longitudinal.DynamicRegimen
- cleverly.longitudinal.each_node
- cleverly.longitudinal.NodeRule
- cleverly.interventions.LearnedRule
- cleverly.interventions.LearnedRuleRecord
- cleverly.interventions.RegimeSet
- cleverly.interventions.Incremental
- cleverly.interventions.IPSISet
- cleverly.interventions.Shift
- cleverly.interventions.Scale
- cleverly.interventions.DoseQuantile
- cleverly.interventions.SupportBoundary
- cleverly.interventions.LinearQuantileRegression
- cleverly.interventions.Piecewise
- cleverly.interventions.Piece
- cleverly.interventions.Support
- cleverly.interventions.ModifiedPolicy
- cleverly.interventions.Randomizer
- cleverly.interventions.RiskRatioTilt
- cleverly.interventions.JointPolicy
- cleverly.interventions.PolicySet
- cleverly.interventions.SupportReport
- cleverly.interventions.RegimeSupport
- cleverly.interventions.IncrementalSupport
- cleverly.interventions.PolicySupport
- cleverly.interventions.check_support
- cleverly.interventions.check_incremental_support
- cleverly.interventions.check_policy_support
- cleverly.assessment.SensitivityFacade
- cleverly.sensitivity.PositivityReport
- cleverly.sensitivity.SensitivityBounds
- cleverly.sensitivity.SensitivityElements
- cleverly.sensitivity.BenchmarkResult
- cleverly.sensitivity.ConfounderStrengthGrid
- cleverly.sensitivity.ObservedConfounderCalibration
- cleverly.sensitivity.SimulatedConfoundingCell
- cleverly.sensitivity.SimulatedConfoundingResult
- cleverly.sensitivity.EValue
- cleverly.sensitivity.positivity_report
- cleverly.sensitivity.truncation_curve
- cleverly.sensitivity.omitted_variable_bounds
- cleverly.sensitivity.robustness_value
- cleverly.sensitivity.benchmark
- cleverly.sensitivity.evalue.evalue
- cleverly.sensitivity.missingness_tilt
- cleverly.sensitivity.tipping_gamma
- cleverly.sensitivity.simulated_confounding
- cleverly.assessment.DiagnosticsFacade
- cleverly.validation.ScoreCheck
- cleverly.validation.ScoreCheckRow
- cleverly.validation.NuisanceDiagnostics
- cleverly.validation.NuisanceModelReport
- cleverly.validation.RepeatSpreadRow
- cleverly.validation.GaussianNoise
- cleverly.validation.GaussianIndependentOutcome
- cleverly.validation.GaussianAdjustmentOutcome
- cleverly.validation.RelativeGaussianNoise
- cleverly.validation.BootstrapMeasurementError
- cleverly.validation.EmpiricalInclusionRule
- cleverly.validation.EmpiricalRefitRecord
- cleverly.validation.RefutationTest
- cleverly.validation.RefutationResult
- cleverly.validation.CoverageStudy
- cleverly.validation.StudyResult
- cleverly.validation.ReplicationRecord
- cleverly.validation.ReplicationFailure
- cleverly.validation.ReplicationCheckpoint
- cleverly.validation.DirectoryCheckpoint
- cleverly.validation.score_check
- cleverly.validation.nuisance_diagnostics
- cleverly.validation.refute
- cleverly.inference.BootstrapResult
- cleverly.inference.SimultaneousBands
- cleverly.inference.delta_method
- cleverly.inference.influence_covariance
- cleverly.inference.influence_variance
- cleverly.inference.multiplier_critical_value
- cleverly.inference.simultaneous_bands
- cleverly.inference.run_bootstrap
- cleverly.datasets.available
- cleverly.datasets.make_linear_ate
- cleverly.datasets.make_nonlinear_ate
- cleverly.datasets.make_nonlinear_bounded
- cleverly.datasets.make_binary_outcome
- cleverly.datasets.make_multi_arm
- cleverly.datasets.make_heterogeneous
- cleverly.datasets.make_instrument
- cleverly.datasets.make_shift_dose
- cleverly.datasets.make_missing_outcome
- cleverly.datasets.make_missing_outcome_binary
- cleverly.datasets.make_missing_outcome_bounded
- cleverly.datasets.make_cde
- cleverly.datasets.make_clustered
- cleverly.datasets.make_biased_sample
- cleverly.datasets.make_weak_overlap
- cleverly.datasets.make_longitudinal
- cleverly.datasets.make_longitudinal_survival
- cleverly.datasets.make_longitudinal_repeated
- cleverly.datasets.make_longitudinal_competing
- cleverly.datasets.make_longitudinal_weighted
- cleverly.datasets.make_point_survival
- cleverly.datasets.point_survival_truth
- cleverly.datasets.navigation_data
- cleverly.datasets.navigation_protocol
- cleverly.datasets.longitudinal_navigation_protocol
- cleverly.datasets.make_sequential_offers
- cleverly.datasets.offers_truth
- cleverly.datasets.offers_protocol
- cleverly.datasets.win_back
- cleverly.datasets.win_back_then_ship
- cleverly.datasets.make_sequential_pricing
- cleverly.datasets.pricing_truth
- cleverly.datasets.pricing_protocol
- cleverly.datasets.price_rise