ProtectedInput

from tmlt.tune import ProtectedInput

class tmlt.tune.ProtectedInput(name, dataframe, protected_change)

Bases: NamedTuple

A protected input that was used for an ErrorReport.

Warning

Note that normally ProtectedInputs are treated as sensitive and would not accessible to the user except through the Session API to avoid violating differential privacy. But these error reports are not differentially private, and for this reason it is highly recommended to avoid using sensitive data in error reports, and to instead use synthetic data or other non-sensitive data.

For these reasons, the protected inputs used in error reports are attached to the outputs for your convenience, but it is ultimately your responsibility to ensure that truly sensitive data is not used inappropriately.

name: str

The name of the input.

dataframe: DataFrame

A DataFrame containing the protected data used for the report.

protected_change: ProtectedChange

What changes to the protected data the Session should protect.