From 657107f0a6b02177b1bee6869698738fbcdee487 Mon Sep 17 00:00:00 2001 From: gh-ci-deploy-docs Date: Mon, 7 Oct 2024 09:10:13 +0000 Subject: [PATCH] Deployed ce62a1c8 to latest with MkDocs 1.2.4 and mike 1.1.2 --- .../python/apidoc/hyperqueue.client.Client.html | 2 +- .../hyperqueue.client.FailedJobsException.html | 2 +- latest/python/apidoc/hyperqueue.client.html | 2 +- .../apidoc/hyperqueue.cluster.LocalCluster.html | 2 +- .../apidoc/hyperqueue.cluster.WorkerConfig.html | 2 +- latest/python/apidoc/hyperqueue.cluster.html | 2 +- latest/python/apidoc/hyperqueue.common.html | 2 +- .../hyperqueue.ffi.client.ClientConnection.html | 2 +- ...hyperqueue.ffi.client.FailedTaskContext.html | 2 +- .../hyperqueue.ffi.client.HqClientContext.html | 2 +- latest/python/apidoc/hyperqueue.ffi.client.html | 2 +- .../apidoc/hyperqueue.ffi.cluster.Cluster.html | 2 +- ...hyperqueue.ffi.cluster.HqClusterContext.html | 2 +- .../python/apidoc/hyperqueue.ffi.cluster.html | 2 +- latest/python/apidoc/hyperqueue.ffi.html | 2 +- .../hyperqueue.ffi.protocol.JobDescription.html | 2 +- ...hyperqueue.ffi.protocol.ResourceRequest.html | 2 +- ...hyperqueue.ffi.protocol.TaskDescription.html | 2 +- .../python/apidoc/hyperqueue.ffi.protocol.html | 2 +- latest/python/apidoc/hyperqueue.html | 2 +- latest/python/apidoc/hyperqueue.job.Job.html | 2 +- .../apidoc/hyperqueue.job.SubmittedJob.html | 2 +- latest/python/apidoc/hyperqueue.job.html | 2 +- .../python/apidoc/hyperqueue.output.Output.html | 2 +- .../apidoc/hyperqueue.output.StdioDef.html | 2 +- latest/python/apidoc/hyperqueue.output.html | 2 +- .../hyperqueue.task.function.PythonEnv.html | 2 +- ...hyperqueue.task.function.PythonFunction.html | 2 +- .../python/apidoc/hyperqueue.task.function.html | 2 +- ...ueue.task.function.wrapper.CloudWrapper.html | 2 +- .../hyperqueue.task.function.wrapper.html | 2 +- latest/python/apidoc/hyperqueue.task.html | 2 +- ...hyperqueue.task.program.ExternalProgram.html | 2 +- .../python/apidoc/hyperqueue.task.program.html | 2 +- .../apidoc/hyperqueue.task.task.Task.html | 2 +- latest/python/apidoc/hyperqueue.task.task.html | 2 +- latest/python/apidoc/hyperqueue.utils.html | 2 +- ...e.utils.package.MissingPackageException.html | 2 +- .../python/apidoc/hyperqueue.utils.package.html | 2 +- .../python/apidoc/hyperqueue.utils.string.html | 2 +- ...perqueue.validation.ValidationException.html | 2 +- latest/python/apidoc/hyperqueue.validation.html | 2 +- .../python/apidoc/hyperqueue.visualization.html | 2 +- latest/python/apidoc/index.html | 2 +- .../apidoc/source+hyperqueue.__init__.py.html | 2 +- .../apidoc/source+hyperqueue.client.py.html | 2 +- .../source+hyperqueue.cluster.__init__.py.html | 2 +- .../apidoc/source+hyperqueue.common.py.html | 2 +- .../source+hyperqueue.ffi.__init__.py.html | 2 +- .../apidoc/source+hyperqueue.ffi.client.py.html | 2 +- .../source+hyperqueue.ffi.cluster.py.html | 2 +- .../source+hyperqueue.ffi.protocol.py.html | 2 +- .../python/apidoc/source+hyperqueue.job.py.html | 2 +- .../apidoc/source+hyperqueue.output.py.html | 2 +- ...ce+hyperqueue.task.function.__init__.py.html | 2 +- ...rce+hyperqueue.task.function.wrapper.py.html | 2 +- .../source+hyperqueue.task.program.py.html | 2 +- .../apidoc/source+hyperqueue.task.task.py.html | 2 +- .../source+hyperqueue.utils.package.py.html | 2 +- .../source+hyperqueue.utils.string.py.html | 2 +- .../apidoc/source+hyperqueue.validation.py.html | 2 +- .../source+hyperqueue.visualization.py.html | 2 +- latest/sitemap.xml.gz | Bin 458 -> 458 bytes 63 files changed, 62 insertions(+), 62 deletions(-) diff --git a/latest/python/apidoc/hyperqueue.client.Client.html b/latest/python/apidoc/hyperqueue.client.Client.html index b3e1edec4..41d208268 100644 --- a/latest/python/apidoc/hyperqueue.client.Client.html +++ b/latest/python/apidoc/hyperqueue.client.Client.html @@ -1 +1 @@ -hyperqueue.client.Client

Class Client

A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

Declaration

class Client
source link

Documentation

Methods

  • def __init__(self, server_dir: Optional[GenericPath] = None, ...)

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

    def __init__(
    self,
    server_dir: Optional[GenericPath] = None,
    python_env: Optional[PythonEnv] = None,
    )

    Parameters

    • server_dir: Optional[GenericPath]

      Path to a server directory of a running HyperQueue server.

    • python_env: Optional[PythonEnv]

      Python environment which configures Python tasks created by function.

  • def forget(self, job: HasJobId)

    Forget a completed job to free up its resources from the server.

    Parameters

    • job: HasJobId

      Submitted job (or job ID) that will be forgotten.

  • def get_failed_tasks(self, job: SubmittedJob) -> Dict[TaskId, FailedTaskContext]
  • def submit(self, job: Job) -> SubmittedJob

    Submit a job into HyperQueue.

    Parameters

    • job: Job

      Job that will be submitted.

  • def wait_for_jobs(self, jobs: Sequence[SubmittedJob], raise_on_error=True) -> bool

    Returns True if all tasks were successfully finished

