ConsoleInterface Class

Class responsible for printing iteration information to console.

Initialize the object.

Constructor

ConsoleInterface(metric: str, console_writer: ConsoleWriter, mask_sampling: bool = False)

Parameters

Name	Description
metric Required	str representing which metric is being used to score the pipeline.
console_writer Required	file-like object to output to. If not provided, output will be discarded.
mask_sampling	bool decide whether the sample columns should be masked or not. Default value: False

Methods

print_columns	Print column headers for AutoML printing block.
print_descriptions	Print description of AutoML console output.
print_end	Print iteration status, metric, and running best metric.
print_error	Print an error message to the console.
print_guardrails	Print guardrail information if any exists. :return:
print_line	Print a message (and then a newline) on the console.
print_pipeline	Format a sklearn Pipeline string to be readable.
print_section_separator	Print the separator for different sections during training on the console.
print_start	Print iteration number.

print_columns

Print column headers for AutoML printing block.

print_columns() -> None

print_descriptions

Print description of AutoML console output.

print_descriptions() -> None

print_end

Print iteration status, metric, and running best metric.

print_end(duration: float | str = '', metric: float | str = '', best_metric: float | str | None = '') -> None

Parameters

Name	Description
duration Required	Status of the given iteration
metric Required	Score for this iteration
best_metric Required	Best score so far

print_error

Print an error message to the console.

print_error(message: BaseException | str) -> None

Parameters

Name	Description
message Required	Error message to display to user

print_guardrails

Print guardrail information if any exists. :return:

print_guardrails(faults: List[Any], include_parameters: bool = True, number_parameters_output: int = 9223372036854775807, schema_version: str | None = None) -> None

Parameters

Name	Description
faults Required
include_parameters	Default value: True
number_parameters_output	Default value: 9223372036854775807
schema_version	Default value: None

print_line

Print a message (and then a newline) on the console.

print_line(message: str) -> None

Parameters

Name	Description
message Required

print_pipeline

Format a sklearn Pipeline string to be readable.

print_pipeline(preprocessor: str | None = '', model_name: str | None = '', train_frac: str | float = 1) -> None

Parameters

Name	Description
preprocessor Required	string of preprocessor name
model_name Required	string of model name
train_frac	float of fraction of train data to use Default value: 1

print_section_separator

Print the separator for different sections during training on the console.

print_section_separator() -> None

print_start

Print iteration number.

print_start(iteration: int | str = '') -> None

Parameters

Name	Description
iteration Required