SlurmScriptConnector

Package: flyteplugins.slurm

Parameters

        
    
def SlurmScriptConnector()

Methods

Method	Description
`create()`	Return a resource meta that can be used to get the status of the task.
`delete()`	Delete the task.
`get()`	Return the status of the task, and return the outputs in some cases.
`get_logs()`	Return the task execution logs.
`get_metrics()`	Return the metrics for the task.

create()

        
    
def create(
    task_template: flyteidl2.core.tasks_pb2.TaskTemplate,
    output_prefix: str,
    inputs: typing.Optional[typing.Dict[str, typing.Any]] = None,
    task_execution_metadata: typing.Optional[flyteidl2.connector.connector_pb2.TaskExecutionMetadata] = None,
    ssh_private_key: typing.Optional[str] = None,
    known_hosts_data: typing.Optional[str] = None,
    **kwargs,
) -> flyteplugins.slurm.connector.SlurmJobMetadata

Return a resource meta that can be used to get the status of the task.

Parameter	Type	Description
`task_template`	`flyteidl2.core.tasks_pb2.TaskTemplate`
`output_prefix`	`str`
`inputs`	`typing.Optional[typing.Dict[str, typing.Any]]`
`task_execution_metadata`	`typing.Optional[flyteidl2.connector.connector_pb2.TaskExecutionMetadata]`
`ssh_private_key`	`typing.Optional[str]`
`known_hosts_data`	`typing.Optional[str]`
`**kwargs`

delete()

        
    
def delete(
    resource_meta: flyteplugins.slurm.connector.SlurmJobMetadata,
    ssh_private_key: typing.Optional[str] = None,
    known_hosts_data: typing.Optional[str] = None,
    **kwargs,
)

Delete the task. This call should be idempotent. It should raise an error if fails to delete the task.

Parameter	Type	Description
`resource_meta`	`flyteplugins.slurm.connector.SlurmJobMetadata`
`ssh_private_key`	`typing.Optional[str]`
`known_hosts_data`	`typing.Optional[str]`
`**kwargs`

get()

        
    
def get(
    resource_meta: flyteplugins.slurm.connector.SlurmJobMetadata,
    ssh_private_key: typing.Optional[str] = None,
    known_hosts_data: typing.Optional[str] = None,
    **kwargs,
) -> flyte.connectors._connector.Resource

Return the status of the task, and return the outputs in some cases. For example, bigquery job can’t write the structured dataset to the output location, so it returns the output literals to the propeller, and the propeller will write the structured dataset to the blob store.

Parameter	Type	Description
`resource_meta`	`flyteplugins.slurm.connector.SlurmJobMetadata`
`ssh_private_key`	`typing.Optional[str]`
`known_hosts_data`	`typing.Optional[str]`
`**kwargs`

get_logs()

        
    
def get_logs(
    resource_meta: flyteplugins.slurm.connector.SlurmJobMetadata,
    ssh_private_key: typing.Optional[str] = None,
    known_hosts_data: typing.Optional[str] = None,
    **kwargs,
) -> typing.AsyncIterator[flyteidl2.connector.connector_pb2.GetTaskLogsResponse]

Return the task execution logs. Populate body.lines (structured LogLine entries with timestamp + originator) in the returned GetTaskLogsResponse.

Overrides may be a plain async function returning a single GetTaskLogsResponse, or an async generator yielding multiple responses (preferred for paginated logs — the connector server handles both shapes).

Parameter	Type	Description
`resource_meta`	`flyteplugins.slurm.connector.SlurmJobMetadata`
`ssh_private_key`	`typing.Optional[str]`
`known_hosts_data`	`typing.Optional[str]`
`**kwargs`

get_metrics()

        
    
def get_metrics(
    resource_meta: ~M,
    **kwargs,
) -> flyteidl2.connector.connector_pb2.GetTaskMetricsResponse

Return the metrics for the task.

Parameter	Type	Description
`resource_meta`	`~M`
`**kwargs`