Reexports

\ No newline at end of file +hyperqueue.client.Client

Class Client

A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

Declaration

class Client
source link

Documentation

Methods

  • def __init__(self, server_dir: Optional[GenericPath] = None, ...)

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

    def __init__(
    self,
    server_dir: Optional[GenericPath] = None,
    python_env: Optional[PythonEnv] = None,
    )

    Parameters

    • server_dir: Optional[GenericPath]

      Path to a server directory of a running HyperQueue server.

    • python_env: Optional[PythonEnv]

      Python environment which configures Python tasks created by function.

  • def forget(self, job: HasJobId)

    Forget a completed job to free up its resources from the server.

    Parameters

    • job: HasJobId

      Submitted job (or job ID) that will be forgotten.

  • def get_failed_tasks(self, job: SubmittedJob) -> Dict[TaskId, FailedTaskContext]
  • def submit(self, job: Job) -> SubmittedJob

    Submit a job into HyperQueue.

    Parameters

    • job: Job

      Job that will be submitted.

  • def wait_for_jobs(self, jobs: Sequence[SubmittedJob], raise_on_error=True) -> bool

    Returns True if all tasks were successfully finished

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.client.FailedJobsException.html b/latest/python/apidoc/hyperqueue.client.FailedJobsException.html index f426f454f..a38bf4554 100644 --- a/latest/python/apidoc/hyperqueue.client.FailedJobsException.html +++ b/latest/python/apidoc/hyperqueue.client.FailedJobsException.html @@ -1 +1 @@ -hyperqueue.client.FailedJobsException

Class FailedJobsException

This exception is triggered if a task fails.

Declaration

class FailedJobsException(Exception)
source link

Documentation

Methods

\ No newline at end of file +hyperqueue.client.FailedJobsException

Class FailedJobsException

This exception is triggered if a task fails.

Declaration

class FailedJobsException(Exception)
source link

Documentation

Methods

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.client.html b/latest/python/apidoc/hyperqueue.client.html index b277803ab..3790cdf40 100644 --- a/latest/python/apidoc/hyperqueue.client.html +++ b/latest/python/apidoc/hyperqueue.client.html @@ -1 +1 @@ -hyperqueue.client

Module client

source link

Classes

  • class Client

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

  • This exception is triggered if a task fails.

Functions

\ No newline at end of file +hyperqueue.client

Module client

source link

Classes

  • class Client

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

  • This exception is triggered if a task fails.

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.cluster.LocalCluster.html b/latest/python/apidoc/hyperqueue.cluster.LocalCluster.html index 08150d902..f0f606029 100644 --- a/latest/python/apidoc/hyperqueue.cluster.LocalCluster.html +++ b/latest/python/apidoc/hyperqueue.cluster.LocalCluster.html @@ -2,4 +2,4 @@ client = cluster.client() ... # The cluster was stopped -

Methods

Reexports

\ No newline at end of file +

Methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.cluster.WorkerConfig.html b/latest/python/apidoc/hyperqueue.cluster.WorkerConfig.html index 2c0029c6c..8faf00b95 100644 --- a/latest/python/apidoc/hyperqueue.cluster.WorkerConfig.html +++ b/latest/python/apidoc/hyperqueue.cluster.WorkerConfig.html @@ -1 +1 @@ -hyperqueue.cluster.WorkerConfig

Class WorkerConfig

Configuration of a worker spawned by a local cluster.

Declaration

@dataclasses.dataclass
class WorkerConfig
source link

Documentation

\ No newline at end of file +hyperqueue.cluster.WorkerConfig

Class WorkerConfig

Configuration of a worker spawned by a local cluster.

Declaration

@dataclasses.dataclass
class WorkerConfig
source link

Documentation

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.cluster.html b/latest/python/apidoc/hyperqueue.cluster.html index 5e54473a7..687ac9e9b 100644 --- a/latest/python/apidoc/hyperqueue.cluster.html +++ b/latest/python/apidoc/hyperqueue.cluster.html @@ -1 +1 @@ -hyperqueue.cluster

Module cluster

source link

Classes

  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

  • class WorkerConfig

    Configuration of a worker spawned by a local cluster.

\ No newline at end of file +hyperqueue.cluster

Module cluster

source link

Classes

  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

  • class WorkerConfig

    Configuration of a worker spawned by a local cluster.

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.common.html b/latest/python/apidoc/hyperqueue.common.html index 9e249ba73..1cab5b392 100644 --- a/latest/python/apidoc/hyperqueue.common.html +++ b/latest/python/apidoc/hyperqueue.common.html @@ -1 +1 @@ -hyperqueue.common

Module common

source link
\ No newline at end of file +hyperqueue.common

Module common

source link
\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.client.ClientConnection.html b/latest/python/apidoc/hyperqueue.ffi.client.ClientConnection.html index 0da2d43a5..b002bac27 100644 --- a/latest/python/apidoc/hyperqueue.ffi.client.ClientConnection.html +++ b/latest/python/apidoc/hyperqueue.ffi.client.ClientConnection.html @@ -1 +1 @@ -hyperqueue.ffi.client.ClientConnection

Class ClientConnection

Declaration

class ClientConnection
source link

Methods

Reexports

\ No newline at end of file +hyperqueue.ffi.client.ClientConnection

Class ClientConnection

Declaration

class ClientConnection
source link

Methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.client.FailedTaskContext.html b/latest/python/apidoc/hyperqueue.ffi.client.FailedTaskContext.html index 8a0fa39c6..54793a9d5 100644 --- a/latest/python/apidoc/hyperqueue.ffi.client.FailedTaskContext.html +++ b/latest/python/apidoc/hyperqueue.ffi.client.FailedTaskContext.html @@ -1 +1 @@ -hyperqueue.ffi.client.FailedTaskContext

Class FailedTaskContext

Declaration

@dataclasses.dataclass(frozen=True)
class FailedTaskContext
source link

Reexports

\ No newline at end of file +hyperqueue.ffi.client.FailedTaskContext

Class FailedTaskContext

Declaration

