SOAPy_st.pl.show_proportion_in_tucker

SOAPy_st.pl.show_proportion_in_tucker(tensor: TensorDecomposition, module: list, figsize: tuple | None = None, factor_name: list | str | None = None, max_key: None | int | list = None, order: bool = True, show: bool = True, save: str | None = None, **kwargs)

Visualizes the proportion in a Tucker decomposition.

Parameters

tensorTensorDecomposition

The TensorDecomposition object containing the Tucker decomposition.

modulelist

List of modules to visualize.

figsizetuple, optional

Figure size.

factor_nameUnion[list, str, None], optional

The name of the factor to visualize.

max_keyUnion[None, int, list], optional

Maximum number of keys to show.

orderbool, optional

Whether to order the keys.

showbool, optional

Whether to display the figure.

savestr, optional

Filepath to save the figure.

**kwargsdict

Additional keyword arguments for seaborn.barplot.

Returns

None or list of Axes

If show is False, returns the list of Axes.