Skip to content

TableTransformer

Bases: ABC

Learn a transformation for a set of columns in a Table and transform another Table with the same columns.

Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
class TableTransformer(ABC):
    """Learn a transformation for a set of columns in a `Table` and transform another `Table` with the same columns."""

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

        This transformer is not modified.

        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 : TableTransformer
            The fitted transformer.
        """

    @abstractmethod
    def transform(self, table: Table) -> Table:
        """
        Apply the learned transformation to a table.

        The table is not modified.

        Parameters
        ----------
        table : Table
            The table to which the learned transformation is applied.

        Returns
        -------
        transformed_table : Table
            The transformed table.

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

    @abstractmethod
    def get_names_of_added_columns(self) -> list[str]:
        """
        Get the names of all new columns that have been added by the transformer.

        Returns
        -------
        added_columns : list[str]
            A list of names of the added columns, ordered as they will appear in the table.

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

    @abstractmethod
    def get_names_of_changed_columns(self) -> list[str]:
        """
         Get the names of all columns that have been changed by the transformer.

        Returns
        -------
        changed_columns : list[str]
             A list of names of changed columns, ordered as they appear in the table.

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

    @abstractmethod
    def get_names_of_removed_columns(self) -> list[str]:
        """
        Get the names of all columns that have been removed by the transformer.

        Returns
        -------
        removed_columns : list[str]
            A list of names of the removed columns, ordered as they appear in the table the transformer was fitted on.

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

    @abstractmethod
    def is_fitted(self) -> bool:
        """
        Check if the transformer is fitted.

        Returns
        -------
        is_fitted : bool
            Whether the transformer is fitted.
        """

    def fit_and_transform(self, table: Table, column_names: list[str] | None = None) -> Table:
        """
        Learn a transformation for a set of columns in a table and apply the learned transformation to the same table.

        The table is not modified. If you also need the fitted transformer, use `fit` and `transform` separately.

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

        Returns
        -------
        transformed_table : Table
            The transformed table.
        """
        return self.fit(table, column_names).transform(table)

fit(table, column_names) abstractmethod

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

This transformer is not modified.

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 TableTransformer

The fitted transformer.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@abstractmethod
def fit(self, table: Table, column_names: list[str] | None) -> TableTransformer:
    """
    Learn a transformation for a set of columns in a table.

    This transformer is not modified.

    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 : TableTransformer
        The fitted transformer.
    """

fit_and_transform(table, column_names=None)

Learn a transformation for a set of columns in a table and apply the learned transformation to the same table.

The table is not modified. If you also need the fitted transformer, use fit and transform separately.

Parameters:

Name Type Description Default
table Table

The table used to fit the transformer. The transformer is then applied to this table.

 required
column_names list[str] | None

The list of columns from the table used to fit the transformer. If None, all columns are used.

 None

Returns:

Name Type Description
transformed_table Table

The transformed table.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def fit_and_transform(self, table: Table, column_names: list[str] | None = None) -> Table:
    """
    Learn a transformation for a set of columns in a table and apply the learned transformation to the same table.

    The table is not modified. If you also need the fitted transformer, use `fit` and `transform` separately.

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

    Returns
    -------
    transformed_table : Table
        The transformed table.
    """
    return self.fit(table, column_names).transform(table)

get_names_of_added_columns() abstractmethod

Get the names of all new columns that have been added by the transformer.

Returns:

Name Type Description
added_columns list[str]

A list of names of the added columns, ordered as they will appear in the table.

Raises:

Type Description
TransformerNotFittedError

If the transformer has not been fitted yet.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@abstractmethod
def get_names_of_added_columns(self) -> list[str]:
    """
    Get the names of all new columns that have been added by the transformer.

    Returns
    -------
    added_columns : list[str]
        A list of names of the added columns, ordered as they will appear in the table.

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

get_names_of_changed_columns() abstractmethod

Get the names of all columns that have been changed by the transformer.

Returns:

Name Type Description
changed_columns list[str]

A list of names of changed columns, ordered as they appear in the table.

Raises:

Type Description
TransformerNotFittedError

If the transformer has not been fitted yet.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
@abstractmethod
def get_names_of_changed_columns(self) -> list[str]:
    """
     Get the names of all columns that have been changed by the transformer.

    Returns
    -------
    changed_columns : list[str]
         A list of names of changed columns, ordered as they appear in the table.

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

get_names_of_removed_columns() abstractmethod

Get the names of all columns that have been removed by the transformer.

Returns:

Name Type Description
removed_columns list[str]

A list of names of the removed columns, ordered as they appear in the table the transformer was fitted on.

Raises:

Type Description
TransformerNotFittedError

If the transformer has not been fitted yet.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
@abstractmethod
def get_names_of_removed_columns(self) -> list[str]:
    """
    Get the names of all columns that have been removed by the transformer.

    Returns
    -------
    removed_columns : list[str]
        A list of names of the removed columns, ordered as they appear in the table the transformer was fitted on.

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

is_fitted() abstractmethod

Check if the transformer is fitted.

Returns:

Name Type Description
is_fitted bool

Whether the transformer is fitted.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
104
105
106
107
108
109
110
111
112
113
@abstractmethod
def is_fitted(self) -> bool:
    """
    Check if the transformer is fitted.

    Returns
    -------
    is_fitted : bool
        Whether the transformer is fitted.
    """

transform(table) abstractmethod

Apply the learned transformation to a table.

The table is not modified.

Parameters:

Name Type Description Default
table Table

The table to which the learned transformation is applied.

 required

Returns:

Name Type Description
transformed_table Table

The transformed table.

Raises:

Type Description
TransformerNotFittedError

If the transformer has not been fitted yet.
Source code in src/safeds/data/tabular/transformation/_table_transformer.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@abstractmethod
def transform(self, table: Table) -> Table:
    """
    Apply the learned transformation to a table.

    The table is not modified.

    Parameters
    ----------
    table : Table
        The table to which the learned transformation is applied.

    Returns
    -------
    transformed_table : Table
        The transformed table.

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