@dataclasses.dataclass(frozen=True)
class FailedTaskContext
source link

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.client.HqClientContext.html b/latest/python/apidoc/hyperqueue.ffi.client.HqClientContext.html index 18e7ae9d9..2b70c6bcd 100644 --- a/latest/python/apidoc/hyperqueue.ffi.client.HqClientContext.html +++ b/latest/python/apidoc/hyperqueue.ffi.client.HqClientContext.html @@ -1 +1 @@ -hyperqueue.ffi.client.HqClientContext

Class HqClientContext

Opaque class returned from connect_to_server. Should be passed to FFI methods that require it.

Declaration

class HqClientContext
source link

Documentation

\ No newline at end of file +hyperqueue.ffi.client.HqClientContext

Class HqClientContext

Opaque class returned from connect_to_server. Should be passed to FFI methods that require it.

Declaration

class HqClientContext
source link

Documentation

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.client.html b/latest/python/apidoc/hyperqueue.ffi.client.html index 0c3a10790..3ea457448 100644 --- a/latest/python/apidoc/hyperqueue.ffi.client.html +++ b/latest/python/apidoc/hyperqueue.ffi.client.html @@ -1 +1 @@ -hyperqueue.ffi.client

Module client

source link

Classes

\ No newline at end of file +hyperqueue.ffi.client

Module client

source link

Classes

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.cluster.Cluster.html b/latest/python/apidoc/hyperqueue.ffi.cluster.Cluster.html index 1879514cd..d67449df7 100644 --- a/latest/python/apidoc/hyperqueue.ffi.cluster.Cluster.html +++ b/latest/python/apidoc/hyperqueue.ffi.cluster.Cluster.html @@ -1 +1 @@ -hyperqueue.ffi.cluster.Cluster

Class Cluster

Declaration

class Cluster
source link

Methods

Reexports

\ No newline at end of file +hyperqueue.ffi.cluster.Cluster

Class Cluster

Declaration

class Cluster
source link

Methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.cluster.HqClusterContext.html b/latest/python/apidoc/hyperqueue.ffi.cluster.HqClusterContext.html index 5a617eae1..bff27ecf0 100644 --- a/latest/python/apidoc/hyperqueue.ffi.cluster.HqClusterContext.html +++ b/latest/python/apidoc/hyperqueue.ffi.cluster.HqClusterContext.html @@ -1 +1 @@ -hyperqueue.ffi.cluster.HqClusterContext

Class HqClusterContext

Opaque class returned from cluster_start. Should be passed to FFI methods that require it.

Declaration

class HqClusterContext
source link

Documentation

\ No newline at end of file +hyperqueue.ffi.cluster.HqClusterContext

Class HqClusterContext

Opaque class returned from cluster_start. Should be passed to FFI methods that require it.

Declaration

class HqClusterContext
source link

Documentation

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.cluster.html b/latest/python/apidoc/hyperqueue.ffi.cluster.html index 37cb14811..d7b617ad0 100644 --- a/latest/python/apidoc/hyperqueue.ffi.cluster.html +++ b/latest/python/apidoc/hyperqueue.ffi.cluster.html @@ -1 +1 @@ -hyperqueue.ffi.cluster

Module cluster

source link

Classes

  • class Cluster
  • Opaque class returned from cluster_start. Should be passed to FFI methods that require it.

\ No newline at end of file +hyperqueue.ffi.cluster

Module cluster

source link

Classes

  • class Cluster
  • Opaque class returned from cluster_start. Should be passed to FFI methods that require it.

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.html b/latest/python/apidoc/hyperqueue.ffi.html index 9c708465f..2571205e0 100644 --- a/latest/python/apidoc/hyperqueue.ffi.html +++ b/latest/python/apidoc/hyperqueue.ffi.html @@ -1 +1 @@ -hyperqueue.ffi

Module ffi

source link

Functions

Submodules

\ No newline at end of file +hyperqueue.ffi

Module ffi

source link

Functions

Submodules

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.protocol.JobDescription.html b/latest/python/apidoc/hyperqueue.ffi.protocol.JobDescription.html index 662d2d1a6..da458a78a 100644 --- a/latest/python/apidoc/hyperqueue.ffi.protocol.JobDescription.html +++ b/latest/python/apidoc/hyperqueue.ffi.protocol.JobDescription.html @@ -1 +1 @@ -hyperqueue.ffi.protocol.JobDescription

Class JobDescription

Declaration

@dataclasses.dataclass
class JobDescription
source link

Reexports

\ No newline at end of file +hyperqueue.ffi.protocol.JobDescription

Class JobDescription

Declaration

@dataclasses.dataclass
class JobDescription
source link

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.protocol.ResourceRequest.html b/latest/python/apidoc/hyperqueue.ffi.protocol.ResourceRequest.html index 6b9843fb3..c23996c07 100644 --- a/latest/python/apidoc/hyperqueue.ffi.protocol.ResourceRequest.html +++ b/latest/python/apidoc/hyperqueue.ffi.protocol.ResourceRequest.html @@ -1 +1 @@ -hyperqueue.ffi.protocol.ResourceRequest

Class ResourceRequest

Declaration

class ResourceRequest
source link

Methods

  • def __init__(self, *, n_nodes=0, cpus: Union[int, float, str] = 1, ...)
    def __init__(
    self,
    *,
    n_nodes=0,
    cpus: Union[int, float, str] = 1,
    resources: Optional[Dict[str, Union[int, float, str]]] = None,
    min_time: Optional[datetime.timedelta] = None,
    )
  • def __repr__(self)

Reexports

\ No newline at end of file +hyperqueue.ffi.protocol.ResourceRequest

Class ResourceRequest

Declaration

class ResourceRequest
source link

Methods

  • def __init__(self, *, n_nodes=0, cpus: Union[int, float, str] = 1, ...)
    def __init__(
    self,
    *,
    n_nodes=0,
    cpus: Union[int, float, str] = 1,
    resources: Optional[Dict[str, Union[int, float, str]]] = None,
    min_time: Optional[datetime.timedelta] = None,
    )
  • def __repr__(self)

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.protocol.TaskDescription.html b/latest/python/apidoc/hyperqueue.ffi.protocol.TaskDescription.html index c157dcebe..5811e963b 100644 --- a/latest/python/apidoc/hyperqueue.ffi.protocol.TaskDescription.html +++ b/latest/python/apidoc/hyperqueue.ffi.protocol.TaskDescription.html @@ -1 +1 @@ -hyperqueue.ffi.protocol.TaskDescription

