Skip to content

InvertibleTableTransformer

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

Parent type: TableTransformer

Inheritors:

Stub code in InvertibleTableTransformer.sdsstub

class InvertibleTableTransformer() sub TableTransformer {
    /**
     * Learn a transformation for a set of columns in a table.
     *
     * **Note:** This transformer is not modified.
     *
     * @param table The table used to fit the transformer.
     *
     * @result fittedTransformer The fitted transformer.
     */
    @Pure
    fun fit(
        table: Table
    ) -> fittedTransformer: InvertibleTableTransformer

    /**
     * Learn a transformation for a set of columns in a table and apply the learned transformation to the same table.
     *
     * **Note:** Neither this transformer nor the given table are modified.
     *
     * @param table The table used to fit the transformer. The transformer is then applied to this table.
     *
     * @result fittedTransformer The fitted transformer.
     * @result transformedTable The transformed table.
     */
    @Pure
    @PythonName("fit_and_transform")
    fun fitAndTransform(
        table: Table
    ) -> (fittedTransformer: InvertibleTableTransformer, transformedTable: Table)

    /**
     * Undo the learned transformation as well as possible.
     *
     * Column order and types may differ from the original table. Likewise, some values might not be restored.
     *
     * **Note:** The given table is not modified.
     *
     * @param transformedTable The table to be transformed back to the original version.
     *
     * @result originalTable The original table.
     */
    @Pure
    @PythonName("inverse_transform")
    fun inverseTransform(
        @PythonName("transformed_table") transformedTable: Table
    ) -> originalTable: Table
}

isFitted

Whether the transformer is fitted.

Type: Boolean

fit

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

Note: This transformer is not modified.

Parameters:

Name Type Description Default
table Table The table used to fit the transformer. -

Results:

Name Type Description
fittedTransformer InvertibleTableTransformer The fitted transformer.
Stub code in InvertibleTableTransformer.sdsstub

@Pure
fun fit(
    table: Table
) -> fittedTransformer: InvertibleTableTransformer

fitAndTransform

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

Note: Neither this transformer nor the given table are modified.

Parameters:

Name Type Description Default
table Table The table used to fit the transformer. The transformer is then applied to this table. -

Results:

Name Type Description
fittedTransformer InvertibleTableTransformer The fitted transformer.
transformedTable Table The transformed table.
Stub code in InvertibleTableTransformer.sdsstub

@Pure
@PythonName("fit_and_transform")
fun fitAndTransform(
    table: Table
) -> (fittedTransformer: InvertibleTableTransformer, transformedTable: Table)

inverseTransform

Undo the learned transformation as well as possible.

Column order and types may differ from the original table. Likewise, some values might not be restored.

Note: The given table is not modified.

Parameters:

Name Type Description Default
transformedTable Table The table to be transformed back to the original version. -

Results:

Name Type Description
originalTable Table The original table.
Stub code in InvertibleTableTransformer.sdsstub

@Pure
@PythonName("inverse_transform")
fun inverseTransform(
    @PythonName("transformed_table") transformedTable: Table
) -> originalTable: Table

transform

Apply the learned transformation to a table.

Note: The given table is not modified.

Parameters:

Name Type Description Default
table Table The table to which the learned transformation is applied. -

Results:

Name Type Description
transformedTable Table The transformed table.
Stub code in TableTransformer.sdsstub

@Pure
fun transform(
    table: Table
) -> transformedTable: Table