biofefi.components package

Subpackages

Submodules

biofefi.components.configuration module

biofefi.components.configuration.execution_options_box_auto()

The execution options box for when the user wants to use automatic hyper-parameter search.

biofefi.components.configuration.execution_options_box_manual()

The execution options box for when the user wants to manually set the hyper-parameters for their models.

biofefi.components.configuration.plot_options_box()

Expander containing the options for making plots

biofefi.components.experiments module

biofefi.components.experiments.data_selector(options: list) → Path

Select a model or models to explain. This function creates a multiselect widget to allow the user to select multiple models to explain using the FI pipeline.

Parameters:

options (list) – The list of model names to choose from.

Returns:

The path to the model on disk.

Return type:

Path

biofefi.components.experiments.experiment_selector(options: list) → str

Select

Parameters:

options (list) – The list of experiment names to choose from.

Returns:

The name of the experiment on disk.

Return type:

str

biofefi.components.experiments.model_selector(options: list) → Path

Select a model or models to explain. This function creates a multiselect widget to allow the user to select multiple models to explain using the FI pipeline.

Parameters:

options (list) – The list of model names to choose from.

Returns:

The path to the model on disk.

Return type:

Path

biofefi.components.forms module

biofefi.components.forms.correlation_heatmap_form(data, data_analysis_plot_dir, plot_opts)

Form to create the correlation heatmap plot.

biofefi.components.forms.fi_options_form()
biofefi.components.forms.ml_options_form(use_hyperparam_search: bool)

The form for setting up the machine learning pipeline.

Parameters:

use_hyperparam_search (bool) – Is the user using hyper-parameter search?

biofefi.components.forms.pairplot_form(data, data_analysis_plot_dir, plot_opts)

Form to create the pairplot plot.

biofefi.components.forms.preprocessing_opts_form(data: DataFrame)
biofefi.components.forms.tSNE_plot_form(data, random_state, data_analysis_plot_dir, plot_opts, scaler: Normalisations = None)
biofefi.components.forms.target_variable_dist_form(data, dep_var_name, data_analysis_plot_dir, plot_opts)

Form to create the target variable distribution plot.

biofefi.components.logs module

biofefi.components.logs.log_box(box_title: str, key: Literal[MachineLearningStateKeys.MLLogBox, FeatureImportanceStateKeys.FILogBox, FuzzyStateKeys.FuzzyLogBox])

Display a text area which shows that logs of the current pipeline run.

biofefi.components.plots module

biofefi.components.plots.display_metrics_table(metrics_path: Path)

Display a metrics summary table in a Streamlit app.

Parameters:

metrics_path (Path) – The path to the metrics file.

biofefi.components.plots.plot_box(plot_dir: Path, box_title: str)

Display the plots in the given directory in the UI.

Parameters:

  • plot_dir (Path) – The directory containing the plots.

  • box_title (str) – The title of the plot box.

biofefi.components.preprocessing module

biofefi.components.preprocessing.original_view(data: DataFrame)

Display the original data to the user.

Parameters:

data (pd.DataFrame) – The original data to show.

biofefi.components.preprocessing.preprocessed_view(data: DataFrame)

Display the preprocessed data to the user.

Parameters:

data (pd.DataFrame) – The preprocessed data to show.

Module contents