_error_report#

Error Report output types.

Classes#

`ProtectedInput`	A protected input that was used for an `ErrorReport`.
`UnprotectedInput`	An unprotected input that was used for an `ErrorReport`.
`ErrorReport`	Output of a single error report run.
`MultiErrorReport`	Output of an error report run across multiple input combinations.

class ProtectedInput#

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 :pyspark.sql.DataFrame#: A dataframe containing the protected data used for the report.

protected_change :tmlt.analytics.protected_change.ProtectedChange#: What changes to the protected data the Session should protect.

class UnprotectedInput#

Bases: NamedTuple

An unprotected input that was used for an ErrorReport.

name :str#: The name of the input.

dataframe :pyspark.sql.DataFrame#: A dataframe containing the unprotected data used for the report.

class ErrorReport#

Output of a single error report run.

Note

This is only available on a paid version of Tumult Analytics. If you would like to hear more, please contact us at info@tmlt.io.

This class is not intended to be constructed directly. Instead, it is returned by the error_report() method.

tunable_values :Dict[str, Any]#: The values of the tunable parameters used for this error report.

parameters :Dict[str, Any]#: The non-tunable parameters used for this error report.

protected_inputs :Dict[str, ProtectedInput]#: The protected inputs used for this error report.

unprotected_inputs :Dict[str, UnprotectedInput]#: The unprotected inputs used for this error report.

privacy_budget :tmlt.analytics.privacy_budget.PrivacyBudget#: The privacy budget used for this error report.

dp_outputs :Dict[str, pyspark.sql.DataFrame]#: The differentially private outputs of the program.

baseline_outputs :Dict[str, Dict[str, pyspark.sql.DataFrame]]#: The outputs of the baseline program.

metrics :List[tmlt.analytics.metrics._base.MetricOutput]#: The metrics computed on the outputs of the dp and baseline programs.

format()#: Return a string representation of this object.

show()#: Prints the error report in a nicely-formatted, human-readable way.

class MultiErrorReport(reports)#

Output of an error report run across multiple input combinations.

Note

This is only available on a paid version of Tumult Analytics. If you would like to hear more, please contact us at info@tmlt.io.

This class is not intended to be constructed directly. Instead, it is returned by the multi_error_report() method.

Parameters: reports (List[ErrorReport]) –

__init__(reports)#

Constructor.

Warning

This class is not intended to be constructed directly. Instead, it is returned by the multi_error_report() method.

Parameters: reports (List[ErrorReport]List[ErrorReport]) – An error report for each run.

property reports#

Return the error reports.

Return type: List[ErrorReport]

__iter__()#

Return an iterator over the error reports.

Return type: Iterator[ErrorReport]

to_dataframe()#

Return a dataframe representation of the error reports.

The dataframe will have a row for each error report (run) and a column for each tunable and metric.

Return type: pandas.DataFrame

Tumult Analytics Pro

_error_report#

Classes#