InvertibleTableTransformer

Bases: TableTransformer

A TableTransformer that can also undo the learned transformation after it has been applied.

Source code in src/safeds/data/tabular/transformation/_table_transformer.py

class InvertibleTableTransformer(TableTransformer):
    """A `TableTransformer` that can also undo the learned transformation after it has been applied."""

    @abstractmethod
    def fit(self, table: Table, column_names: list[str] | None) -> InvertibleTableTransformer:
        """
        Learn a transformation for a set of columns in a table.

        Parameters
        ----------
        table : Table
            The table used to fit the transformer.
        column_names : list[str] | None
            The list of columns from the table used to fit the transformer. If `None`, all columns are used.

        Returns
        -------
        fitted_transformer : InvertibleTableTransformer
            The fitted transformer.
        """

    @abstractmethod
    def inverse_transform(self, transformed_table: Table) -> Table:
        """
        Undo the learned transformation.

        The table is not modified.

        Parameters
        ----------
        transformed_table : Table
            The table to be transformed back to the original version.

        Returns
        -------
        table : Table
            The original table.

        Raises
        ------
        TransformerNotFittedError
            If the transformer has not been fitted yet.
        """

fit(table, column_names) abstractmethod

Learn a transformation for a set of columns in a table.

Parameters:

Name	Type	Description	Default
table	Table	The table used to fit the transformer.	required
column_names	list[str] | None	The list of columns from the table used to fit the transformer. If None, all columns are used.	required

Returns:

Name	Type	Description
fitted_transformer	InvertibleTableTransformer	The fitted transformer.

Source code in src/safeds/data/tabular/transformation/_table_transformer.py

@abstractmethod
def fit(self, table: Table, column_names: list[str] | None) -> InvertibleTableTransformer:
    """
    Learn a transformation for a set of columns in a table.

    Parameters
    ----------
    table : Table
        The table used to fit the transformer.
    column_names : list[str] | None
        The list of columns from the table used to fit the transformer. If `None`, all columns are used.

    Returns
    -------
    fitted_transformer : InvertibleTableTransformer
        The fitted transformer.
    """

inverse_transform(transformed_table) abstractmethod

Undo the learned transformation.

The table is not modified.

Parameters:

Name	Type	Description	Default
transformed_table	Table	The table to be transformed back to the original version.	required

Returns:

Name	Type	Description
table	Table	The original table.

Raises:

Type	Description
TransformerNotFittedError	If the transformer has not been fitted yet.

Source code in src/safeds/data/tabular/transformation/_table_transformer.py

@abstractmethod
def inverse_transform(self, transformed_table: Table) -> Table:
    """
    Undo the learned transformation.

    The table is not modified.

    Parameters
    ----------
    transformed_table : Table
        The table to be transformed back to the original version.

    Returns
    -------
    table : Table
        The original table.

    Raises
    ------
    TransformerNotFittedError
        If the transformer has not been fitted yet.
    """