flytekit.core.node

Directory

Classes

Methods

Methods

assert_no_promises_in_resources()

def assert_no_promises_in_resources(
    resources: _resources_model,
)

This function will raise an exception if any of the resources have promises in them. This is because we don’t support promises in resources / runtime overriding of resources through input values.

assert_not_promise()

def assert_not_promise(
    v: Any,
    location: str,
)

This function will raise an exception if the value is a promise. This should be used to ensure that we don’t accidentally use a promise in a place where we don’t support it.

flytekit.core.node.Node

This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like ID, which from the registration step

Parameters

class Node(
    id: str,
    metadata: _workflow_model.NodeMetadata,
    bindings: List[_literal_models.Binding],
    upstream_nodes: List[Node],
    flyte_entity: Any,
)

Properties

Methods

runs_before()

def runs_before(
    other: Node,
)

This is typically something we shouldn’t do. This modifies an attribute of the other instance rather than self. But it’s done so only because we wanted this English function to be the same as the shift function. That is, calling node_1.runs_before(node_2) and node_1 >> node_2 are the same. The shift operator going the other direction is not implemented to further avoid confusion. Right shift was picked rather than left shift because that’s what most users are familiar with.

with_overrides()

def with_overrides(
    node_name: Optional[str],
    aliases: Optional[Dict[str, str]],
    requests: Optional[Resources],
    limits: Optional[Resources],
    timeout: Optional[Union[int, datetime.timedelta, object]],
    retries: Optional[int],
    interruptible: Optional[bool],
    name: Optional[str],
    task_config: Optional[Any],
    container_image: Optional[str],
    accelerator: Optional[BaseAccelerator],
    cache: Optional[Union[bool, Cache]],
    shared_memory: Optional[Union[L[True], str]],
    pod_template: Optional[PodTemplate],
    resources: Optional[Resources],
    args,
    kwargs,
)