Class Job

hyperqueue.job.Job

Represents a HQ job.

Declaration

class Job

source link

Documentation

Methods

▶ def __init__(self, default_workdir: Optional[GenericPath] = None, ...)
def __init__(
self,
default_workdir: Optional[GenericPath] = None,
max_fails: Optional[int] = 1,
default_env: Optional[EnvType] = None,
)
source link
Parameters
- default_workdir: Optional[GenericPath]
  Default working directory for tasks.
- max_fails: Optional[int]
  How many tasks can fail before the whole job will be cancelled.
- default_env: Optional[EnvType]
  Environment variables that will be automatically set for each task in this job.
▶ def function(self, fn, *, args=(), kwargs=None, ...) -> PythonFunction
Creates a new task that will execute the provided Python function.
def function(
self,
fn,
*,
args=(),
kwargs=None,
env: Optional[EnvType] = None,
cwd: Optional[GenericPath] = None,
stdout: Optional[Stdio] = default_stdout(),
stderr: Optional[Stdio] = default_stderr(),
deps: Sequence[Task] = (),
name: Optional[str] = None,
priority: int = 0,
resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
) -> PythonFunction
source link
Parameters
- args: None
  Positional arguments that will be passed to the Python function.
- kwargs: None
  Keyword arguments that will be passed to the Python function.
- env: Optional[EnvType]
  Environment variables passed to the executed command.
- cwd: Optional[GenericPath]
  Working directory of the executed command.
- stdout: Optional[Stdio]
  Path to a file that will store the standard output of the executed command.
- stderr: Optional[Stdio]
  Path to a file that will store the standard error output of the executed command.
- deps: Sequence[Task]
  A sequence of dependencies that have to be completed first before this task can start executing.
- name: Optional[str]
  Name of the task.
- priority: int
  Priority of the created task.
- resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]]
  List of resource requests required by this task.
▶ def program(self, args: ProgramArgs, *, env: Optional[EnvType] = None, ...) -> ExternalProgram
Creates a new task that will execute the provided command.
def program(
self,
args: ProgramArgs,
*,
env: Optional[EnvType] = None,
cwd: Optional[GenericPath] = None,
stdout: Optional[Stdio] = default_stdout(),
stderr: Optional[Stdio] = default_stderr(),
stdin: Optional[Union[str, bytes]] = None,
deps: Sequence[Task] = (),
name: Optional[str] = None,
task_dir: bool = False,
priority: int = 0,
resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
) -> ExternalProgram
source link
Parameters
- args: ProgramArgs
  List of arguments will be executed. The arguments have to be strings.
- env: Optional[EnvType]
  Environment variables passed to the executed command.
- cwd: Optional[GenericPath]
  Working directory of the executed command.
- stdout: Optional[Stdio]
  Path to a file that will store the standard output of the executed command.
- stderr: Optional[Stdio]
  Path to a file that will store the standard error output of the executed command.
- stdin: Optional[Union[str, bytes]]
  If provided, these bytes will be passed as the standard input of the executed command.
- deps: Sequence[Task]
  A sequence of dependencies that have to be completed first before this task can start executing.
- name: Optional[str]
  Name of the task.
- task_dir: bool
  If True, an isolated directory will be created for the task.
- priority: int
  Priority of the created task.
- resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]]
  List of resource requests required by this task.
▷ def task_by_id(self, id: TaskId) -> Optional[Task]
Finds a task with the given ID.
source link

Reexports

Imported in hyperqueue.client.
Imported in hyperqueue.visualization.
Imported in hyperqueue.

hyperqueue

Class Job

Declaration

Documentation

Methods

Parameters

Parameters

Parameters

Reexports