Class TaskDescription

Declaration

@dataclasses.dataclass()
class TaskDescription
source link

Reexports

\ No newline at end of file +hyperqueue.ffi.protocol.TaskDescription

Class TaskDescription

Declaration

@dataclasses.dataclass()
class TaskDescription
source link

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.protocol.html b/latest/python/apidoc/hyperqueue.ffi.protocol.html index 06b9f872e..c69b9afab 100644 --- a/latest/python/apidoc/hyperqueue.ffi.protocol.html +++ b/latest/python/apidoc/hyperqueue.ffi.protocol.html @@ -1 +1 @@ -hyperqueue.ffi.protocol

Module protocol

source link

Classes

\ No newline at end of file +hyperqueue.ffi.protocol

Module protocol

source link

Classes

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.html b/latest/python/apidoc/hyperqueue.html index 9e5392f47..16a8551d4 100644 --- a/latest/python/apidoc/hyperqueue.html +++ b/latest/python/apidoc/hyperqueue.html @@ -1 +1 @@ -hyperqueue

Module hyperqueue

This is the Python API of HyperQueue.

Important classes:

  • Client serves for connecting to a HyperQueue server.
  • LocalCluster can be used to spawn a local HyperQueue cluster.
  • Job describes a job containing a directed acyclic graph of tasks. It can be submitted using a client.
source link

Re-exported Classes

  • class Client

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

    [hyperqueue.client.Client]
  • class Job

    Represents a HQ job.

    [hyperqueue.job.Job]
  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

    [hyperqueue.cluster.LocalCluster]

Re-exported Functions

Submodules

\ No newline at end of file +hyperqueue

Module hyperqueue

This is the Python API of HyperQueue.

Important classes:

  • Client serves for connecting to a HyperQueue server.
  • LocalCluster can be used to spawn a local HyperQueue cluster.
  • Job describes a job containing a directed acyclic graph of tasks. It can be submitted using a client.
source link

Re-exported Classes

  • class Client

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

    [hyperqueue.client.Client]
  • class Job

    Represents a HQ job.

    [hyperqueue.job.Job]
  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

    [hyperqueue.cluster.LocalCluster]

Re-exported Functions

Submodules

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.job.Job.html b/latest/python/apidoc/hyperqueue.job.Job.html index 5dbbfc69f..583825bff 100644 --- a/latest/python/apidoc/hyperqueue.job.Job.html +++ b/latest/python/apidoc/hyperqueue.job.Job.html @@ -1 +1 @@ -hyperqueue.job.Job

Class 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,
    )

    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

    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

    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.

Reexports

\ No newline at end of file +hyperqueue.job.Job

Class 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,
    )

    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

    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

    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.

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.job.SubmittedJob.html b/latest/python/apidoc/hyperqueue.job.SubmittedJob.html index ef274c5e8..58dce20ac 100644 --- a/latest/python/apidoc/hyperqueue.job.SubmittedJob.html +++ b/latest/python/apidoc/hyperqueue.job.SubmittedJob.html @@ -1 +1 @@ -hyperqueue.job.SubmittedJob

Class SubmittedJob

Successfully submitted job.

Declaration

@dataclasses.dataclass
class SubmittedJob
source link

Documentation

Reexports

\ No newline at end of file +hyperqueue.job.SubmittedJob

Class SubmittedJob

Successfully submitted job.

Declaration

@dataclasses.dataclass
class SubmittedJob
source link

Documentation

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.job.html b/latest/python/apidoc/hyperqueue.job.html index a9d7071b3..857b37106 100644 --- a/latest/python/apidoc/hyperqueue.job.html +++ b/latest/python/apidoc/hyperqueue.job.html @@ -1 +1 @@ -hyperqueue.job

Module job

source link

Classes

  • class Job

    Represents a HQ job.

  • class SubmittedJob

    Successfully submitted job.

Functions

\ No newline at end of file +hyperqueue.job

Module job

source link

Classes

  • class Job

    Represents a HQ job.

  • class SubmittedJob

    Successfully submitted job.

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.output.Output.html b/latest/python/apidoc/hyperqueue.output.Output.html index 764acad25..6a5270c78 100644 --- a/latest/python/apidoc/hyperqueue.output.Output.html +++ b/latest/python/apidoc/hyperqueue.output.Output.html @@ -1 +1 @@ -hyperqueue.output.Output

Class Output

Declaration

class Output
source link

Methods

  • def __init__(self, name: str, filepath: Optional[str] = None, extension: Optional[str] = None)

Reexports

\ No newline at end of file +hyperqueue.output.Output

Class Output

Declaration

class Output
source link

Methods

  • def __init__(self, name: str, filepath: Optional[str] = None, extension: Optional[str] = None)

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.output.StdioDef.html b/latest/python/apidoc/hyperqueue.output.StdioDef.html index 407cdf78a..0afe24d79 100644 --- a/latest/python/apidoc/hyperqueue.output.StdioDef.html +++ b/latest/python/apidoc/hyperqueue.output.StdioDef.html @@ -1 +1 @@ -hyperqueue.output.StdioDef

Class StdioDef

If path is None, then the default HQ path will be used.

Declaration

@dataclasses.dataclass
class StdioDef
source link

Documentation

Class methods

  • def from_path(path: GenericPath) -> StdioDef @staticmethod
    @staticmethod
    def from_path(path: GenericPath)
  • def remove_if_finished(path: Optional[GenericPath] = None) -> StdioDef @staticmethod
    @staticmethod
    def remove_if_finished(path: Optional[GenericPath] = None)

Reexports

\ No newline at end of file +hyperqueue.output.StdioDef

Class StdioDef

If path is None, then the default HQ path will be used.

Declaration

@dataclasses.dataclass
class StdioDef
source link

Documentation

