Skip to main content

Udf

Udf

The Udf class is the object you get when defining a UDF with the @fused.udf decorator, or when loading a saved UDF with fused.load().

to_directory

to_directory(where: str | Path | None = None, *, overwrite: bool = False)

Write the UDF to disk as a directory (folder).

Parameters:

  • where (str | Path | None) – A path to a directory. If not provided, uses the UDF function name.

Other Parameters:

  • overwrite (bool) – If true, overwriting is allowed.

to_file

to_file(where: str | Path | BinaryIO, *, overwrite: bool = False)

Write the UDF to disk or the specified file-like object.

The UDF will be written as a Zip file.

Parameters:

  • where (str | Path | BinaryIO) – A path to a file or a file-like object.

Other Parameters:

  • overwrite (bool) – If true, overwriting is allowed.