Quality Report

class gretel_client.evaluation.quality_report.QualityReport(*, project: Optional[Project] = None, data_source: Union[Path, str, pd.DataFrame], ref_data: Union[Path, str, pd.DataFrame], output_dir: Optional[Union[str, Path]] = None, runner_mode: Optional[RunnerMode] = <RunnerMode.CLOUD: 'cloud'>)

Represents a Quality Report. This class can be used to create a report.

Parameters
  • project – Project associated with the report.

  • data_source – Data source used for the report.

  • ref_data – Reference data used for the report.

  • output_dir – Directory path to write the report to. If the directory does not exist, the path will be created for you.

  • runner_mode – Determines where to run the model. See gretel_client.config.RunnerMode for a list of valid modes. Manual mode is not explicitly supported.

property as_dict

Returns a dictionary representation of the report.

property as_html

Returns a HTML representation of the report.

peek() → Dict[str, Any]

Returns a dictionary representation of the top level report scores.