pdstools.ih.IH

Classes

IH

Module Contents

class IH(data: polars.LazyFrame)
Parameters:

data (polars.LazyFrame)

data: polars.LazyFrame
positive_outcome_labels: Dict[str, List[str]]
aggregates
plot
negative_outcome_labels
classmethod from_ds_export(ih_filename: os.PathLike | str, query: pdstools.utils.types.QUERY | None = None)

Create an IH instance from a file with Pega Dataset Export

Parameters:

  • ih_filename (Union[os.PathLike, str]) – The full path to the dataset files

  • query (Optional[QUERY], optional) – An optional argument to filter out selected data, by default None

Returns:

The properly initialized IH object

Return type:

IH

classmethod from_s3()

Not implemented yet. Please let us know if you would like this functionality!

classmethod from_mock_data(days=90, n=100000)

Initialize an IH instance with sample data

Parameters:

  • days (number of days, defaults to 90 days)

  • n (number of interaction data records, defaults to 100k)

Returns:

The properly initialized IH object

Return type:

IH