Skip to main content
Ctrl+K
Open Source Marketing Analytics Solution - Home
dev
  • Getting Started
  • Contributing
  • Guide
  • API
  • Example Gallery
    • About PyMC Labs
  • Getting Started
  • Contributing
  • Guide
  • API
  • Example Gallery
  • About PyMC Labs

Section Navigation

  • bass
    • model
      • F
      • create_bass_model
      • f
  • clv
    • distributions
      • BetaGeoBetaBinom
        • BetaGeoBetaBinom.__init__
        • BetaGeoBetaBinom.dist
        • BetaGeoBetaBinom.logp
      • BetaGeoBetaBinomRV
        • BetaGeoBetaBinomRV.L_op
        • BetaGeoBetaBinomRV.R_op
        • BetaGeoBetaBinomRV.__init__
        • BetaGeoBetaBinomRV.add_tag_trace
        • BetaGeoBetaBinomRV.batch_ndim
        • BetaGeoBetaBinomRV.dist_params
        • BetaGeoBetaBinomRV.do_constant_folding
        • BetaGeoBetaBinomRV.grad
        • BetaGeoBetaBinomRV.infer_shape
        • BetaGeoBetaBinomRV.inplace_on_inputs
        • BetaGeoBetaBinomRV.make_node
        • BetaGeoBetaBinomRV.make_py_thunk
        • BetaGeoBetaBinomRV.make_thunk
        • BetaGeoBetaBinomRV.perform
        • BetaGeoBetaBinomRV.prepare_node
        • BetaGeoBetaBinomRV.rng_fn
        • BetaGeoBetaBinomRV.rng_param
        • BetaGeoBetaBinomRV.size_param
      • BetaGeoNBD
        • BetaGeoNBD.__init__
        • BetaGeoNBD.dist
        • BetaGeoNBD.logp
      • BetaGeoNBDRV
        • BetaGeoNBDRV.L_op
        • BetaGeoNBDRV.R_op
        • BetaGeoNBDRV.__init__
        • BetaGeoNBDRV.add_tag_trace
        • BetaGeoNBDRV.batch_ndim
        • BetaGeoNBDRV.dist_params
        • BetaGeoNBDRV.do_constant_folding
        • BetaGeoNBDRV.grad
        • BetaGeoNBDRV.infer_shape
        • BetaGeoNBDRV.inplace_on_inputs
        • BetaGeoNBDRV.make_node
        • BetaGeoNBDRV.make_py_thunk
        • BetaGeoNBDRV.make_thunk
        • BetaGeoNBDRV.perform
        • BetaGeoNBDRV.prepare_node
        • BetaGeoNBDRV.rng_fn
        • BetaGeoNBDRV.rng_param
        • BetaGeoNBDRV.size_param
      • ContContract
        • ContContract.__init__
        • ContContract.dist
        • ContContract.logp
      • ContContractRV
        • ContContractRV.L_op
        • ContContractRV.R_op
        • ContContractRV.__init__
        • ContContractRV.add_tag_trace
        • ContContractRV.batch_ndim
        • ContContractRV.dist_params
        • ContContractRV.do_constant_folding
        • ContContractRV.grad
        • ContContractRV.infer_shape
        • ContContractRV.inplace_on_inputs
        • ContContractRV.make_node
        • ContContractRV.make_py_thunk
        • ContContractRV.make_thunk
        • ContContractRV.perform
        • ContContractRV.prepare_node
        • ContContractRV.rng_fn
        • ContContractRV.rng_param
        • ContContractRV.size_param
      • ContNonContract
        • ContNonContract.__init__
        • ContNonContract.dist
        • ContNonContract.logp
      • ContNonContractRV
        • ContNonContractRV.L_op
        • ContNonContractRV.R_op
        • ContNonContractRV.__init__
        • ContNonContractRV.add_tag_trace
        • ContNonContractRV.batch_ndim
        • ContNonContractRV.dist_params
        • ContNonContractRV.do_constant_folding
        • ContNonContractRV.grad
        • ContNonContractRV.infer_shape
        • ContNonContractRV.inplace_on_inputs
        • ContNonContractRV.make_node
        • ContNonContractRV.make_py_thunk
        • ContNonContractRV.make_thunk
        • ContNonContractRV.perform
        • ContNonContractRV.prepare_node
        • ContNonContractRV.rng_fn
        • ContNonContractRV.rng_param
        • ContNonContractRV.size_param
      • ModifiedBetaGeoNBD
        • ModifiedBetaGeoNBD.__init__
        • ModifiedBetaGeoNBD.dist
        • ModifiedBetaGeoNBD.logp
      • ModifiedBetaGeoNBDRV
        • ModifiedBetaGeoNBDRV.L_op
        • ModifiedBetaGeoNBDRV.R_op
        • ModifiedBetaGeoNBDRV.__init__
        • ModifiedBetaGeoNBDRV.add_tag_trace
        • ModifiedBetaGeoNBDRV.batch_ndim
        • ModifiedBetaGeoNBDRV.dist_params
        • ModifiedBetaGeoNBDRV.do_constant_folding
        • ModifiedBetaGeoNBDRV.grad
        • ModifiedBetaGeoNBDRV.infer_shape
        • ModifiedBetaGeoNBDRV.inplace_on_inputs
        • ModifiedBetaGeoNBDRV.make_node
        • ModifiedBetaGeoNBDRV.make_py_thunk
        • ModifiedBetaGeoNBDRV.make_thunk
        • ModifiedBetaGeoNBDRV.perform
        • ModifiedBetaGeoNBDRV.prepare_node
        • ModifiedBetaGeoNBDRV.rng_fn
        • ModifiedBetaGeoNBDRV.rng_param
        • ModifiedBetaGeoNBDRV.size_param
      • ParetoNBD
        • ParetoNBD.__init__
        • ParetoNBD.dist
        • ParetoNBD.logp
      • ParetoNBDRV
        • ParetoNBDRV.L_op
        • ParetoNBDRV.R_op
        • ParetoNBDRV.__init__
        • ParetoNBDRV.add_tag_trace
        • ParetoNBDRV.batch_ndim
        • ParetoNBDRV.dist_params
        • ParetoNBDRV.do_constant_folding
        • ParetoNBDRV.grad
        • ParetoNBDRV.infer_shape
        • ParetoNBDRV.inplace_on_inputs
        • ParetoNBDRV.make_node
        • ParetoNBDRV.make_py_thunk
        • ParetoNBDRV.make_thunk
        • ParetoNBDRV.perform
        • ParetoNBDRV.prepare_node
        • ParetoNBDRV.rng_fn
        • ParetoNBDRV.rng_param
        • ParetoNBDRV.size_param
    • models
      • basic
        • CLVModel
      • beta_geo
        • BetaGeoModel
      • beta_geo_beta_binom
        • BetaGeoBetaBinomModel
      • gamma_gamma
        • BaseGammaGammaModel
        • GammaGammaModel
        • GammaGammaModelIndividual
      • modified_beta_geo
        • ModifiedBetaGeoModel
      • pareto_nbd
        • ParetoNBDModel
      • shifted_beta_geo
        • ShiftedBetaGeoModelIndividual
    • plotting
      • plot_customer_exposure
      • plot_expected_purchases_over_time
      • plot_expected_purchases_ppc
      • plot_frequency_recency_matrix
      • plot_probability_alive_matrix
    • utils
      • customer_lifetime_value
      • rfm_segments
      • rfm_summary
      • rfm_train_test_split
      • to_xarray
  • customer_choice
    • mv_its
      • plot_product
      • MVITS
        • MVITS.__init__
        • MVITS.attrs_to_init_kwargs
        • MVITS.build_from_idata
        • MVITS.build_model
        • MVITS.calculate_counterfactual
        • MVITS.causal_impact
        • MVITS.create_fit_data
        • MVITS.create_idata_attrs
        • MVITS.fit
        • MVITS.graphviz
        • MVITS.inform_default_prior
        • MVITS.load
        • MVITS.load_from_idata
        • MVITS.plot_causal_impact_market_share
        • MVITS.plot_causal_impact_sales
        • MVITS.plot_counterfactual
        • MVITS.plot_data
        • MVITS.plot_fit
        • MVITS.post_sample_model_transformation
        • MVITS.predict
        • MVITS.predict_posterior
        • MVITS.predict_proba
        • MVITS.sample
        • MVITS.sample_posterior_predictive
        • MVITS.sample_prior_predictive
        • MVITS.save
        • MVITS.set_idata_attrs
    • synthetic_data
      • generate_saturated_data
      • generate_unsaturated_data
  • deserialize
    • deserialize
    • register_deserialization
    • Deserializer
      • Deserializer.__init__
  • hsgp_kwargs
    • HSGPKwargs
      • HSGPKwargs.__init__
      • HSGPKwargs.construct
      • HSGPKwargs.copy
      • HSGPKwargs.dict
      • HSGPKwargs.from_orm
      • HSGPKwargs.json
      • HSGPKwargs.model_construct
      • HSGPKwargs.model_copy
      • HSGPKwargs.model_dump
      • HSGPKwargs.model_dump_json
      • HSGPKwargs.model_json_schema
      • HSGPKwargs.model_parametrized_name
      • HSGPKwargs.model_post_init
      • HSGPKwargs.model_rebuild
      • HSGPKwargs.model_validate
      • HSGPKwargs.model_validate_json
      • HSGPKwargs.model_validate_strings
      • HSGPKwargs.parse_file
      • HSGPKwargs.parse_obj
      • HSGPKwargs.parse_raw
      • HSGPKwargs.schema
      • HSGPKwargs.schema_json
      • HSGPKwargs.update_forward_refs
      • HSGPKwargs.validate
  • metrics
    • crps
    • nmae
    • nrmse
    • per_observation_crps
  • mlflow
    • autolog
    • create_log_callback
    • load_mmm
    • log_arviz_summary
    • log_error
    • log_inference_data
    • log_likelihood_type
    • log_metadata
    • log_mmm
    • log_mmm_configuration
    • log_mmm_evaluation_metrics
    • log_model_derived_info
    • log_model_graph
    • log_sample_diagnostics
    • log_types_of_parameters
    • log_versions
    • MMMWrapper
      • MMMWrapper.__init__
      • MMMWrapper.load_context
      • MMMWrapper.predict
      • MMMWrapper.predict_stream
  • mmm
    • additive_effect
      • EventAdditiveEffect
        • EventAdditiveEffect.__init__
        • EventAdditiveEffect.construct
        • EventAdditiveEffect.copy
        • EventAdditiveEffect.create_data
        • EventAdditiveEffect.create_effect
        • EventAdditiveEffect.dict
        • EventAdditiveEffect.from_orm
        • EventAdditiveEffect.json
        • EventAdditiveEffect.model_construct
        • EventAdditiveEffect.model_copy
        • EventAdditiveEffect.model_dump
        • EventAdditiveEffect.model_dump_json
        • EventAdditiveEffect.model_json_schema
        • EventAdditiveEffect.model_parametrized_name
        • EventAdditiveEffect.model_post_init
        • EventAdditiveEffect.model_rebuild
        • EventAdditiveEffect.model_validate
        • EventAdditiveEffect.model_validate_json
        • EventAdditiveEffect.model_validate_strings
        • EventAdditiveEffect.parse_file
        • EventAdditiveEffect.parse_obj
        • EventAdditiveEffect.parse_raw
        • EventAdditiveEffect.schema
        • EventAdditiveEffect.schema_json
        • EventAdditiveEffect.set_data
        • EventAdditiveEffect.update_forward_refs
        • EventAdditiveEffect.validate
      • FourierEffect
        • FourierEffect.__init__
        • FourierEffect.create_data
        • FourierEffect.create_effect
        • FourierEffect.set_data
      • LinearTrendEffect
        • LinearTrendEffect.__init__
        • LinearTrendEffect.create_data
        • LinearTrendEffect.create_effect
        • LinearTrendEffect.set_data
      • MMM
        • MMM.__init__
      • MuEffect
        • MuEffect.__init__
        • MuEffect.create_data
        • MuEffect.create_effect
        • MuEffect.set_data
    • base
      • BaseValidateMMM
        • BaseValidateMMM.__init__
        • BaseValidateMMM.attrs_to_init_kwargs
        • BaseValidateMMM.build_from_idata
        • BaseValidateMMM.build_model
        • BaseValidateMMM.compute_channel_contribution_original_scale
        • BaseValidateMMM.compute_mean_contributions_over_time
        • BaseValidateMMM.create_fit_data
        • BaseValidateMMM.create_idata_attrs
        • BaseValidateMMM.fit
        • BaseValidateMMM.get_channel_contributions_share_samples
        • BaseValidateMMM.get_errors
        • BaseValidateMMM.get_target_transformer
        • BaseValidateMMM.graphviz
        • BaseValidateMMM.load
        • BaseValidateMMM.load_from_idata
        • BaseValidateMMM.plot_channel_contribution_share_hdi
        • BaseValidateMMM.plot_components_contributions
        • BaseValidateMMM.plot_errors
        • BaseValidateMMM.plot_grouped_contribution_breakdown_over_time
        • BaseValidateMMM.plot_posterior_predictive
        • BaseValidateMMM.plot_prior_predictive
        • BaseValidateMMM.plot_prior_vs_posterior
        • BaseValidateMMM.plot_waterfall_components_decomposition
        • BaseValidateMMM.post_sample_model_transformation
        • BaseValidateMMM.predict
        • BaseValidateMMM.predict_posterior
        • BaseValidateMMM.predict_proba
        • BaseValidateMMM.preprocess
        • BaseValidateMMM.sample_posterior_predictive
        • BaseValidateMMM.sample_prior_predictive
        • BaseValidateMMM.save
        • BaseValidateMMM.set_idata_attrs
        • BaseValidateMMM.validate
        • BaseValidateMMM.validate_channel_columns
        • BaseValidateMMM.validate_date_col
        • BaseValidateMMM.validate_target
      • MMMModelBuilder
        • MMMModelBuilder.__init__
        • MMMModelBuilder.attrs_to_init_kwargs
        • MMMModelBuilder.build_from_idata
        • MMMModelBuilder.build_model
        • MMMModelBuilder.compute_channel_contribution_original_scale
        • MMMModelBuilder.compute_mean_contributions_over_time
        • MMMModelBuilder.create_fit_data
        • MMMModelBuilder.create_idata_attrs
        • MMMModelBuilder.fit
        • MMMModelBuilder.get_channel_contributions_share_samples
        • MMMModelBuilder.get_errors
        • MMMModelBuilder.get_target_transformer
        • MMMModelBuilder.graphviz
        • MMMModelBuilder.load
        • MMMModelBuilder.load_from_idata
        • MMMModelBuilder.plot_channel_contribution_share_hdi
        • MMMModelBuilder.plot_components_contributions
        • MMMModelBuilder.plot_errors
        • MMMModelBuilder.plot_grouped_contribution_breakdown_over_time
        • MMMModelBuilder.plot_posterior_predictive
        • MMMModelBuilder.plot_prior_predictive
        • MMMModelBuilder.plot_prior_vs_posterior
        • MMMModelBuilder.plot_waterfall_components_decomposition
        • MMMModelBuilder.post_sample_model_transformation
        • MMMModelBuilder.predict
        • MMMModelBuilder.predict_posterior
        • MMMModelBuilder.predict_proba
        • MMMModelBuilder.preprocess
        • MMMModelBuilder.sample_posterior_predictive
        • MMMModelBuilder.sample_prior_predictive
        • MMMModelBuilder.save
        • MMMModelBuilder.set_idata_attrs
        • MMMModelBuilder.validate
    • budget_optimizer
      • optimizer_xarray_builder
      • BudgetOptimizer
        • BudgetOptimizer.__init__
        • BudgetOptimizer.allocate_budget
        • BudgetOptimizer.construct
        • BudgetOptimizer.copy
        • BudgetOptimizer.dict
        • BudgetOptimizer.extract_response_distribution
        • BudgetOptimizer.from_orm
        • BudgetOptimizer.json
        • BudgetOptimizer.model_construct
        • BudgetOptimizer.model_copy
        • BudgetOptimizer.model_dump
        • BudgetOptimizer.model_dump_json
        • BudgetOptimizer.model_json_schema
        • BudgetOptimizer.model_parametrized_name
        • BudgetOptimizer.model_post_init
        • BudgetOptimizer.model_rebuild
        • BudgetOptimizer.model_validate
        • BudgetOptimizer.model_validate_json
        • BudgetOptimizer.model_validate_strings
        • BudgetOptimizer.parse_file
        • BudgetOptimizer.parse_obj
        • BudgetOptimizer.parse_raw
        • BudgetOptimizer.schema
        • BudgetOptimizer.schema_json
        • BudgetOptimizer.set_constraints
        • BudgetOptimizer.update_forward_refs
        • BudgetOptimizer.validate
      • OptimizerCompatibleModelWrapper
        • OptimizerCompatibleModelWrapper.__init__
    • causal
      • CausalGraphModel
        • CausalGraphModel.__init__
        • CausalGraphModel.build_graphical_model
        • CausalGraphModel.compute_adjustment_sets
        • CausalGraphModel.get_backdoor_paths
        • CausalGraphModel.get_unique_adjustment_nodes
    • components
      • adstock
        • adstock_from_dict
        • AdstockTransformation
        • DelayedAdstock
        • GeometricAdstock
        • WeibullCDFAdstock
        • WeibullPDFAdstock
      • base
        • create_registration_meta
        • Transformation
      • saturation
        • saturation_from_dict
        • HillSaturation
        • HillSaturationSigmoid
        • InverseScaledLogisticSaturation
        • LogisticSaturation
        • MichaelisMentenSaturation
        • RootSaturation
        • SaturationTransformation
        • TanhSaturation
        • TanhSaturationBaselined
    • constraints
      • build_default_sum_constraint
      • compile_constraints_for_scipy
      • Constraint
        • Constraint.__init__
    • evaluation
      • calculate_metric_distributions
      • compute_summary_metrics
      • summarize_metric_distributions
    • events
      • basis_from_dict
      • days_from_reference
      • Basis
        • Basis.__init__
        • Basis.apply
        • Basis.plot_curve
        • Basis.plot_curve_hdi
        • Basis.plot_curve_samples
        • Basis.sample_curve
        • Basis.sample_prior
        • Basis.set_dims_for_all_priors
        • Basis.to_dict
        • Basis.update_priors
      • EventEffect
        • EventEffect.__init__
        • EventEffect.apply
        • EventEffect.construct
        • EventEffect.copy
        • EventEffect.dict
        • EventEffect.from_dict
        • EventEffect.from_orm
        • EventEffect.json
        • EventEffect.model_construct
        • EventEffect.model_copy
        • EventEffect.model_dump
        • EventEffect.model_dump_json
        • EventEffect.model_json_schema
        • EventEffect.model_parametrized_name
        • EventEffect.model_post_init
        • EventEffect.model_rebuild
        • EventEffect.model_validate
        • EventEffect.model_validate_json
        • EventEffect.model_validate_strings
        • EventEffect.parse_file
        • EventEffect.parse_obj
        • EventEffect.parse_raw
        • EventEffect.schema
        • EventEffect.schema_json
        • EventEffect.to_dict
        • EventEffect.update_forward_refs
        • EventEffect.validate
      • GaussianBasis
        • GaussianBasis.__init__
        • GaussianBasis.apply
        • GaussianBasis.function
        • GaussianBasis.plot_curve
        • GaussianBasis.plot_curve_hdi
        • GaussianBasis.plot_curve_samples
        • GaussianBasis.sample_curve
        • GaussianBasis.sample_prior
        • GaussianBasis.set_dims_for_all_priors
        • GaussianBasis.to_dict
        • GaussianBasis.update_priors
    • fourier
      • generate_fourier_modes
      • FourierBase
        • FourierBase.__init__
        • FourierBase.apply
        • FourierBase.construct
        • FourierBase.copy
        • FourierBase.dict
        • FourierBase.from_dict
        • FourierBase.from_orm
        • FourierBase.get_default_start_date
        • FourierBase.json
        • FourierBase.model_construct
        • FourierBase.model_copy
        • FourierBase.model_dump
        • FourierBase.model_dump_json
        • FourierBase.model_json_schema
        • FourierBase.model_parametrized_name
        • FourierBase.model_post_init
        • FourierBase.model_rebuild
        • FourierBase.model_validate
        • FourierBase.model_validate_json
        • FourierBase.model_validate_strings
        • FourierBase.parse_file
        • FourierBase.parse_obj
        • FourierBase.parse_raw
        • FourierBase.plot_curve
        • FourierBase.plot_curve_hdi
        • FourierBase.plot_curve_samples
        • FourierBase.sample_curve
        • FourierBase.sample_prior
        • FourierBase.schema
        • FourierBase.schema_json
        • FourierBase.serialize_prior
        • FourierBase.to_dict
        • FourierBase.update_forward_refs
        • FourierBase.validate
      • MonthlyFourier
        • MonthlyFourier.__init__
        • MonthlyFourier.apply
        • MonthlyFourier.construct
        • MonthlyFourier.copy
        • MonthlyFourier.dict
        • MonthlyFourier.from_dict
        • MonthlyFourier.from_orm
        • MonthlyFourier.get_default_start_date
        • MonthlyFourier.json
        • MonthlyFourier.model_construct
        • MonthlyFourier.model_copy
        • MonthlyFourier.model_dump
        • MonthlyFourier.model_dump_json
        • MonthlyFourier.model_json_schema
        • MonthlyFourier.model_parametrized_name
        • MonthlyFourier.model_post_init
        • MonthlyFourier.model_rebuild
        • MonthlyFourier.model_validate
        • MonthlyFourier.model_validate_json
        • MonthlyFourier.model_validate_strings
        • MonthlyFourier.parse_file
        • MonthlyFourier.parse_obj
        • MonthlyFourier.parse_raw
        • MonthlyFourier.plot_curve
        • MonthlyFourier.plot_curve_hdi
        • MonthlyFourier.plot_curve_samples
        • MonthlyFourier.sample_curve
        • MonthlyFourier.sample_prior
        • MonthlyFourier.schema
        • MonthlyFourier.schema_json
        • MonthlyFourier.serialize_prior
        • MonthlyFourier.to_dict
        • MonthlyFourier.update_forward_refs
        • MonthlyFourier.validate
      • WeeklyFourier
        • WeeklyFourier.__init__
        • WeeklyFourier.apply
        • WeeklyFourier.construct
        • WeeklyFourier.copy
        • WeeklyFourier.dict
        • WeeklyFourier.from_dict
        • WeeklyFourier.from_orm
        • WeeklyFourier.get_default_start_date
        • WeeklyFourier.json
        • WeeklyFourier.model_construct
        • WeeklyFourier.model_copy
        • WeeklyFourier.model_dump
        • WeeklyFourier.model_dump_json
        • WeeklyFourier.model_json_schema
        • WeeklyFourier.model_parametrized_name
        • WeeklyFourier.model_post_init
        • WeeklyFourier.model_rebuild
        • WeeklyFourier.model_validate
        • WeeklyFourier.model_validate_json
        • WeeklyFourier.model_validate_strings
        • WeeklyFourier.parse_file
        • WeeklyFourier.parse_obj
        • WeeklyFourier.parse_raw
        • WeeklyFourier.plot_curve
        • WeeklyFourier.plot_curve_hdi
        • WeeklyFourier.plot_curve_samples
        • WeeklyFourier.sample_curve
        • WeeklyFourier.sample_prior
        • WeeklyFourier.schema
        • WeeklyFourier.schema_json
        • WeeklyFourier.serialize_prior
        • WeeklyFourier.to_dict
        • WeeklyFourier.update_forward_refs
        • WeeklyFourier.validate
      • YearlyFourier
        • YearlyFourier.__init__
        • YearlyFourier.apply
        • YearlyFourier.construct
        • YearlyFourier.copy
        • YearlyFourier.dict
        • YearlyFourier.from_dict
        • YearlyFourier.from_orm
        • YearlyFourier.get_default_start_date
        • YearlyFourier.json
        • YearlyFourier.model_construct
        • YearlyFourier.model_copy
        • YearlyFourier.model_dump
        • YearlyFourier.model_dump_json
        • YearlyFourier.model_json_schema
        • YearlyFourier.model_parametrized_name
        • YearlyFourier.model_post_init
        • YearlyFourier.model_rebuild
        • YearlyFourier.model_validate
        • YearlyFourier.model_validate_json
        • YearlyFourier.model_validate_strings
        • YearlyFourier.parse_file
        • YearlyFourier.parse_obj
        • YearlyFourier.parse_raw
        • YearlyFourier.plot_curve
        • YearlyFourier.plot_curve_hdi
        • YearlyFourier.plot_curve_samples
        • YearlyFourier.sample_curve
        • YearlyFourier.sample_prior
        • YearlyFourier.schema
        • YearlyFourier.schema_json
        • YearlyFourier.serialize_prior
        • YearlyFourier.to_dict
        • YearlyFourier.update_forward_refs
        • YearlyFourier.validate
    • hsgp
      • approx_hsgp_hyperparams
      • create_complexity_penalizing_prior
      • create_constrained_inverse_gamma_prior
      • create_eta_prior
      • create_m_and_L_recommendations
      • CovFunc
        • CovFunc.encode
        • CovFunc.replace
        • CovFunc.split
        • CovFunc.rsplit
        • CovFunc.join
        • CovFunc.capitalize
        • CovFunc.casefold
        • CovFunc.title
        • CovFunc.center
        • CovFunc.count
        • CovFunc.expandtabs
        • CovFunc.find
        • CovFunc.partition
        • CovFunc.index
        • CovFunc.ljust
        • CovFunc.lower
        • CovFunc.lstrip
        • CovFunc.rfind
        • CovFunc.rindex
        • CovFunc.rjust
        • CovFunc.rstrip
        • CovFunc.rpartition
        • CovFunc.splitlines
        • CovFunc.strip
        • CovFunc.swapcase
        • CovFunc.translate
        • CovFunc.upper
        • CovFunc.startswith
        • CovFunc.endswith
        • CovFunc.removeprefix
        • CovFunc.removesuffix
        • CovFunc.isascii
        • CovFunc.islower
        • CovFunc.isupper
        • CovFunc.istitle
        • CovFunc.isspace
        • CovFunc.isdecimal
        • CovFunc.isdigit
        • CovFunc.isnumeric
        • CovFunc.isalpha
        • CovFunc.isalnum
        • CovFunc.isidentifier
        • CovFunc.isprintable
        • CovFunc.zfill
        • CovFunc.format
        • CovFunc.format_map
        • CovFunc.maketrans
      • HSGP
        • HSGP.__init__
        • HSGP.construct
        • HSGP.copy
        • HSGP.create_variable
        • HSGP.deterministics_to_replace
        • HSGP.dict
        • HSGP.from_dict
        • HSGP.from_orm
        • HSGP.json
        • HSGP.model_construct
        • HSGP.model_copy
        • HSGP.model_dump
        • HSGP.model_dump_json
        • HSGP.model_json_schema
        • HSGP.model_parametrized_name
        • HSGP.model_post_init
        • HSGP.model_rebuild
        • HSGP.model_validate
        • HSGP.model_validate_json
        • HSGP.model_validate_strings
        • HSGP.parameterize_from_data
        • HSGP.parse_file
        • HSGP.parse_obj
        • HSGP.parse_raw
        • HSGP.plot_curve
        • HSGP.register_data
        • HSGP.sample_prior
        • HSGP.schema
        • HSGP.schema_json
        • HSGP.to_dict
        • HSGP.update_forward_refs
        • HSGP.validate
      • HSGPBase
        • HSGPBase.__init__
        • HSGPBase.construct
        • HSGPBase.copy
        • HSGPBase.create_variable
        • HSGPBase.deterministics_to_replace
        • HSGPBase.dict
        • HSGPBase.from_orm
        • HSGPBase.json
        • HSGPBase.model_construct
        • HSGPBase.model_copy
        • HSGPBase.model_dump
        • HSGPBase.model_dump_json
        • HSGPBase.model_json_schema
        • HSGPBase.model_parametrized_name
        • HSGPBase.model_post_init
        • HSGPBase.model_rebuild
        • HSGPBase.model_validate
        • HSGPBase.model_validate_json
        • HSGPBase.model_validate_strings
        • HSGPBase.parse_file
        • HSGPBase.parse_obj
        • HSGPBase.parse_raw
        • HSGPBase.plot_curve
        • HSGPBase.register_data
        • HSGPBase.sample_prior
        • HSGPBase.schema
        • HSGPBase.schema_json
        • HSGPBase.to_dict
        • HSGPBase.update_forward_refs
        • HSGPBase.validate
      • HSGPPeriodic
        • HSGPPeriodic.__init__
        • HSGPPeriodic.construct
        • HSGPPeriodic.copy
        • HSGPPeriodic.create_variable
        • HSGPPeriodic.deterministics_to_replace
        • HSGPPeriodic.dict
        • HSGPPeriodic.from_dict
        • HSGPPeriodic.from_orm
        • HSGPPeriodic.json
        • HSGPPeriodic.model_construct
        • HSGPPeriodic.model_copy
        • HSGPPeriodic.model_dump
        • HSGPPeriodic.model_dump_json
        • HSGPPeriodic.model_json_schema
        • HSGPPeriodic.model_parametrized_name
        • HSGPPeriodic.model_post_init
        • HSGPPeriodic.model_rebuild
        • HSGPPeriodic.model_validate
        • HSGPPeriodic.model_validate_json
        • HSGPPeriodic.model_validate_strings
        • HSGPPeriodic.parse_file
        • HSGPPeriodic.parse_obj
        • HSGPPeriodic.parse_raw
        • HSGPPeriodic.plot_curve
        • HSGPPeriodic.register_data
        • HSGPPeriodic.sample_prior
        • HSGPPeriodic.schema
        • HSGPPeriodic.schema_json
        • HSGPPeriodic.to_dict
        • HSGPPeriodic.update_forward_refs
        • HSGPPeriodic.validate
      • PeriodicCovFunc
        • PeriodicCovFunc.encode
        • PeriodicCovFunc.replace
        • PeriodicCovFunc.split
        • PeriodicCovFunc.rsplit
        • PeriodicCovFunc.join
        • PeriodicCovFunc.capitalize
        • PeriodicCovFunc.casefold
        • PeriodicCovFunc.title
        • PeriodicCovFunc.center
        • PeriodicCovFunc.count
        • PeriodicCovFunc.expandtabs
        • PeriodicCovFunc.find
        • PeriodicCovFunc.partition
        • PeriodicCovFunc.index
        • PeriodicCovFunc.ljust
        • PeriodicCovFunc.lower
        • PeriodicCovFunc.lstrip
        • PeriodicCovFunc.rfind
        • PeriodicCovFunc.rindex
        • PeriodicCovFunc.rjust
        • PeriodicCovFunc.rstrip
        • PeriodicCovFunc.rpartition
        • PeriodicCovFunc.splitlines
        • PeriodicCovFunc.strip
        • PeriodicCovFunc.swapcase
        • PeriodicCovFunc.translate
        • PeriodicCovFunc.upper
        • PeriodicCovFunc.startswith
        • PeriodicCovFunc.endswith
        • PeriodicCovFunc.removeprefix
        • PeriodicCovFunc.removesuffix
        • PeriodicCovFunc.isascii
        • PeriodicCovFunc.islower
        • PeriodicCovFunc.isupper
        • PeriodicCovFunc.istitle
        • PeriodicCovFunc.isspace
        • PeriodicCovFunc.isdecimal
        • PeriodicCovFunc.isdigit
        • PeriodicCovFunc.isnumeric
        • PeriodicCovFunc.isalpha
        • PeriodicCovFunc.isalnum
        • PeriodicCovFunc.isidentifier
        • PeriodicCovFunc.isprintable
        • PeriodicCovFunc.zfill
        • PeriodicCovFunc.format
        • PeriodicCovFunc.format_map
        • PeriodicCovFunc.maketrans
      • SoftPlusHSGP
        • SoftPlusHSGP.__init__
        • SoftPlusHSGP.construct
        • SoftPlusHSGP.copy
        • SoftPlusHSGP.create_variable
        • SoftPlusHSGP.deterministics_to_replace
        • SoftPlusHSGP.dict
        • SoftPlusHSGP.from_dict
        • SoftPlusHSGP.from_orm
        • SoftPlusHSGP.json
        • SoftPlusHSGP.model_construct
        • SoftPlusHSGP.model_copy
        • SoftPlusHSGP.model_dump
        • SoftPlusHSGP.model_dump_json
        • SoftPlusHSGP.model_json_schema
        • SoftPlusHSGP.model_parametrized_name
        • SoftPlusHSGP.model_post_init
        • SoftPlusHSGP.model_rebuild
        • SoftPlusHSGP.model_validate
        • SoftPlusHSGP.model_validate_json
        • SoftPlusHSGP.model_validate_strings
        • SoftPlusHSGP.parameterize_from_data
        • SoftPlusHSGP.parse_file
        • SoftPlusHSGP.parse_obj
        • SoftPlusHSGP.parse_raw
        • SoftPlusHSGP.plot_curve
        • SoftPlusHSGP.register_data
        • SoftPlusHSGP.sample_prior
        • SoftPlusHSGP.schema
        • SoftPlusHSGP.schema_json
        • SoftPlusHSGP.to_dict
        • SoftPlusHSGP.update_forward_refs
        • SoftPlusHSGP.validate
    • lift_test
      • add_lift_measurements_to_likelihood_from_saturation
      • add_saturation_observations
      • assert_is_subset
      • assert_monotonic
      • create_time_varying_saturation
      • create_variable_indexer
      • exact_row_indices
      • scale_channel_lift_measurements
      • scale_lift_measurements
      • scale_target_for_lift_measurements
    • linear_trend
      • LinearTrend
        • LinearTrend.__init__
        • LinearTrend.apply
        • LinearTrend.construct
        • LinearTrend.copy
        • LinearTrend.dict
        • LinearTrend.from_orm
        • LinearTrend.json
        • LinearTrend.model_construct
        • LinearTrend.model_copy
        • LinearTrend.model_dump
        • LinearTrend.model_dump_json
        • LinearTrend.model_json_schema
        • LinearTrend.model_parametrized_name
        • LinearTrend.model_post_init
        • LinearTrend.model_rebuild
        • LinearTrend.model_validate
        • LinearTrend.model_validate_json
        • LinearTrend.model_validate_strings
        • LinearTrend.parse_file
        • LinearTrend.parse_obj
        • LinearTrend.parse_raw
        • LinearTrend.plot_curve
        • LinearTrend.sample_curve
        • LinearTrend.sample_prior
        • LinearTrend.schema
        • LinearTrend.schema_json
        • LinearTrend.update_forward_refs
        • LinearTrend.validate
    • media_transformation
      • MediaConfig
        • MediaConfig.__init__
        • MediaConfig.from_dict
        • MediaConfig.to_dict
      • MediaConfigList
        • MediaConfigList.__init__
        • MediaConfigList.from_dict
        • MediaConfigList.to_dict
      • MediaTransformation
        • MediaTransformation.__init__
        • MediaTransformation.from_dict
        • MediaTransformation.to_dict
    • mmm
      • BaseMMM
        • BaseMMM.__init__
        • BaseMMM.attrs_to_init_kwargs
        • BaseMMM.build_from_idata
        • BaseMMM.build_model
        • BaseMMM.channel_contributions_forward_pass
        • BaseMMM.compute_channel_contribution_original_scale
        • BaseMMM.compute_mean_contributions_over_time
        • BaseMMM.create_fit_data
        • BaseMMM.create_idata_attrs
        • BaseMMM.fit
        • BaseMMM.forward_pass
        • BaseMMM.get_channel_contributions_share_samples
        • BaseMMM.get_errors
        • BaseMMM.get_target_transformer
        • BaseMMM.graphviz
        • BaseMMM.load
        • BaseMMM.load_from_idata
        • BaseMMM.plot_channel_contribution_share_hdi
        • BaseMMM.plot_components_contributions
        • BaseMMM.plot_errors
        • BaseMMM.plot_grouped_contribution_breakdown_over_time
        • BaseMMM.plot_posterior_predictive
        • BaseMMM.plot_prior_predictive
        • BaseMMM.plot_prior_vs_posterior
        • BaseMMM.plot_waterfall_components_decomposition
        • BaseMMM.post_sample_model_transformation
        • BaseMMM.predict
        • BaseMMM.predict_posterior
        • BaseMMM.predict_proba
        • BaseMMM.preprocess
        • BaseMMM.sample_posterior_predictive
        • BaseMMM.sample_prior_predictive
        • BaseMMM.save
        • BaseMMM.set_idata_attrs
        • BaseMMM.validate
        • BaseMMM.validate_channel_columns
        • BaseMMM.validate_date_col
        • BaseMMM.validate_target
      • MMM
        • MMM.__init__
        • MMM.add_lift_test_measurements
        • MMM.attrs_to_init_kwargs
        • MMM.build_from_idata
        • MMM.build_model
        • MMM.channel_contributions_forward_pass
        • MMM.compute_channel_contribution_original_scale
        • MMM.compute_mean_contributions_over_time
        • MMM.create_fit_data
        • MMM.create_idata_attrs
        • MMM.fit
        • MMM.format_recovered_transformation_parameters
        • MMM.forward_pass
        • MMM.get_channel_contributions_forward_pass_grid
        • MMM.get_channel_contributions_share_samples
        • MMM.get_errors
        • MMM.get_target_transformer
        • MMM.get_ts_contribution_posterior
        • MMM.graphviz
        • MMM.load
        • MMM.load_from_idata
        • MMM.max_abs_scale_channel_data
        • MMM.max_abs_scale_target_data
        • MMM.new_spend_contributions
        • MMM.optimize_budget
        • MMM.plot_allocated_contribution_by_channel
        • MMM.plot_budget_allocation
        • MMM.plot_channel_contribution_share_hdi
        • MMM.plot_channel_contributions_grid
        • MMM.plot_channel_parameter
        • MMM.plot_components_contributions
        • MMM.plot_direct_contribution_curves
        • MMM.plot_errors
        • MMM.plot_grouped_contribution_breakdown_over_time
        • MMM.plot_new_spend_contributions
        • MMM.plot_posterior_predictive
        • MMM.plot_prior_predictive
        • MMM.plot_prior_vs_posterior
        • MMM.plot_waterfall_components_decomposition
        • MMM.post_sample_model_transformation
        • MMM.predict
        • MMM.predict_posterior
        • MMM.predict_proba
        • MMM.preprocess
        • MMM.sample_posterior_predictive
        • MMM.sample_prior_predictive
        • MMM.sample_response_distribution
        • MMM.save
        • MMM.set_idata_attrs
        • MMM.validate
        • MMM.validate_channel_columns
        • MMM.validate_control_columns
        • MMM.validate_date_col
        • MMM.validate_target
    • multidimensional
      • create_sample_kwargs
      • MMM
        • MMM.__init__
        • MMM.add_events
        • MMM.add_original_scale_contribution_variable
        • MMM.attrs_to_init_kwargs
        • MMM.build_from_idata
        • MMM.build_model
        • MMM.create_fit_data
        • MMM.create_idata_attrs
        • MMM.fit
        • MMM.forward_pass
        • MMM.get_scales_as_xarray
        • MMM.graphviz
        • MMM.load
        • MMM.load_from_idata
        • MMM.post_sample_model_transformation
        • MMM.predict
        • MMM.predict_posterior
        • MMM.predict_proba
        • MMM.sample_posterior_predictive
        • MMM.sample_prior_predictive
        • MMM.save
        • MMM.set_idata_attrs
      • MultiDimensionalBudgetOptimizerWrapper
        • MultiDimensionalBudgetOptimizerWrapper.__init__
        • MultiDimensionalBudgetOptimizerWrapper.optimize_budget
        • MultiDimensionalBudgetOptimizerWrapper.sample_response_distribution
    • plot
      • MMMPlotSuite
        • MMMPlotSuite.__init__
        • MMMPlotSuite.allocated_contribution_by_channel_over_time
        • MMMPlotSuite.budget_allocation
        • MMMPlotSuite.contributions_over_time
        • MMMPlotSuite.posterior_predictive
        • MMMPlotSuite.saturation_curves_scatter
    • preprocessing
      • preprocessing_method_X
      • preprocessing_method_y
      • MaxAbsScaleChannels
        • MaxAbsScaleChannels.__init__
        • MaxAbsScaleChannels.max_abs_scale_channel_data
      • MaxAbsScaleTarget
        • MaxAbsScaleTarget.__init__
        • MaxAbsScaleTarget.max_abs_scale_target_data
      • StandardizeControls
        • StandardizeControls.__init__
        • StandardizeControls.standardize_control_data
    • scaling
      • Scaling
        • Scaling.__init__
        • Scaling.construct
        • Scaling.copy
        • Scaling.dict
        • Scaling.from_orm
        • Scaling.json
        • Scaling.model_construct
        • Scaling.model_copy
        • Scaling.model_dump
        • Scaling.model_dump_json
        • Scaling.model_json_schema
        • Scaling.model_parametrized_name
        • Scaling.model_post_init
        • Scaling.model_rebuild
        • Scaling.model_validate
        • Scaling.model_validate_json
        • Scaling.model_validate_strings
        • Scaling.parse_file
        • Scaling.parse_obj
        • Scaling.parse_raw
        • Scaling.schema
        • Scaling.schema_json
        • Scaling.update_forward_refs
        • Scaling.validate
      • VariableScaling
        • VariableScaling.__init__
        • VariableScaling.construct
        • VariableScaling.copy
        • VariableScaling.dict
        • VariableScaling.from_orm
        • VariableScaling.json
        • VariableScaling.model_construct
        • VariableScaling.model_copy
        • VariableScaling.model_dump
        • VariableScaling.model_dump_json
        • VariableScaling.model_json_schema
        • VariableScaling.model_parametrized_name
        • VariableScaling.model_post_init
        • VariableScaling.model_rebuild
        • VariableScaling.model_validate
        • VariableScaling.model_validate_json
        • VariableScaling.model_validate_strings
        • VariableScaling.parse_file
        • VariableScaling.parse_obj
        • VariableScaling.parse_raw
        • VariableScaling.schema
        • VariableScaling.schema_json
        • VariableScaling.update_forward_refs
        • VariableScaling.validate
    • transformers
      • batched_convolution
      • delayed_adstock
      • geometric_adstock
      • hill_function
      • hill_saturation_sigmoid
      • inverse_scaled_logistic_saturation
      • logistic_saturation
      • michaelis_menten
      • root_saturation
      • tanh_saturation
      • tanh_saturation_baselined
      • weibull_adstock
      • ConvMode
        • ConvMode.encode
        • ConvMode.replace
        • ConvMode.split
        • ConvMode.rsplit
        • ConvMode.join
        • ConvMode.capitalize
        • ConvMode.casefold
        • ConvMode.title
        • ConvMode.center
        • ConvMode.count
        • ConvMode.expandtabs
        • ConvMode.find
        • ConvMode.partition
        • ConvMode.index
        • ConvMode.ljust
        • ConvMode.lower
        • ConvMode.lstrip
        • ConvMode.rfind
        • ConvMode.rindex
        • ConvMode.rjust
        • ConvMode.rstrip
        • ConvMode.rpartition
        • ConvMode.splitlines
        • ConvMode.strip
        • ConvMode.swapcase
        • ConvMode.translate
        • ConvMode.upper
        • ConvMode.startswith
        • ConvMode.endswith
        • ConvMode.removeprefix
        • ConvMode.removesuffix
        • ConvMode.isascii
        • ConvMode.islower
        • ConvMode.isupper
        • ConvMode.istitle
        • ConvMode.isspace
        • ConvMode.isdecimal
        • ConvMode.isdigit
        • ConvMode.isnumeric
        • ConvMode.isalpha
        • ConvMode.isalnum
        • ConvMode.isidentifier
        • ConvMode.isprintable
        • ConvMode.zfill
        • ConvMode.format
        • ConvMode.format_map
        • ConvMode.maketrans
      • TanhSaturationBaselinedParameters
        • TanhSaturationBaselinedParameters.__init__
        • TanhSaturationBaselinedParameters.count
        • TanhSaturationBaselinedParameters.debaseline
        • TanhSaturationBaselinedParameters.index
        • TanhSaturationBaselinedParameters.rebaseline
      • TanhSaturationParameters
        • TanhSaturationParameters.__init__
        • TanhSaturationParameters.baseline
        • TanhSaturationParameters.count
        • TanhSaturationParameters.index
      • WeibullType
        • WeibullType.encode
        • WeibullType.replace
        • WeibullType.split
        • WeibullType.rsplit
        • WeibullType.join
        • WeibullType.capitalize
        • WeibullType.casefold
        • WeibullType.title
        • WeibullType.center
        • WeibullType.count
        • WeibullType.expandtabs
        • WeibullType.find
        • WeibullType.partition
        • WeibullType.index
        • WeibullType.ljust
        • WeibullType.lower
        • WeibullType.lstrip
        • WeibullType.rfind
        • WeibullType.rindex
        • WeibullType.rjust
        • WeibullType.rstrip
        • WeibullType.rpartition
        • WeibullType.splitlines
        • WeibullType.strip
        • WeibullType.swapcase
        • WeibullType.translate
        • WeibullType.upper
        • WeibullType.startswith
        • WeibullType.endswith
        • WeibullType.removeprefix
        • WeibullType.removesuffix
        • WeibullType.isascii
        • WeibullType.islower
        • WeibullType.isupper
        • WeibullType.istitle
        • WeibullType.isspace
        • WeibullType.isdecimal
        • WeibullType.isdigit
        • WeibullType.isnumeric
        • WeibullType.isalpha
        • WeibullType.isalnum
        • WeibullType.isidentifier
        • WeibullType.isprintable
        • WeibullType.zfill
        • WeibullType.format
        • WeibullType.format_map
        • WeibullType.maketrans
    • tvp
      • create_time_varying_gp_multiplier
      • infer_time_index
      • time_varying_prior
    • utility
      • adjusted_value_at_risk_score
      • average_response
      • conditional_value_at_risk
      • diversification_ratio
      • mean_tightness_score
      • portfolio_entropy
      • raroc
      • sharpe_ratio
      • tail_distance
      • value_at_risk
    • utils
      • add_noise_to_channel_allocation
      • apply_sklearn_transformer_across_dim
      • create_new_spend_data
      • create_zero_dataset
      • transform_1d_array
    • validating
      • validation_method_X
      • validation_method_y
      • ValidateChannelColumns
        • ValidateChannelColumns.__init__
        • ValidateChannelColumns.validate_channel_columns
      • ValidateControlColumns
        • ValidateControlColumns.__init__
        • ValidateControlColumns.validate_control_columns
      • ValidateDateColumn
        • ValidateDateColumn.__init__
        • ValidateDateColumn.validate_date_col
      • ValidateTargetColumn
        • ValidateTargetColumn.__init__
        • ValidateTargetColumn.validate_target
  • model_builder
    • create_idata_accessor
    • create_sample_kwargs
    • ModelBuilder
      • ModelBuilder.__init__
      • ModelBuilder.attrs_to_init_kwargs
      • ModelBuilder.build_from_idata
      • ModelBuilder.build_model
      • ModelBuilder.create_fit_data
      • ModelBuilder.create_idata_attrs
      • ModelBuilder.fit
      • ModelBuilder.graphviz
      • ModelBuilder.load
      • ModelBuilder.load_from_idata
      • ModelBuilder.post_sample_model_transformation
      • ModelBuilder.predict
      • ModelBuilder.predict_posterior
      • ModelBuilder.predict_proba
      • ModelBuilder.sample_posterior_predictive
      • ModelBuilder.sample_prior_predictive
      • ModelBuilder.save
      • ModelBuilder.set_idata_attrs
  • model_config
    • parse_model_config
  • model_graph
    • deterministics_to_flat
  • plot
    • create_legend_handles
    • drop_scalar_coords
    • generate_colors
    • get_plot_coords
    • get_total_coord_size
    • plot_curve
    • plot_hdi
    • plot_samples
    • random_samples
    • selections
    • set_subplot_kwargs_defaults
  • prior
    • create_dim_handler
    • handle_dims
    • register_tensor_transform
    • sample_prior
    • Censored
      • Censored.__init__
      • Censored.create_likelihood_variable
      • Censored.create_variable
      • Censored.from_dict
      • Censored.sample_prior
      • Censored.to_dict
      • Censored.to_graph
    • Prior
      • Prior.__init__
      • Prior.constrain
      • Prior.create_likelihood_variable
      • Prior.create_variable
      • Prior.deepcopy
      • Prior.from_dict
      • Prior.sample_prior
      • Prior.to_dict
      • Prior.to_graph
    • Scaled
      • Scaled.__init__
      • Scaled.create_variable
    • VariableFactory
      • VariableFactory.__init__
      • VariableFactory.create_variable
  • utils
    • from_netcdf
  • API
  • validating
  • ValidateChan...

ValidateChannelColumns#

class pymc_marketing.mmm.validating.ValidateChannelColumns[source]#

Validate the channel columns.

Methods

ValidateChannelColumns.__init__(*args, **kwargs)

ValidateChannelColumns.validate_channel_columns(data)

Validate the channel columns.

Attributes

channel_columns

On this page
  • ValidateChannelColumns
Show Source
Consulting and training

© Copyright 2022-2025, PyMC Labs.

  • Twitter
  • Github
  • LinkedIn
  • YouTube
  • Meetup
  • Contact