parq_blockmodel.reporting.report.BlockModelReport

class parq_blockmodel.reporting.report.BlockModelReport(report, output_path, columns, columns_per_batch, memory_budget_bytes=None)

Thin wrapper around parq_tools.ParquetProfileReport.

The wrapper keeps track of the default output path used by parq_blockmodel.blockmodel.ParquetBlockModel.create_report() and exposes a convenient save() alias that writes HTML via save_html.

__init__(report, output_path, columns, columns_per_batch, memory_budget_bytes=None)

Methods

__init__(report, output_path, columns, ...)
save([output_path])	Save the rendered report HTML and return the resolved path.
save_html(output_path)	Compatibility wrapper mirroring the underlying report API.
show([notebook])	Display the rendered report.
to_html()	Return the rendered report as HTML.

Attributes

raw_report

Access the underlying parq_tools.ParquetProfileReport.

property raw_report: ParquetProfileReport

Access the underlying parq_tools.ParquetProfileReport.

save(output_path=None)

Save the rendered report HTML and return the resolved path.

Return type:

Path

save_html(output_path)

Compatibility wrapper mirroring the underlying report API.

Return type:

Path

show(notebook=False)

Display the rendered report.

to_html()

Return the rendered report as HTML.

Return type:

str