Danger

You are looking at the documentation for an older version of the SDV! We are no longer supporting or maintaining this version of the software

Click here to go to the new docs pages.

sdv.metadata.table.Table

class sdv.metadata.table.Table(name=None, field_names=None, field_types=None, field_transformers=None, anonymize_fields=None, primary_key=None, constraints=None, dtype_transformers=None, model_kwargs=None, sequence_index=None, entity_columns=None, context_columns=None, learn_rounding_scheme=True, enforce_min_max_values=True)[source]

Table Metadata.

The Metadata class provides a unified layer of abstraction over the metadata of a single Table, which includes all the necessary details to handle the table of this data, including the data types, the fields with pii information and the constraints that affect this data.

Parameters

  • name (str) – Name of this table. Optional.

  • field_names (list[str]) – List of names of the fields that need to be modeled and included in the generated output data. Any additional fields found in the data will be ignored and will not be included in the generated output. If None, all the fields found in the data are used.

  • field_types (dict[str, dict]) – Dictinary specifying the data types and subtypes of the fields that will be modeled. Field types and subtypes combinations must be compatible with the SDV Metadata Schema.

  • field_transformers (dict[str, str]) –

    Dictinary specifying which transformers to use for each field. Available transformers are:

    • FloatFormatter: Uses a FloatFormatter for numerical data.

    • FrequencyEncoder: Uses a FrequencyEncoder without gaussian noise.

    • FrequencyEncoder_noised: Uses a FrequencyEncoder adding gaussian noise.

    • OneHotEncoder: Uses a OneHotEncoder.

    • LabelEncoder: Uses a LabelEncoder.

    • BinaryEncoder: Uses a BinaryEncoder.

    • UnixTimestampEncoder: Uses a UnixTimestampEncoder.

  • anonymize_fields (dict[str, str]) – Dict specifying which fields to anonymize and what faker category they belong to.

  • primary_key (str) – Name of the field which is the primary key of the table.

  • constraints (list[Constraint, dict]) – List of Constraint objects or dicts.

  • dtype_transformers (dict) – Dictionary of transformer templates to be used for the different data types. The keys must be any of the dtype.kind values, i, f, O, b or M, and the values must be either RDT Transformer classes or RDT Transformer instances.

  • model_kwargs (dict) – Dictionary specifiying the kwargs that need to be used in each tabular model when working on this table. This dictionary contains as keys the name of the TabularModel class and as values a dictionary containing the keyword arguments to use. This argument exists mostly to ensure that the models are fitted using the same arguments when the same Table is used to fit different model instances on different slices of the same table.

  • sequence_index (str) – Name of the column that acts as the order index of each sequence. The sequence index column can be of any type that can be sorted, such as integer values or datetimes.

  • entity_columns (list[str]) – Names of the columns which identify different time series sequences. These will be used to group the data in separated training examples.

  • context_columns (list[str]) – The columns in the dataframe which are constant within each group/entity. These columns will be provided at sampling time (i.e. the samples will be conditioned on the context variables).

  • learn_rounding_scheme (bool) – Define rounding scheme for FloatFormatter. If True, the data returned by reverse_transform will be rounded to that place. Defaults to True.

  • enforce_min_max_values (bool) – Specify whether or not to clip the data returned by reverse_transform of the numerical transformer, FloatFormatter, to the min and max values seen during fit. Defaults to True.

__init__(name=None, field_names=None, field_types=None, field_transformers=None, anonymize_fields=None, primary_key=None, constraints=None, dtype_transformers=None, model_kwargs=None, sequence_index=None, entity_columns=None, context_columns=None, learn_rounding_scheme=True, enforce_min_max_values=True)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([name, field_names, field_types, …])

Initialize self.

filter_valid(data)

Filter the data using the constraints and return only the valid rows.

fit(data)

Fit this metadata to the given data.

from_dict(metadata_dict[, dtype_transformers])

Load a Table from a metadata dict.

from_json(path)

Load a Table from a JSON.

get_dtypes([ids])

Get a dict with the dtypes for each field of the table.

get_fields()

Get fields metadata.

get_model_kwargs(model_name)

Return the required model kwargs for the indicated model.

make_ids_unique(data)

Repopulate any id fields in provided data to guarantee uniqueness.

reverse_transform(data)

Reverse the transformed data to the original format.

set_model_kwargs(model_name, model_kwargs)

Set the model kwargs used for the indicated model.

set_primary_key(primary_key)

Set the primary key of this table.

to_dict()

Get a dict representation of this metadata.

to_json(path)

Dump this metadata into a JSON file.

transform(data[, is_condition])

Transform the given data.

Attributes

fitted

sdv.metadata.table sdv.metadata.table.Table.from_dict