MMMYamlConfig#

class pymc_marketing.mmm.builders.schema.MMMYamlConfig(**data)[source]#

Schema for the top-level MMM YAML configuration.

Methods

MMMYamlConfig.__init__(**data)

Create a new model by parsing and validating input data from keyword arguments.

MMMYamlConfig.construct([_fields_set])

MMMYamlConfig.copy(*[, include, exclude, ...])

Returns a copy of the model.

MMMYamlConfig.dict(*[, include, exclude, ...])

MMMYamlConfig.from_orm(obj)

MMMYamlConfig.from_yaml_file(path)

Load and validate a YAML configuration file.

MMMYamlConfig.json(*[, include, exclude, ...])

MMMYamlConfig.model_construct([_fields_set])

Creates a new instance of the Model class with validated data.

MMMYamlConfig.model_copy(*[, update, deep])

!!! abstract "Usage Documentation"

MMMYamlConfig.model_dump(*[, mode, include, ...])

!!! abstract "Usage Documentation"

MMMYamlConfig.model_dump_json(*[, indent, ...])

!!! abstract "Usage Documentation"

MMMYamlConfig.model_json_schema([by_alias, ...])

Generates a JSON schema for a model class.

MMMYamlConfig.model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

MMMYamlConfig.model_post_init(context, /)

Override this method to perform additional initialization after __init__ and model_construct.

MMMYamlConfig.model_rebuild(*[, force, ...])

Try to rebuild the pydantic-core schema for the model.

MMMYamlConfig.model_validate(obj, *[, ...])

Validate a pydantic model instance.

MMMYamlConfig.model_validate_json(json_data, *)

!!! abstract "Usage Documentation"

MMMYamlConfig.model_validate_strings(obj, *)

Validate the given object with string data against the Pydantic model.

MMMYamlConfig.parse_file(path, *[, ...])

MMMYamlConfig.parse_obj(obj)

MMMYamlConfig.parse_raw(b, *[, ...])

MMMYamlConfig.schema([by_alias, ref_template])

MMMYamlConfig.schema_json(*[, by_alias, ...])

MMMYamlConfig.update_forward_refs(**localns)

MMMYamlConfig.validate(value)

Attributes

model_computed_fields

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra

Get extra fields set during validation.

model_fields

model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

model

data

effects

original_scale_vars

calibration

idata_path