Skip to main content
Back to top
Ctrl
+
K
0.8.0
Guide
API
How-to
About PyMC Labs
Guide
API
How-to
About PyMC Labs
Section Navigation
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.do_constant_folding
BetaGeoBetaBinomRV.grad
BetaGeoBetaBinomRV.infer_shape
BetaGeoBetaBinomRV.make_node
BetaGeoBetaBinomRV.make_py_thunk
BetaGeoBetaBinomRV.make_thunk
BetaGeoBetaBinomRV.perform
BetaGeoBetaBinomRV.prepare_node
BetaGeoBetaBinomRV.rng_fn
ContContract
ContContract.__init__
ContContract.dist
ContContract.logp
ContContractRV
ContContractRV.L_op
ContContractRV.R_op
ContContractRV.__init__
ContContractRV.add_tag_trace
ContContractRV.batch_ndim
ContContractRV.do_constant_folding
ContContractRV.grad
ContContractRV.infer_shape
ContContractRV.make_node
ContContractRV.make_py_thunk
ContContractRV.make_thunk
ContContractRV.perform
ContContractRV.prepare_node
ContContractRV.rng_fn
ContNonContract
ContNonContract.__init__
ContNonContract.dist
ContNonContract.logp
ContNonContractRV
ContNonContractRV.L_op
ContNonContractRV.R_op
ContNonContractRV.__init__
ContNonContractRV.add_tag_trace
ContNonContractRV.batch_ndim
ContNonContractRV.do_constant_folding
ContNonContractRV.grad
ContNonContractRV.infer_shape
ContNonContractRV.make_node
ContNonContractRV.make_py_thunk
ContNonContractRV.make_thunk
ContNonContractRV.perform
ContNonContractRV.prepare_node
ContNonContractRV.rng_fn
ParetoNBD
ParetoNBD.__init__
ParetoNBD.dist
ParetoNBD.logp
ParetoNBDRV
ParetoNBDRV.L_op
ParetoNBDRV.R_op
ParetoNBDRV.__init__
ParetoNBDRV.add_tag_trace
ParetoNBDRV.batch_ndim
ParetoNBDRV.do_constant_folding
ParetoNBDRV.grad
ParetoNBDRV.infer_shape
ParetoNBDRV.make_node
ParetoNBDRV.make_py_thunk
ParetoNBDRV.make_thunk
ParetoNBDRV.perform
ParetoNBDRV.prepare_node
ParetoNBDRV.rng_fn
models
basic
CLVModel
beta_geo
BetaGeoModel
gamma_gamma
BaseGammaGammaModel
GammaGammaModel
GammaGammaModelIndividual
pareto_nbd
ParetoNBDModel
shifted_beta_geo
ShiftedBetaGeoModelIndividual
plotting
force_aspect
plot_customer_exposure
plot_frequency_recency_matrix
plot_probability_alive_matrix
utils
clv_summary
customer_lifetime_value
rfm_segments
rfm_summary
rfm_train_test_split
to_xarray
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
mmm
base
BaseValidateMMM
BaseValidateMMM.__init__
BaseValidateMMM.attrs_to_init_kwargs
BaseValidateMMM.build_model
BaseValidateMMM.compute_channel_contribution_original_scale
BaseValidateMMM.compute_mean_contributions_over_time
BaseValidateMMM.create_idata_attrs
BaseValidateMMM.fit
BaseValidateMMM.get_errors
BaseValidateMMM.get_params
BaseValidateMMM.get_target_transformer
BaseValidateMMM.graphviz
BaseValidateMMM.load
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_waterfall_components_decomposition
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.set_params
BaseValidateMMM.validate
BaseValidateMMM.validate_channel_columns
BaseValidateMMM.validate_date_col
BaseValidateMMM.validate_target
MMMModelBuilder
MMMModelBuilder.__init__
MMMModelBuilder.attrs_to_init_kwargs
MMMModelBuilder.build_model
MMMModelBuilder.compute_channel_contribution_original_scale
MMMModelBuilder.compute_mean_contributions_over_time
MMMModelBuilder.create_idata_attrs
MMMModelBuilder.fit
MMMModelBuilder.get_errors
MMMModelBuilder.get_params
MMMModelBuilder.get_target_transformer
MMMModelBuilder.graphviz
MMMModelBuilder.load
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_waterfall_components_decomposition
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.set_params
MMMModelBuilder.validate
budget_optimizer
BudgetOptimizer
BudgetOptimizer.__init__
BudgetOptimizer.allocate_budget
BudgetOptimizer.construct
BudgetOptimizer.copy
BudgetOptimizer.dict
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.objective
BudgetOptimizer.parse_file
BudgetOptimizer.parse_obj
BudgetOptimizer.parse_raw
BudgetOptimizer.schema
BudgetOptimizer.schema_json
BudgetOptimizer.update_forward_refs
BudgetOptimizer.validate
components
adstock
adstock_from_dict
register_adstock_transformation
AdstockTransformation
DelayedAdstock
GeometricAdstock
WeibullAdstock
WeibullCDFAdstock
WeibullPDFAdstock
base
Transformation
saturation
register_saturation_transformation
saturation_from_dict
HillSaturation
InverseScaledLogisticSaturation
LogisticSaturation
MichaelisMentenSaturation
RootSaturation
SaturationTransformation
TanhSaturation
TanhSaturationBaselined
delayed_saturated_mmm
BaseMMM
BaseMMM.__init__
BaseMMM.attrs_to_init_kwargs
BaseMMM.build_model
BaseMMM.channel_contributions_forward_pass
BaseMMM.compute_channel_contribution_original_scale
BaseMMM.compute_mean_contributions_over_time
BaseMMM.create_idata_attrs
BaseMMM.fit
BaseMMM.forward_pass
BaseMMM.get_errors
BaseMMM.get_params
BaseMMM.get_target_transformer
BaseMMM.graphviz
BaseMMM.load
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_waterfall_components_decomposition
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.set_params
BaseMMM.validate
BaseMMM.validate_channel_columns
BaseMMM.validate_date_col
BaseMMM.validate_target
DelayedSaturatedMMM
DelayedSaturatedMMM.__init__
DelayedSaturatedMMM.add_lift_test_measurements
DelayedSaturatedMMM.allocate_budget_to_maximize_response
DelayedSaturatedMMM.attrs_to_init_kwargs
DelayedSaturatedMMM.build_model
DelayedSaturatedMMM.channel_contributions_forward_pass
DelayedSaturatedMMM.compute_channel_contribution_original_scale
DelayedSaturatedMMM.compute_mean_contributions_over_time
DelayedSaturatedMMM.create_idata_attrs
DelayedSaturatedMMM.fit
DelayedSaturatedMMM.format_recovered_transformation_parameters
DelayedSaturatedMMM.forward_pass
DelayedSaturatedMMM.get_channel_contributions_forward_pass_grid
DelayedSaturatedMMM.get_errors
DelayedSaturatedMMM.get_params
DelayedSaturatedMMM.get_target_transformer
DelayedSaturatedMMM.get_ts_contribution_posterior
DelayedSaturatedMMM.graphviz
DelayedSaturatedMMM.load
DelayedSaturatedMMM.max_abs_scale_channel_data
DelayedSaturatedMMM.max_abs_scale_target_data
DelayedSaturatedMMM.new_spend_contributions
DelayedSaturatedMMM.plot_allocated_contribution_by_channel
DelayedSaturatedMMM.plot_budget_allocation
DelayedSaturatedMMM.plot_channel_contribution_share_hdi
DelayedSaturatedMMM.plot_channel_contributions_grid
DelayedSaturatedMMM.plot_channel_parameter
DelayedSaturatedMMM.plot_components_contributions
DelayedSaturatedMMM.plot_direct_contribution_curves
DelayedSaturatedMMM.plot_errors
DelayedSaturatedMMM.plot_grouped_contribution_breakdown_over_time
DelayedSaturatedMMM.plot_new_spend_contributions
DelayedSaturatedMMM.plot_posterior_predictive
DelayedSaturatedMMM.plot_prior_predictive
DelayedSaturatedMMM.plot_waterfall_components_decomposition
DelayedSaturatedMMM.predict
DelayedSaturatedMMM.predict_posterior
DelayedSaturatedMMM.predict_proba
DelayedSaturatedMMM.preprocess
DelayedSaturatedMMM.sample_posterior_predictive
DelayedSaturatedMMM.sample_prior_predictive
DelayedSaturatedMMM.save
DelayedSaturatedMMM.set_idata_attrs
DelayedSaturatedMMM.set_params
DelayedSaturatedMMM.validate
DelayedSaturatedMMM.validate_channel_columns
DelayedSaturatedMMM.validate_control_columns
DelayedSaturatedMMM.validate_date_col
DelayedSaturatedMMM.validate_target
MMM
MMM.__init__
MMM.add_lift_test_measurements
MMM.allocate_budget_to_maximize_response
MMM.attrs_to_init_kwargs
MMM.build_model
MMM.channel_contributions_forward_pass
MMM.compute_channel_contribution_original_scale
MMM.compute_mean_contributions_over_time
MMM.create_idata_attrs
MMM.fit
MMM.format_recovered_transformation_parameters
MMM.forward_pass
MMM.get_channel_contributions_forward_pass_grid
MMM.get_errors
MMM.get_params
MMM.get_target_transformer
MMM.get_ts_contribution_posterior
MMM.graphviz
MMM.load
MMM.max_abs_scale_channel_data
MMM.max_abs_scale_target_data
MMM.new_spend_contributions
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_waterfall_components_decomposition
MMM.predict
MMM.predict_posterior
MMM.predict_proba
MMM.preprocess
MMM.sample_posterior_predictive
MMM.sample_prior_predictive
MMM.save
MMM.set_idata_attrs
MMM.set_params
MMM.validate
MMM.validate_channel_columns
MMM.validate_control_columns
MMM.validate_date_col
MMM.validate_target
fourier
generate_fourier_modes
FourierBase
FourierBase.__init__
FourierBase.apply
FourierBase.construct
FourierBase.copy
FourierBase.dict
FourierBase.from_orm
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.update_forward_refs
FourierBase.validate
MonthlyFourier
MonthlyFourier.__init__
MonthlyFourier.apply
MonthlyFourier.construct
MonthlyFourier.copy
MonthlyFourier.dict
MonthlyFourier.from_orm
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.update_forward_refs
MonthlyFourier.validate
YearlyFourier
YearlyFourier.__init__
YearlyFourier.apply
YearlyFourier.construct
YearlyFourier.copy
YearlyFourier.dict
YearlyFourier.from_orm
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.update_forward_refs
YearlyFourier.validate
lift_test
add_lift_measurements_to_likelihood
add_lift_measurements_to_likelihood_from_saturation
calculate_lift_measurements_from_curve
check_increasing_assumption
create_time_varying_saturation
index_variable
indices_from_lift_tests
lift_test_indices
required_dims_from_named_vars_to_dims
scale_channel_lift_measurements
scale_lift_measurements
scale_target_for_lift_measurements
plot
get_plot_coords
get_total_coord_size
plot_curve
plot_hdi
plot_samples
random_samples
selections
set_subplot_kwargs_defaults
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
transformers
batched_convolution
delayed_adstock
geometric_adstock
hill_saturation
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
utils
apply_sklearn_transformer_across_dim
compute_sigmoid_second_derivative
create_new_spend_data
drop_scalar_coords
estimate_menten_parameters
estimate_sigmoid_parameters
find_sigmoid_inflection_point
sigmoid_saturation
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_config
parse_model_config
model_builder
ModelBuilder
ModelBuilder.__init__
ModelBuilder.attrs_to_init_kwargs
ModelBuilder.build_model
ModelBuilder.create_idata_attrs
ModelBuilder.fit
ModelBuilder.get_params
ModelBuilder.load
ModelBuilder.predict
ModelBuilder.predict_posterior
ModelBuilder.predict_proba
ModelBuilder.sample_posterior_predictive
ModelBuilder.sample_prior_predictive
ModelBuilder.save
ModelBuilder.set_idata_attrs
ModelBuilder.set_params
prior
create_dim_handler
handle_dims
Prior
Prior.__init__
Prior.constrain
Prior.create_likelihood_variable
Prior.create_variable
Prior.deepcopy
Prior.from_json
Prior.sample_prior
Prior.to_graph
Prior.to_json
API
TanhSaturation
TanhSaturati...
TanhSaturation.function
#
TanhSaturation.
function
(
x
,
b
,
c
,
beta
)
[source]
#
On this page
TanhSaturation.function()
Show Source
Consulting and training