Class methods

  • def from_path(path: GenericPath) -> StdioDef @staticmethod
    @staticmethod
    def from_path(path: GenericPath)
  • def remove_if_finished(path: Optional[GenericPath] = None) -> StdioDef @staticmethod
    @staticmethod
    def remove_if_finished(path: Optional[GenericPath] = None)

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.output.html b/latest/python/apidoc/hyperqueue.output.html index eb908021d..ed20ccd4e 100644 --- a/latest/python/apidoc/hyperqueue.output.html +++ b/latest/python/apidoc/hyperqueue.output.html @@ -1 +1 @@ -hyperqueue.output

Module output

source link

Classes

  • class Output
  • class StdioDef

    If path is None, then the default HQ path will be used.

Functions

\ No newline at end of file +hyperqueue.output

Module output

source link

Classes

  • class Output
  • class StdioDef

    If path is None, then the default HQ path will be used.

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.function.PythonEnv.html b/latest/python/apidoc/hyperqueue.task.function.PythonEnv.html index 9c85d6eca..398121cab 100644 --- a/latest/python/apidoc/hyperqueue.task.function.PythonEnv.html +++ b/latest/python/apidoc/hyperqueue.task.function.PythonEnv.html @@ -1 +1 @@ -hyperqueue.task.function.PythonEnv

Class PythonEnv

Describes an environment for spawning Python interpreters.

Declaration

class PythonEnv
source link

Documentation

Methods

  • def __init__(self, python_bin: str = "python3", prologue: Optional[str] = None, ...)

    Describes an environment for spawning Python interpreters.

    def __init__(
    self,
    python_bin: str = "python3",
    prologue: Optional[str] = None,
    shell: str = "bash",
    )

    Parameters

    • python_bin: str

      Python binary that will be executed.

    • prologue: Optional[str]

      Shell command that will be executed prior to launching the Python interpreter.

    • shell: str

      Shell used for executing prologue.

Reexports

\ No newline at end of file +hyperqueue.task.function.PythonEnv

Class PythonEnv

Describes an environment for spawning Python interpreters.

Declaration

class PythonEnv
source link

Documentation

Methods

  • def __init__(self, python_bin: str = "python3", prologue: Optional[str] = None, ...)

    Describes an environment for spawning Python interpreters.

    def __init__(
    self,
    python_bin: str = "python3",
    prologue: Optional[str] = None,
    shell: str = "bash",
    )

    Parameters

    • python_bin: str

      Python binary that will be executed.

    • prologue: Optional[str]

      Shell command that will be executed prior to launching the Python interpreter.

    • shell: str

      Shell used for executing prologue.

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.function.PythonFunction.html b/latest/python/apidoc/hyperqueue.task.function.PythonFunction.html index 1d44a824c..09b5927c7 100644 --- a/latest/python/apidoc/hyperqueue.task.function.PythonFunction.html +++ b/latest/python/apidoc/hyperqueue.task.function.PythonFunction.html @@ -1 +1 @@ -hyperqueue.task.function.PythonFunction

Class PythonFunction

Task that represents the execution of a Python function.

Declaration

class PythonFunction(Task)
source link

Documentation

Methods

  • def __init__(self, task_id: TaskId, fn: Callable, *, args=(), kwargs=None, ...) override
    def __init__(
    self,
    task_id: TaskId,
    fn: Callable,
    *,
    args=(),
    kwargs=None,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[GenericPath] = None,
    stderr: Optional[GenericPath] = None,
    name: Optional[str] = None,
    dependencies=(),
    priority: int = 0,
    resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
    )

    This method overrides hyperqueue.task.task.Task.__init__.

  • def __repr__(self)

Inherited methods

Reexports

\ No newline at end of file +hyperqueue.task.function.PythonFunction

Class PythonFunction

Task that represents the execution of a Python function.

Declaration

class PythonFunction(Task)
source link

Documentation

Methods

  • def __init__(self, task_id: TaskId, fn: Callable, *, args=(), kwargs=None, ...) override
    def __init__(
    self,
    task_id: TaskId,
    fn: Callable,
    *,
    args=(),
    kwargs=None,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[GenericPath] = None,
    stderr: Optional[GenericPath] = None,
    name: Optional[str] = None,
    dependencies=(),
    priority: int = 0,
    resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
    )

    This method overrides hyperqueue.task.task.Task.__init__.

  • def __repr__(self)

Inherited methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.function.html b/latest/python/apidoc/hyperqueue.task.function.html index 0d3eee834..8c734ceaa 100644 --- a/latest/python/apidoc/hyperqueue.task.function.html +++ b/latest/python/apidoc/hyperqueue.task.function.html @@ -1 +1 @@ -hyperqueue.task.function

Module function

source link

Classes

  • class PythonEnv

    Describes an environment for spawning Python interpreters.

  • Task that represents the execution of a Python function.

Re-exported Classes

  • class CloudWrapper

    Wraps a callable so that cloudpickle is used to pickle it, caching the pickle.

    [hyperqueue.task.function.wrapper.CloudWrapper]

Functions

Submodules

\ No newline at end of file +hyperqueue.task.function

Module function

source link

Classes

  • class PythonEnv

    Describes an environment for spawning Python interpreters.

  • Task that represents the execution of a Python function.

Re-exported Classes

  • class CloudWrapper

    Wraps a callable so that cloudpickle is used to pickle it, caching the pickle.

    [hyperqueue.task.function.wrapper.CloudWrapper]

Functions

Submodules

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.function.wrapper.CloudWrapper.html b/latest/python/apidoc/hyperqueue.task.function.wrapper.CloudWrapper.html index dfa693891..5d08ca76b 100644 --- a/latest/python/apidoc/hyperqueue.task.function.wrapper.CloudWrapper.html +++ b/latest/python/apidoc/hyperqueue.task.function.wrapper.CloudWrapper.html @@ -1 +1 @@ -hyperqueue.task.function.wrapper.CloudWrapper

Class CloudWrapper

Wraps a callable so that cloudpickle is used to pickle it, caching the pickle.

Declaration

class CloudWrapper
source link

Documentation

Methods

Reexports

\ No newline at end of file +hyperqueue.task.function.wrapper.CloudWrapper

