1.16.15

flytekitplugins.dask.models

Directory

Classes

Class Description
DaskJob Configuration for the custom dask job to run.
Scheduler Configuration for the scheduler pod.
WorkerGroup Configuration for a dask worker group.

flytekitplugins.dask.models.DaskJob

Configuration for the custom dask job to run

class DaskJob(
    scheduler: flytekitplugins.dask.models.Scheduler,
    workers: flytekitplugins.dask.models.WorkerGroup,
)
Parameter Type Description
scheduler flytekitplugins.dask.models.Scheduler Configuration for the scheduler
workers flytekitplugins.dask.models.WorkerGroup Configuration of the default worker group

Properties

Property Type Description
is_empty None
scheduler None :return: Configuration for the scheduler pod
workers None :return: Configuration of the default worker group

Methods

Method Description
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl() :return: The dask job serialized to protobuf.

serialize_to_string() 

def serialize_to_string()

short_string() 

def short_string()

:rtype: Text

to_flyte_idl() 

def to_flyte_idl()

:return: The dask job serialized to protobuf

flytekitplugins.dask.models.Scheduler

Configuration for the scheduler pod

class Scheduler(
    image: typing.Optional[str],
    resources: typing.Optional[flytekit.models.task.Resources],
)
Parameter Type Description
image typing.Optional[str] Optional image to use.
resources typing.Optional[flytekit.models.task.Resources] Optional resources to use.

Properties

Property Type Description
image None :return: The optional image for the scheduler pod
is_empty None
resources None :return: Optional resources for the scheduler pod

Methods

Method Description
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl() :return: The scheduler spec serialized to protobuf.

serialize_to_string() 

def serialize_to_string()

short_string() 

def short_string()

:rtype: Text

to_flyte_idl() 

def to_flyte_idl()

:return: The scheduler spec serialized to protobuf

flytekitplugins.dask.models.WorkerGroup

Configuration for a dask worker group

class WorkerGroup(
    number_of_workers: int,
    image: typing.Optional[str],
    resources: typing.Optional[flytekit.models.task.Resources],
)
Parameter Type Description
number_of_workers int Number of workers in the group
image typing.Optional[str] Optional image to use for the pods of the worker group
resources typing.Optional[flytekit.models.task.Resources] Optional resources to use for the pods of the worker group

Properties

Property Type Description
image None :return: The optional image to use for the worker pods
is_empty None
number_of_workers None :return: Optional number of workers for the worker group
resources None :return: Optional resources to use for the worker pods

Methods

Method Description
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl() :return: The dask cluster serialized to protobuf.

serialize_to_string() 

def serialize_to_string()

short_string() 

def short_string()

:rtype: Text

to_flyte_idl() 

def to_flyte_idl()

:return: The dask cluster serialized to protobuf