auto_prep.raporting package

Submodules

auto_prep.raporting.eda module

class auto_prep.raporting.eda.EdaRaport[source]

Bases: object

run(X: DataFrame, y: Series, task: str)[source]

Performs dataset EDA analysis based on the given task (classification or regression).

visualizers: list = [<class 'auto_prep.visualization.eda.EdaVisualizer'>, <class 'auto_prep.visualization.categorical.CategoricalVisualizer'>, <class 'auto_prep.visualization.numerical.NumericalVisualizer'>]
write_to_raport(raport: Raport)[source]

Writes eda section to a raport

auto_prep.raporting.overview module

class auto_prep.raporting.overview.OverviewRaport[source]

Bases: object

run(X: DataFrame, y: Series, task: str)[source]

Performs dataset overview.

write_to_raport(raport: Raport)[source]

Writes overview section to a raport

auto_prep.raporting.raport module

class auto_prep.raporting.raport.Raport(*args, **kwargs)[source]

Bases: object

Generates LaTeX reports with analysis results and visualizations.

add_figure(path: str, caption: str | None = None, size: int = 0.9, label: str | None = None) → None[source]

Add a figure to the document.

Parameters:

  • path (str) – Path to the figure file.

  • caption (str) – Figure caption. If None, no caption will be set.

  • size (int) – % of width image is to take. Defaults to 0.9.

add_header() → None[source]

Adds the title page and table of contents to the LaTeX document.

add_list(items: list, caption: str | None = None) → None[source]

Adds a bullet-point list to the document.

Parameters:

  • items (list) – List of items to include in the bullet-point list.

  • caption (str, optional) – Optional caption or description above the list.

add_reference(label: str, prefix: str = 'Table', add_space: bool = True) → None[source]

Adds a reference to a labeled element in the document.

Parameters:

  • label (str) – The label of the element to reference.

  • prefix (str) – Text to prepend before the reference. Defaults to “Table”.

  • add_space (bool) – If True, adds a space after the reference. Defaults to True.

add_section(title: str, description: str = '') → Section[source]

Adds a new section to the LaTeX document.

Parameters:

  • title (str) – The title of the section.

  • description (str, optional) – The description of the section. Defaults to “”.

Returns:

The newly created section.

Return type:

Section

add_subsection(title: str) → Subsection[source]

Adds a new subsection to the LaTeX document.

Parameters:

title (str) – The title of the subsection.

Returns:

The newly created subsection.

Return type:

Subsection

add_table(data: dict | list, caption: str | None = None, header: List[dict] = ['Category', 'Value'], widths: list | None = None, label: str | None = None) → None[source]

Add a table to the document with wrapped text, dividing columns equally across an A4 page.

Parameters:

  • data (dict | list) – Data to convert to table.

  • caption (str) – Table caption. If None, no caption will be set.

  • header (List[dict]) – Table header. Defaults to [“Category”, “Value”]. If None, no header will be set.

  • widths (list)

add_text(text: str) → None[source]

Adds plain text to the LaTeX document. Args: text (str): The text to add to the document.

add_verbatim(content: str) → str[source]

Add verbatim text to the document.

Parameters:

content (str) – Text to add in verbatim environment.

Returns:

Formatted text.

Return type:

str

generate() → None[source]

Generate the final PDF report.

Parameters:

output_path (str) – Path where to save the PDF.

Module contents