Class CloudWrapper

Wraps a callable so that cloudpickle is used to pickle it, caching the pickle.

Declaration

class CloudWrapper
source link

Documentation

Methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.function.wrapper.html b/latest/python/apidoc/hyperqueue.task.function.wrapper.html index db3010e56..c001bb79e 100644 --- a/latest/python/apidoc/hyperqueue.task.function.wrapper.html +++ b/latest/python/apidoc/hyperqueue.task.function.wrapper.html @@ -1 +1 @@ -hyperqueue.task.function.wrapper

Module wrapper

source link

Classes

  • class CloudWrapper

    Wraps a callable so that cloudpickle is used to pickle it, caching the pickle.

\ No newline at end of file +hyperqueue.task.function.wrapper

Module wrapper

source link

Classes

  • class CloudWrapper

    Wraps a callable so that cloudpickle is used to pickle it, caching the pickle.

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.html b/latest/python/apidoc/hyperqueue.task.html index fc741f27c..7d2e69e5b 100644 --- a/latest/python/apidoc/hyperqueue.task.html +++ b/latest/python/apidoc/hyperqueue.task.html @@ -1 +1 @@ -hyperqueue.task

Module task

source link

Submodules

\ No newline at end of file +hyperqueue.task

Module task

source link

Submodules

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.program.ExternalProgram.html b/latest/python/apidoc/hyperqueue.task.program.ExternalProgram.html index 2db4b4be6..1dedbc8df 100644 --- a/latest/python/apidoc/hyperqueue.task.program.ExternalProgram.html +++ b/latest/python/apidoc/hyperqueue.task.program.ExternalProgram.html @@ -1 +1 @@ -hyperqueue.task.program.ExternalProgram

Class ExternalProgram

Task that represents the execution of an executable binary.

Declaration

class ExternalProgram(Task)
source link

Documentation

Methods

  • def __getitem__(self, key: str)
  • def __init__(self, task_id: TaskId, *, args: List[str], env: Optional[EnvType] = None, ...) override
    def __init__(
    self,
    task_id: TaskId,
    *,
    args: List[str],
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = None,
    stderr: Optional[Stdio] = None,
    stdin: Optional[Union[str, bytes]] = None,
    name: Optional[str] = None,
    dependencies: Sequence[Task] = (),
    task_dir: bool = False,
    priority: int = 0,
    resources: Optional[ResourceRequest],
    )

    This method overrides hyperqueue.task.task.Task.__init__.

  • def __repr__(self)

Inherited methods

Reexports

\ No newline at end of file +hyperqueue.task.program.ExternalProgram

Class ExternalProgram

Task that represents the execution of an executable binary.

Declaration

class ExternalProgram(Task)
source link

Documentation

Methods

  • def __getitem__(self, key: str)
  • def __init__(self, task_id: TaskId, *, args: List[str], env: Optional[EnvType] = None, ...) override
    def __init__(
    self,
    task_id: TaskId,
    *,
    args: List[str],
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = None,
    stderr: Optional[Stdio] = None,
    stdin: Optional[Union[str, bytes]] = None,
    name: Optional[str] = None,
    dependencies: Sequence[Task] = (),
    task_dir: bool = False,
    priority: int = 0,
    resources: Optional[ResourceRequest],
    )

    This method overrides hyperqueue.task.task.Task.__init__.

  • def __repr__(self)

Inherited methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.program.html b/latest/python/apidoc/hyperqueue.task.program.html index 5246ce4da..75b09efa5 100644 --- a/latest/python/apidoc/hyperqueue.task.program.html +++ b/latest/python/apidoc/hyperqueue.task.program.html @@ -1 +1 @@ -hyperqueue.task.program

Module program

source link

Classes

  • Task that represents the execution of an executable binary.

Functions

\ No newline at end of file +hyperqueue.task.program

Module program

source link

Classes

  • Task that represents the execution of an executable binary.

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.task.Task.html b/latest/python/apidoc/hyperqueue.task.task.Task.html index 7c6df40f9..54005a96b 100644 --- a/latest/python/apidoc/hyperqueue.task.task.Task.html +++ b/latest/python/apidoc/hyperqueue.task.task.Task.html @@ -1 +1 @@ -hyperqueue.task.task.Task

Class Task

Declaration

class Task
source link

Methods

  • def __init__(self, task_id: TaskId, dependencies: Sequence["Task"] = (), ...)
    def __init__(
    self,
    task_id: TaskId,
    dependencies: Sequence["Task"] = (),
    priority: int = 0,
    resources: Optional[ResourceRequest] = None,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = None,
    stderr: Optional[Stdio] = None,
    name: Optional[str] = None,
    )

    Overrides

    This method is overriden in:

  • def label(self) -> str @property

    Returns the label of the task. If the task has an assigned name, the label is equal to the name. Otherwise, the label is the ID of the task converted to a string.

    @property
    def label(self)

Subclasses

Reexports

\ No newline at end of file +hyperqueue.task.task.Task

Class Task

Declaration

class Task
source link

Methods

  • def __init__(self, task_id: TaskId, dependencies: Sequence["Task"] = (), ...)
    def __init__(
    self,
    task_id: TaskId,
    dependencies: Sequence["Task"] = (),
    priority: int = 0,
    resources: Optional[ResourceRequest] = None,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = None,
    stderr: Optional[Stdio] = None,
    name: Optional[str] = None,
    )

    Overrides

    This method is overriden in:

  • def label(self) -> str @property

    Returns the label of the task. If the task has an assigned name, the label is equal to the name. Otherwise, the label is the ID of the task converted to a string.

    @property
    def label(self)

Subclasses

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.task.html b/latest/python/apidoc/hyperqueue.task.task.html index 7f3247ae0..636bd7105 100644 --- a/latest/python/apidoc/hyperqueue.task.task.html +++ b/latest/python/apidoc/hyperqueue.task.task.html @@ -1 +1 @@ -hyperqueue.task.task

Module task

source link

Classes

Functions

\ No newline at end of file +hyperqueue.task.task

Module task

source link

