From e325c88fbe86aee1374c5b73cc967131eb708c6b Mon Sep 17 00:00:00 2001 From: gh-ci-deploy-docs Date: Fri, 25 Oct 2024 07:30:17 +0000 Subject: [PATCH] Deployed 6f71973a 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 457 -> 457 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 3936aab16..b72bce6ab 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 173ab1ee3..65b07cc2c 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 127b1ec3e..e83a94aee 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 66fe92d59..091b5a46f 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 ed3429d43..85ae48729 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 5bc5fbe85..8aa7a54b7 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 3afe30d5a..489edd0ad 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 9be69f3e9..a3758d9e7 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 8869c6596..eee3465d5 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 3a8e02e8c..d308fa623 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 d47ea403a..f934c0c92 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 91d69756c..8d14589a2 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 ad903a7ce..5c21fa993 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 66b68cae7..0b1ef74a9 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 9da2d94a9..e48edda92 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 d3a077bab..8a5981983 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 c81da0355..0aef9d6fa 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 921f9153d..8f3be9ae8 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 83f2f01a9..89ec458e1 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 b1d23dd9e..d736aaf2a 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 63326e80e..cc8615ee0 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 db16d57cc..442b1125c 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 70037deec..c7ece5d07 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 e6dc66d62..fafe707bf 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 9702e4062..335a9af02 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 c40df0fe5..612cd59b3 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 183f6f3b4..3771a1c5e 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 aa29d9355..371d8a9f2 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 8f4c41259..010329c99 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 16da63cd7..d9fed7a3c 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 ec3291f35..d301b4529 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 f7f70557b..eacf6511a 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 2ee4a46e5..56114e79e 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 f13edee0f..7312badac 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 64823a98e..ba5be18e1 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 600514118..7b11a025e 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 cc91e1a1b..c4a4926df 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 de2115d61..aa0ed93f6 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 25b2c2999..a6827c96b 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 8c4f159de..252a94db2 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 16bf3c7de..af96c0815 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 6573f396f..96245a419 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 c2009a465..5b80fbb17 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 b1d23dd9e..d736aaf2a 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 2e9d9ceed..928dd182c 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 ac760b804..1fdc6e7f5 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 389ebbe59..ac7929e54 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 6c1215f4d..93ad00648 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 4017be34e..190c71c75 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 603b210b3..8736d08ec 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 a3f83e9a1..a0608326c 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 7c20240ee..c1834baca 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 b0a752a7d..0c4324d83 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 1b1152f62..be914d052 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 20ab0604c..4e72a2ac8 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 991c886a5..8bd2cc53e 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 0cff9ab38..fdfb6631e 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 705a2ffd2..8beec7f53 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 a167787e9..389ed633c 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 be0ce73d9..1a481ea27 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 d153530d5..c9ce159f9 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 664c3f9c4..455575052 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 febf3ea79f7746fd85a86af0830b6d8e15a4d069..add0117a73fc2879f7c61b3c72f20202780e8025 100644 GIT binary patch delta 15 WcmX@fe3F?>zMF%C({m%+VMYKWECeP1 delta 15 WcmX@fe3F?>zMF$X(|#k{VMYKWx&%A`