Classes

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.utils.html b/latest/python/apidoc/hyperqueue.utils.html index 10651fd13..522b3cad3 100644 --- a/latest/python/apidoc/hyperqueue.utils.html +++ b/latest/python/apidoc/hyperqueue.utils.html @@ -1 +1 @@ -hyperqueue.utils

Module utils

source link

Submodules

\ No newline at end of file +hyperqueue.utils

Module utils

source link

Submodules

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.utils.package.MissingPackageException.html b/latest/python/apidoc/hyperqueue.utils.package.MissingPackageException.html index 29ff30da2..fb8261a6e 100644 --- a/latest/python/apidoc/hyperqueue.utils.package.MissingPackageException.html +++ b/latest/python/apidoc/hyperqueue.utils.package.MissingPackageException.html @@ -1 +1 @@ -hyperqueue.utils.package.MissingPackageException

Class MissingPackageException

Declaration

class MissingPackageException(BaseException)
source link

Methods

Reexports

\ No newline at end of file +hyperqueue.utils.package.MissingPackageException

Class MissingPackageException

Declaration

class MissingPackageException(BaseException)
source link

Methods

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.utils.package.html b/latest/python/apidoc/hyperqueue.utils.package.html index 0ca8f59d2..f1aa975ba 100644 --- a/latest/python/apidoc/hyperqueue.utils.package.html +++ b/latest/python/apidoc/hyperqueue.utils.package.html @@ -1 +1 @@ -hyperqueue.utils.package

Module package

source link

Classes

\ No newline at end of file +hyperqueue.utils.package

Module package

source link

Classes

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.utils.string.html b/latest/python/apidoc/hyperqueue.utils.string.html index e65c39b7c..4ed0631eb 100644 --- a/latest/python/apidoc/hyperqueue.utils.string.html +++ b/latest/python/apidoc/hyperqueue.utils.string.html @@ -1 +1 @@ -hyperqueue.utils.string

Module string

source link

Functions

\ No newline at end of file +hyperqueue.utils.string

Module string

source link

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.validation.ValidationException.html b/latest/python/apidoc/hyperqueue.validation.ValidationException.html index 9d47771fb..e25288c1d 100644 --- a/latest/python/apidoc/hyperqueue.validation.ValidationException.html +++ b/latest/python/apidoc/hyperqueue.validation.ValidationException.html @@ -1 +1 @@ -hyperqueue.validation.ValidationException

Class ValidationException

Declaration

class ValidationException(BaseException)
source link

Reexports

\ No newline at end of file +hyperqueue.validation.ValidationException

Class ValidationException

Declaration

class ValidationException(BaseException)
source link

Reexports

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.validation.html b/latest/python/apidoc/hyperqueue.validation.html index 594fa8952..385315c82 100644 --- a/latest/python/apidoc/hyperqueue.validation.html +++ b/latest/python/apidoc/hyperqueue.validation.html @@ -1 +1 @@ -hyperqueue.validation

Module validation

source link

Classes

Functions

\ No newline at end of file +hyperqueue.validation

Module validation

source link

Classes

Functions

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.visualization.html b/latest/python/apidoc/hyperqueue.visualization.html index fff5607f2..2a597fa7c 100644 --- a/latest/python/apidoc/hyperqueue.visualization.html +++ b/latest/python/apidoc/hyperqueue.visualization.html @@ -1 +1 @@ -hyperqueue.visualization

Module visualization

source link

Functions

  • def visualize_job(job: Job, path: GenericPath)

    Visualizes the task graph of the passed job in the DOT format. The result is written to a file located at path.

    Note: this function requires the pydot package to be installed.

\ No newline at end of file +hyperqueue.visualization

Module visualization

source link

Functions

  • def visualize_job(job: Job, path: GenericPath)

    Visualizes the task graph of the passed job in the DOT format. The result is written to a file located at path.

    Note: this function requires the pydot package to be installed.

\ No newline at end of file diff --git a/latest/python/apidoc/index.html b/latest/python/apidoc/index.html index 9e5392f47..16a8551d4 100644 --- a/latest/python/apidoc/index.html +++ b/latest/python/apidoc/index.html @@ -1 +1 @@ -hyperqueue

Module hyperqueue

This is the Python API of HyperQueue.

Important classes:

  • Client serves for connecting to a HyperQueue server.
  • LocalCluster can be used to spawn a local HyperQueue cluster.
  • Job describes a job containing a directed acyclic graph of tasks. It can be submitted using a client.
source link

Re-exported Classes

  • class Client

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

    [hyperqueue.client.Client]
  • class Job

    Represents a HQ job.

    [hyperqueue.job.Job]
  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

    [hyperqueue.cluster.LocalCluster]

Re-exported Functions

Submodules

\ No newline at end of file +hyperqueue

Module hyperqueue

This is the Python API of HyperQueue.

Important classes:

  • Client serves for connecting to a HyperQueue server.
  • LocalCluster can be used to spawn a local HyperQueue cluster.
  • Job describes a job containing a directed acyclic graph of tasks. It can be submitted using a client.
source link

Re-exported Classes

  • class Client

    A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.

    [hyperqueue.client.Client]
  • class Job

    Represents a HQ job.

    [hyperqueue.job.Job]
  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

    [hyperqueue.cluster.LocalCluster]

Re-exported Functions

Submodules

\ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.__init__.py.html b/latest/python/apidoc/source+hyperqueue.__init__.py.html index 281658539..e56b6f6cf 100644 --- a/latest/python/apidoc/source+hyperqueue.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.__init__.py.html @@ -31,4 +31,4 @@ from .cluster import LocalCluster # noqa: F401 from .ffi import get_version # noqa: F401 from .job import Job # noqa: F401 - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.client.py.html b/latest/python/apidoc/source+hyperqueue.client.py.html index 612c1d8f2..302ac6e7c 100644 --- a/latest/python/apidoc/source+hyperqueue.client.py.html +++ b/latest/python/apidoc/source+hyperqueue.client.py.html @@ -285,4 +285,4 @@ bar.update(delta) return cb - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.cluster.__init__.py.html b/latest/python/apidoc/source+hyperqueue.cluster.__init__.py.html index 073dc4e00..0bd8f9b33 100644 --- a/latest/python/apidoc/source+hyperqueue.cluster.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.cluster.__init__.py.html @@ -143,4 +143,4 @@ def __exit__(self, exc_type, exc_val, exc_tb): self.stop() - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.common.py.html b/latest/python/apidoc/source+hyperqueue.common.py.html index 315d5bca9..2044a83a8 100644 --- a/latest/python/apidoc/source+hyperqueue.common.py.html +++ b/latest/python/apidoc/source+hyperqueue.common.py.html @@ -5,4 +5,4 @@ from typing import Union GenericPath = Union[Path, str] - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.ffi.__init__.py.html b/latest/python/apidoc/source+hyperqueue.ffi.__init__.py.html index a11a95a87..f7ad103cf 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.__init__.py.html @@ -13,4 +13,4 @@ def get_version() -> str: return ffi.get_hq_version() - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.ffi.client.py.html b/latest/python/apidoc/source+hyperqueue.ffi.client.py.html index 58a46f791..048b3df70 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.client.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.client.py.html @@ -111,4 +111,4 @@ def forget_job(self, job_id: JobId): return ffi.forget_job(self.ctx, job_id) - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.ffi.cluster.py.html b/latest/python/apidoc/source+hyperqueue.ffi.cluster.py.html index a8e1d7d29..0367f4457 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.cluster.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.cluster.py.html @@ -49,4 +49,4 @@ def stop(self): return self.ctx.stop() - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.ffi.protocol.py.html b/latest/python/apidoc/source+hyperqueue.ffi.protocol.py.html index 15da00d0f..d99599726 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.protocol.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.protocol.py.html @@ -97,4 +97,4 @@ class JobDescription: tasks: List[TaskDescription] max_fails: Optional[int] - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.job.py.html b/latest/python/apidoc/source+hyperqueue.job.py.html index b17fd82bb..84c584f27 100644 --- a/latest/python/apidoc/source+hyperqueue.job.py.html +++ b/latest/python/apidoc/source+hyperqueue.job.py.html @@ -353,4 +353,4 @@ if env: environment.update(env) return environment - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.output.py.html b/latest/python/apidoc/source+hyperqueue.output.py.html index 6757f1c2e..2946dc5dc 100644 --- a/latest/python/apidoc/source+hyperqueue.output.py.html +++ b/latest/python/apidoc/source+hyperqueue.output.py.html @@ -171,4 +171,4 @@ elif isinstance(collection, Output): items = [collection] return [item for item in items if isinstance(item, Output)] - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.task.function.__init__.py.html b/latest/python/apidoc/source+hyperqueue.task.function.__init__.py.html index 9c2db7974..73dee4797 100644 --- a/latest/python/apidoc/source+hyperqueue.task.function.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.function.__init__.py.html @@ -309,4 +309,4 @@ if hasattr(fn, "__name__"): return f"{fn.__name__}/{id}" return None - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.task.function.wrapper.py.html b/latest/python/apidoc/source+hyperqueue.task.function.wrapper.py.html index 8c265a24d..077d399c2 100644 --- a/latest/python/apidoc/source+hyperqueue.task.function.wrapper.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.function.wrapper.py.html @@ -121,4 +121,4 @@ self.__class__, (None, self._get_pickled_fn(), self.cache, self.protocol), ) - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.task.program.py.html b/latest/python/apidoc/source+hyperqueue.task.program.py.html index 1cdd3dd35..844d9ae5d 100644 --- a/latest/python/apidoc/source+hyperqueue.task.program.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.program.py.html @@ -197,4 +197,4 @@ raise ValidationException(f"Output `{output.name}` has been defined multiple times") output_map[output.name] = output return output_map - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.task.task.py.html b/latest/python/apidoc/source+hyperqueue.task.task.py.html index b1d4443f7..359d4463d 100644 --- a/latest/python/apidoc/source+hyperqueue.task.task.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.task.py.html @@ -139,4 +139,4 @@ raise ValidationException( f"Invalid value provided for `{stream}`: {type(stdio)}. Expected str, Path or `StdioDef` or `None`." ) - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.utils.package.py.html b/latest/python/apidoc/source+hyperqueue.utils.package.py.html index 7192a744e..c545f3ee1 100644 --- a/latest/python/apidoc/source+hyperqueue.utils.package.py.html +++ b/latest/python/apidoc/source+hyperqueue.utils.package.py.html @@ -9,4 +9,4 @@ def __str__(self): return f"Unable to import `{self.package}`. You have to install the `{self.package}` package." - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.utils.string.py.html b/latest/python/apidoc/source+hyperqueue.utils.string.py.html index 46156a098..6e6111784 100644 --- a/latest/python/apidoc/source+hyperqueue.utils.string.py.html +++ b/latest/python/apidoc/source+hyperqueue.utils.string.py.html @@ -5,4 +5,4 @@ if count == 1: return text return f"{text}s" - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.validation.py.html b/latest/python/apidoc/source+hyperqueue.validation.py.html index 6e50a4225..b9410e248 100644 --- a/latest/python/apidoc/source+hyperqueue.validation.py.html +++ b/latest/python/apidoc/source+hyperqueue.validation.py.html @@ -29,4 +29,4 @@ "Each program argument must either be a string or an instance of `hq.Output`. " f"Argument `{arg}` has type `{type(arg)}`." ) - \ No newline at end of file + \ No newline at end of file diff --git a/latest/python/apidoc/source+hyperqueue.visualization.py.html b/latest/python/apidoc/source+hyperqueue.visualization.py.html index 940282cbd..29570864d 100644 --- a/latest/python/apidoc/source+hyperqueue.visualization.py.html +++ b/latest/python/apidoc/source+hyperqueue.visualization.py.html @@ -79,4 +79,4 @@ visit(task) graph.write(path) - \ No newline at end of file + \ No newline at end of file diff --git a/latest/sitemap.xml.gz b/latest/sitemap.xml.gz index c34fe5203be4a46a6cddd202df154fdc59e6a4ae..fef031be206c54457392b90f9a53583230bf0f33 100644 GIT binary patch delta 15 WcmX@be2SS(zMF%iWa&n>Ba8qim;~?u delta 15 WcmX@be2SS(zMF$1VBto#Ba8qhtOUpa