From 826755f3182107ca659b92c5f393351e4692631e Mon Sep 17 00:00:00 2001 From: gh-ci-deploy-docs Date: Mon, 21 Oct 2024 07:45:36 +0000 Subject: [PATCH] Deployed 135c7fdf to latest with MkDocs 1.2.4 and mike 1.1.2 --- latest/examples/index.html | 2 +- .../examples/iterative-computation/index.html | 2 +- .../apidoc/hyperqueue.client.Client.html | 2 +- ...hyperqueue.client.FailedJobsException.html | 2 +- latest/python/apidoc/hyperqueue.client.html | 2 +- .../hyperqueue.cluster.LocalCluster.html | 2 +- .../hyperqueue.cluster.WorkerConfig.html | 2 +- latest/python/apidoc/hyperqueue.cluster.html | 2 +- latest/python/apidoc/hyperqueue.common.html | 2 +- ...yperqueue.ffi.client.ClientConnection.html | 2 +- ...perqueue.ffi.client.FailedTaskContext.html | 2 +- ...hyperqueue.ffi.client.HqClientContext.html | 2 +- .../python/apidoc/hyperqueue.ffi.client.html | 2 +- .../hyperqueue.ffi.cluster.Cluster.html | 2 +- ...perqueue.ffi.cluster.HqClusterContext.html | 2 +- .../python/apidoc/hyperqueue.ffi.cluster.html | 2 +- latest/python/apidoc/hyperqueue.ffi.html | 2 +- ...yperqueue.ffi.protocol.JobDescription.html | 2 +- ...perqueue.ffi.protocol.ResourceRequest.html | 2 +- ...perqueue.ffi.protocol.TaskDescription.html | 2 +- .../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 +- .../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 +- ...perqueue.task.function.PythonFunction.html | 2 +- .../apidoc/hyperqueue.task.function.html | 2 +- ...ue.task.function.wrapper.CloudWrapper.html | 2 +- .../hyperqueue.task.function.wrapper.html | 2 +- latest/python/apidoc/hyperqueue.task.html | 2 +- ...perqueue.task.program.ExternalProgram.html | 2 +- .../apidoc/hyperqueue.task.program.html | 2 +- .../apidoc/hyperqueue.task.task.Task.html | 2 +- .../python/apidoc/hyperqueue.task.task.html | 2 +- latest/python/apidoc/hyperqueue.utils.html | 2 +- ...utils.package.MissingPackageException.html | 2 +- .../apidoc/hyperqueue.utils.package.html | 2 +- .../apidoc/hyperqueue.utils.string.html | 2 +- ...rqueue.validation.ValidationException.html | 2 +- .../python/apidoc/hyperqueue.validation.html | 2 +- .../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 +- .../source+hyperqueue.ffi.client.py.html | 2 +- .../source+hyperqueue.ffi.cluster.py.html | 2 +- .../source+hyperqueue.ffi.protocol.py.html | 2 +- .../apidoc/source+hyperqueue.job.py.html | 2 +- .../apidoc/source+hyperqueue.output.py.html | 2 +- ...+hyperqueue.task.function.__init__.py.html | 2 +- ...e+hyperqueue.task.function.wrapper.py.html | 2 +- .../source+hyperqueue.task.program.py.html | 2 +- .../source+hyperqueue.task.task.py.html | 2 +- .../source+hyperqueue.utils.package.py.html | 2 +- .../source+hyperqueue.utils.string.py.html | 2 +- .../source+hyperqueue.validation.py.html | 2 +- .../source+hyperqueue.visualization.py.html | 2 +- latest/sitemap.xml | 60 +++++++++--------- latest/sitemap.xml.gz | Bin 452 -> 451 bytes 66 files changed, 94 insertions(+), 94 deletions(-) diff --git a/latest/examples/index.html b/latest/examples/index.html index 1788e9347..8f801389d 100644 --- a/latest/examples/index.html +++ b/latest/examples/index.html @@ -1 +1 @@ - Examples - HyperQueue
Skip to content

Examples#

Here you can find several examples of how HyperQueue can be used for various use-cases, both with the command-line interface and also with the Python API.

You can view these examples either in the documentation or on GitHub.

Last update: October 17, 2024
Created: October 17, 2024
Back to top
\ No newline at end of file + Examples - HyperQueue
Skip to content

Examples#

Here you can find several examples of how HyperQueue can be used for various use-cases, both with the command-line interface and also with the Python API.

You can view these examples either in the documentation or on GitHub.

Last update: October 21, 2024
Created: October 21, 2024
Back to top
\ No newline at end of file diff --git a/latest/examples/iterative-computation/index.html b/latest/examples/iterative-computation/index.html index dc5981595..cabcd86d2 100644 --- a/latest/examples/iterative-computation/index.html +++ b/latest/examples/iterative-computation/index.html @@ -32,4 +32,4 @@ break fi done -
Last update: October 17, 2024
Created: October 17, 2024
Back to top
\ No newline at end of file +
Last update: October 21, 2024
Created: October 21, 2024
Back to top
\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.client.Client.html b/latest/python/apidoc/hyperqueue.client.Client.html index 6ad093d22..2fb730cbb 100644 --- a/latest/python/apidoc/hyperqueue.client.Client.html +++ b/latest/python/apidoc/hyperqueue.client.Client.html @@ -1 +1 @@ -hyperqueue.client.Client

hyperqueue

0.20.0

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,
    )
    source link

    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.

    source link

    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.

    source link

    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

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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,
    )
    source link

    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.

    source link

    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.

    source link

    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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 aa1f2f1b6..91f05c0dc 100644 --- a/latest/python/apidoc/hyperqueue.client.FailedJobsException.html +++ b/latest/python/apidoc/hyperqueue.client.FailedJobsException.html @@ -1 +1 @@ -hyperqueue.client.FailedJobsException

hyperqueue

0.20.0

Class FailedJobsException

This exception is triggered if a task fails.

Declaration

class FailedJobsException(Exception)
source link

Documentation

Methods

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class FailedJobsException

This exception is triggered if a task fails.

Declaration

class FailedJobsException(Exception)
source link

Documentation

Methods

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.client

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 08f3b157b..6e3e73bb4 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

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 4fe9db8f0..c4aa12604 100644 --- a/latest/python/apidoc/hyperqueue.cluster.WorkerConfig.html +++ b/latest/python/apidoc/hyperqueue.cluster.WorkerConfig.html @@ -1 +1 @@ -hyperqueue.cluster.WorkerConfig

hyperqueue

0.20.0

Class WorkerConfig

Configuration of a worker spawned by a local cluster.

Declaration

@dataclasses.dataclass
class WorkerConfig
source link

Documentation

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class WorkerConfig

Configuration of a worker spawned by a local cluster.

Declaration

@dataclasses.dataclass
class WorkerConfig
source link

Documentation

Generated by nedoc v0.10 at 2024-10-21 07:45

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.cluster.html b/latest/python/apidoc/hyperqueue.cluster.html index 7bbd5a29f..2fad5afe8 100644 --- a/latest/python/apidoc/hyperqueue.cluster.html +++ b/latest/python/apidoc/hyperqueue.cluster.html @@ -1 +1 @@ -hyperqueue.cluster

hyperqueue

0.20.0

Module cluster

source link

Classes

  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

  • class WorkerConfig

    Configuration of a worker spawned by a local cluster.

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.cluster

hyperqueue

0.20.0

Module cluster

source link

Classes

  • class LocalCluster

    Represents a local deployed HyperQueue infrastructure.

  • class WorkerConfig

    Configuration of a worker spawned by a local cluster.

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

Module common

source link

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.common

hyperqueue

0.20.0

Module common

source link

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 768c740cd..cace6de04 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

hyperqueue

0.20.0

Class ClientConnection

Declaration

class ClientConnection
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class ClientConnection

Declaration

class ClientConnection
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 c2f408fa6..971fc483f 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

hyperqueue

0.20.0

Class FailedTaskContext

Declaration

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

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class FailedTaskContext

Declaration

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

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 a90d86722..600c38eb4 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

hyperqueue

0.20.0

Class HqClientContext

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

Declaration

class HqClientContext
source link

Documentation

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class HqClientContext

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

Declaration

class HqClientContext
source link

Documentation

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 0452a2d1e..bfd58a9b8 100644 --- a/latest/python/apidoc/hyperqueue.ffi.client.html +++ b/latest/python/apidoc/hyperqueue.ffi.client.html @@ -1 +1 @@ -hyperqueue.ffi.client

hyperqueue

0.20.0

Module client

source link

Classes

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module client

source link

Classes

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 7cf89e1f3..707d0ff7a 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

hyperqueue

0.20.0

Class Cluster

Declaration

class Cluster
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class Cluster

Declaration

class Cluster
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 76fbf17e8..063faa8d6 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

hyperqueue

0.20.0

Class HqClusterContext

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

Declaration

class HqClusterContext
source link

Documentation

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class HqClusterContext

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

Declaration

class HqClusterContext
source link

Documentation

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 da14ab4d4..fda3abe1b 100644 --- a/latest/python/apidoc/hyperqueue.ffi.cluster.html +++ b/latest/python/apidoc/hyperqueue.ffi.cluster.html @@ -1 +1 @@ -hyperqueue.ffi.cluster

hyperqueue

0.20.0

Module cluster

source link

Classes

  • class Cluster

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

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module cluster

source link

Classes

  • class Cluster

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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.ffi.html b/latest/python/apidoc/hyperqueue.ffi.html index 8df74d3a5..45fff5804 100644 --- a/latest/python/apidoc/hyperqueue.ffi.html +++ b/latest/python/apidoc/hyperqueue.ffi.html @@ -1 +1 @@ -hyperqueue.ffi

hyperqueue

0.20.0

Module ffi

source link

Functions

Submodules

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.ffi

hyperqueue

0.20.0

Module ffi

source link

Functions

Submodules

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 775ad7477..59afc7352 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

hyperqueue

0.20.0

Class JobDescription

Declaration

@dataclasses.dataclass
class JobDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class JobDescription

Declaration

@dataclasses.dataclass
class JobDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 2db818c07..fa1748397 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

hyperqueue

0.20.0

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,
    )
    source link
  • ▷ def __repr__(self)
    source link

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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,
    )
    source link
  • ▷ def __repr__(self)
    source link

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 2b4c590db..146f3aba2 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

hyperqueue

0.20.0

Class TaskDescription

Declaration

@dataclasses.dataclass()
class TaskDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class TaskDescription

Declaration

@dataclasses.dataclass()
class TaskDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 430507ef0..6da4f2bec 100644 --- a/latest/python/apidoc/hyperqueue.ffi.protocol.html +++ b/latest/python/apidoc/hyperqueue.ffi.protocol.html @@ -1 +1 @@ -hyperqueue.ffi.protocol

hyperqueue

0.20.0

Module protocol

source link

Classes

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module protocol

source link

Classes

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 852e954c8..6dab8b8b9 100644 --- a/latest/python/apidoc/hyperqueue.job.Job.html +++ b/latest/python/apidoc/hyperqueue.job.Job.html @@ -1 +1 @@ -hyperqueue.job.Job

hyperqueue

0.20.0

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,
    )
    source link

    Parameters

    • default_workdir: Optional[GenericPath]

      Default working directory for tasks.

    • max_fails: Optional[int]

      How many tasks can fail before the whole job will be cancelled.

    • default_env: Optional[EnvType]

      Environment variables that will be automatically set for each task in this job.

  • ▶ def function(self, fn, *, args=(), kwargs=None, ...) -> PythonFunction

    Creates a new task that will execute the provided Python function.

    def function(
    self,
    fn,
    *,
    args=(),
    kwargs=None,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = default_stdout(),
    stderr: Optional[Stdio] = default_stderr(),
    deps: Sequence[Task] = (),
    name: Optional[str] = None,
    priority: int = 0,
    resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
    ) -> PythonFunction
    source link

    Parameters

    • args: None

      Positional arguments that will be passed to the Python function.

    • kwargs: None

      Keyword arguments that will be passed to the Python function.

    • env: Optional[EnvType]

      Environment variables passed to the executed command.

    • cwd: Optional[GenericPath]

      Working directory of the executed command.

    • stdout: Optional[Stdio]

      Path to a file that will store the standard output of the executed command.

    • stderr: Optional[Stdio]

      Path to a file that will store the standard error output of the executed command.

    • deps: Sequence[Task]

      A sequence of dependencies that have to be completed first before this task can start executing.

    • name: Optional[str]

      Name of the task.

    • priority: int

      Priority of the created task.

    • resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]]

      List of resource requests required by this task.

  • ▶ def program(self, args: ProgramArgs, *, env: Optional[EnvType] = None, ...) -> ExternalProgram

    Creates a new task that will execute the provided command.

    def program(
    self,
    args: ProgramArgs,
    *,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = default_stdout(),
    stderr: Optional[Stdio] = default_stderr(),
    stdin: Optional[Union[str, bytes]] = None,
    deps: Sequence[Task] = (),
    name: Optional[str] = None,
    task_dir: bool = False,
    priority: int = 0,
    resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
    ) -> ExternalProgram
    source link

    Parameters

    • args: ProgramArgs

      List of arguments will be executed. The arguments have to be strings.

    • env: Optional[EnvType]

      Environment variables passed to the executed command.

    • cwd: Optional[GenericPath]

      Working directory of the executed command.

    • stdout: Optional[Stdio]

      Path to a file that will store the standard output of the executed command.

    • stderr: Optional[Stdio]

      Path to a file that will store the standard error output of the executed command.

    • stdin: Optional[Union[str, bytes]]

      If provided, these bytes will be passed as the standard input of the executed command.

    • deps: Sequence[Task]

      A sequence of dependencies that have to be completed first before this task can start executing.

    • name: Optional[str]

      Name of the task.

    • task_dir: bool

      If True, an isolated directory will be created for the task.

    • priority: int

      Priority of the created task.

    • resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]]

      List of resource requests required by this task.

  • ▷ def task_by_id(self, id: TaskId) -> Optional[Task]

    Finds a task with the given ID.

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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,
    )
    source link

    Parameters

    • default_workdir: Optional[GenericPath]

      Default working directory for tasks.

    • max_fails: Optional[int]

      How many tasks can fail before the whole job will be cancelled.

    • default_env: Optional[EnvType]

      Environment variables that will be automatically set for each task in this job.

  • ▶ def function(self, fn, *, args=(), kwargs=None, ...) -> PythonFunction

    Creates a new task that will execute the provided Python function.

    def function(
    self,
    fn,
    *,
    args=(),
    kwargs=None,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = default_stdout(),
    stderr: Optional[Stdio] = default_stderr(),
    deps: Sequence[Task] = (),
    name: Optional[str] = None,
    priority: int = 0,
    resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
    ) -> PythonFunction
    source link

    Parameters

    • args: None

      Positional arguments that will be passed to the Python function.

    • kwargs: None

      Keyword arguments that will be passed to the Python function.

    • env: Optional[EnvType]

      Environment variables passed to the executed command.

    • cwd: Optional[GenericPath]

      Working directory of the executed command.

    • stdout: Optional[Stdio]

      Path to a file that will store the standard output of the executed command.

    • stderr: Optional[Stdio]

      Path to a file that will store the standard error output of the executed command.

    • deps: Sequence[Task]

      A sequence of dependencies that have to be completed first before this task can start executing.

    • name: Optional[str]

      Name of the task.

    • priority: int

      Priority of the created task.

    • resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]]

      List of resource requests required by this task.

  • ▶ def program(self, args: ProgramArgs, *, env: Optional[EnvType] = None, ...) -> ExternalProgram

    Creates a new task that will execute the provided command.

    def program(
    self,
    args: ProgramArgs,
    *,
    env: Optional[EnvType] = None,
    cwd: Optional[GenericPath] = None,
    stdout: Optional[Stdio] = default_stdout(),
    stderr: Optional[Stdio] = default_stderr(),
    stdin: Optional[Union[str, bytes]] = None,
    deps: Sequence[Task] = (),
    name: Optional[str] = None,
    task_dir: bool = False,
    priority: int = 0,
    resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]] = None,
    ) -> ExternalProgram
    source link

    Parameters

    • args: ProgramArgs

      List of arguments will be executed. The arguments have to be strings.

    • env: Optional[EnvType]

      Environment variables passed to the executed command.

    • cwd: Optional[GenericPath]

      Working directory of the executed command.

    • stdout: Optional[Stdio]

      Path to a file that will store the standard output of the executed command.

    • stderr: Optional[Stdio]

      Path to a file that will store the standard error output of the executed command.

    • stdin: Optional[Union[str, bytes]]

      If provided, these bytes will be passed as the standard input of the executed command.

    • deps: Sequence[Task]

      A sequence of dependencies that have to be completed first before this task can start executing.

    • name: Optional[str]

      Name of the task.

    • task_dir: bool

      If True, an isolated directory will be created for the task.

    • priority: int

      Priority of the created task.

    • resources: Optional[Union[ResourceRequest, Sequence[ResourceRequest]]]

      List of resource requests required by this task.

  • ▷ def task_by_id(self, id: TaskId) -> Optional[Task]

    Finds a task with the given ID.

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 66eb24e23..c706086c6 100644 --- a/latest/python/apidoc/hyperqueue.job.SubmittedJob.html +++ b/latest/python/apidoc/hyperqueue.job.SubmittedJob.html @@ -1 +1 @@ -hyperqueue.job.SubmittedJob

hyperqueue

0.20.0

Class SubmittedJob

Successfully submitted job.

Declaration

@dataclasses.dataclass
class SubmittedJob
source link

Documentation

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class SubmittedJob

Successfully submitted job.

Declaration

@dataclasses.dataclass
class SubmittedJob
source link

Documentation

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

Module job

source link

Classes

  • class Job

    Represents a HQ job.

  • class SubmittedJob

    Successfully submitted job.

Functions

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.job

hyperqueue

0.20.0

Module job

source link

Classes

  • class Job

    Represents a HQ job.

  • class SubmittedJob

    Successfully submitted job.

Functions

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 354a9eaf0..587d62365 100644 --- a/latest/python/apidoc/hyperqueue.output.Output.html +++ b/latest/python/apidoc/hyperqueue.output.Output.html @@ -1 +1 @@ -hyperqueue.output.Output

hyperqueue

0.20.0

Class Output

Declaration

class Output
source link

Methods

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

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class Output

Declaration

class Output
source link

Methods

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

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 c26b8cff6..3283bb103 100644 --- a/latest/python/apidoc/hyperqueue.output.StdioDef.html +++ b/latest/python/apidoc/hyperqueue.output.StdioDef.html @@ -1 +1 @@ -hyperqueue.output.StdioDef

hyperqueue

0.20.0

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)
    source link
  • ▷ def remove_if_finished(path: Optional[GenericPath] = None) -> StdioDef @staticmethod
    @staticmethod
    def remove_if_finished(path: Optional[GenericPath] = None)
    source link

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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)
    source link
  • ▷ def remove_if_finished(path: Optional[GenericPath] = None) -> StdioDef @staticmethod
    @staticmethod
    def remove_if_finished(path: Optional[GenericPath] = None)
    source link

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

Module output

source link

Classes

  • class Output
  • class StdioDef

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

Functions

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.output

hyperqueue

0.20.0

Module output

source link

Classes

  • class Output
  • class StdioDef

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

Functions

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 fc5ef0d0c..ed6b2ec18 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

hyperqueue

0.20.0

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",
    )
    source link

    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

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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",
    )
    source link

    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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 2338d02ad..03abd5897 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

hyperqueue

0.20.0

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,
    )
    source link

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

  • ▷ def __repr__(self)
    source link

Inherited methods

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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,
    )
    source link

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

  • ▷ def __repr__(self)
    source link

Inherited methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 ba8acfd0f..54625d424 100644 --- a/latest/python/apidoc/hyperqueue.task.function.html +++ b/latest/python/apidoc/hyperqueue.task.function.html @@ -1 +1 @@ -hyperqueue.task.function

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 21af1153b..04c66b690 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

hyperqueue

0.20.0

Class CloudWrapper

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

Declaration

class CloudWrapper
source link

Documentation

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class CloudWrapper

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

Declaration

class CloudWrapper
source link

Documentation

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 c1d273cf3..cef2312f5 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

hyperqueue

0.20.0

Module wrapper

source link

Classes

  • class CloudWrapper

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

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module wrapper

source link

Classes

  • class CloudWrapper

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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.html b/latest/python/apidoc/hyperqueue.task.html index 89a882c65..47b871350 100644 --- a/latest/python/apidoc/hyperqueue.task.html +++ b/latest/python/apidoc/hyperqueue.task.html @@ -1 +1 @@ -hyperqueue.task

hyperqueue

0.20.0

Module task

source link

Submodules

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.task

hyperqueue

0.20.0

Module task

source link

Submodules

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 6342e3965..94ab7f779 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

hyperqueue

0.20.0

Class ExternalProgram

Task that represents the execution of an executable binary.

Declaration

class ExternalProgram(Task)
source link

Documentation

Methods

  • ▷ def __getitem__(self, key: str)
    source link
  • ▶ 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],
    )
    source link

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

  • ▷ def __repr__(self)
    source link

Inherited methods

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class ExternalProgram

Task that represents the execution of an executable binary.

Declaration

class ExternalProgram(Task)
source link

Documentation

Methods

  • ▷ def __getitem__(self, key: str)
    source link
  • ▶ 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],
    )
    source link

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

  • ▷ def __repr__(self)
    source link

Inherited methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 37695e21c..4d866d3d7 100644 --- a/latest/python/apidoc/hyperqueue.task.program.html +++ b/latest/python/apidoc/hyperqueue.task.program.html @@ -1 +1 @@ -hyperqueue.task.program

hyperqueue

0.20.0

Module program

source link

Classes

  • Task that represents the execution of an executable binary.

Functions

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module program

source link

Classes

  • Task that represents the execution of an executable binary.

Functions

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 0a8b5357c..259a357da 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

hyperqueue

0.20.0

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,
    )
    source link

    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)
    source link

Subclasses

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

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,
    )
    source link

    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)
    source link

Subclasses

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 ae606c779..6c6f6e80e 100644 --- a/latest/python/apidoc/hyperqueue.task.task.html +++ b/latest/python/apidoc/hyperqueue.task.task.html @@ -1 +1 @@ -hyperqueue.task.task

hyperqueue

0.20.0

Module task

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module task

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-10-21 07:45

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.utils.html b/latest/python/apidoc/hyperqueue.utils.html index 89777cccd..12a746dbc 100644 --- a/latest/python/apidoc/hyperqueue.utils.html +++ b/latest/python/apidoc/hyperqueue.utils.html @@ -1 +1 @@ -hyperqueue.utils

hyperqueue

0.20.0

Module utils

source link

Submodules

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.utils

hyperqueue

0.20.0

Module utils

source link

Submodules

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 622baea1a..7fee15348 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

hyperqueue

0.20.0

Class MissingPackageException

Declaration

class MissingPackageException(BaseException)
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class MissingPackageException

Declaration

class MissingPackageException(BaseException)
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 ea74b16f7..781f2e797 100644 --- a/latest/python/apidoc/hyperqueue.utils.package.html +++ b/latest/python/apidoc/hyperqueue.utils.package.html @@ -1 +1 @@ -hyperqueue.utils.package

hyperqueue

0.20.0

Module package

source link

Classes

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module package

source link

Classes

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 5e0febb74..57fcc6318 100644 --- a/latest/python/apidoc/hyperqueue.utils.string.html +++ b/latest/python/apidoc/hyperqueue.utils.string.html @@ -1 +1 @@ -hyperqueue.utils.string

hyperqueue

0.20.0

Module string

source link

Functions

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Module string

source link

Functions

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 bd7e65fea..da35c651a 100644 --- a/latest/python/apidoc/hyperqueue.validation.ValidationException.html +++ b/latest/python/apidoc/hyperqueue.validation.ValidationException.html @@ -1 +1 @@ -hyperqueue.validation.ValidationException

hyperqueue

0.20.0

Class ValidationException

Declaration

class ValidationException(BaseException)
source link

Reexports

Generated by nedoc v0.10 at 2024-10-17 06:35

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

hyperqueue

0.20.0

Class ValidationException

Declaration

class ValidationException(BaseException)
source link

Reexports

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

Module validation

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.validation

hyperqueue

0.20.0

Module validation

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-10-21 07:45

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.visualization.html b/latest/python/apidoc/hyperqueue.visualization.html index 3f3d7bd20..68c47dc41 100644 --- a/latest/python/apidoc/hyperqueue.visualization.html +++ b/latest/python/apidoc/hyperqueue.visualization.html @@ -1 +1 @@ -hyperqueue.visualization

hyperqueue

0.20.0

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.

    source link

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

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue.visualization

hyperqueue

0.20.0

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.

    source link

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

Generated by nedoc v0.10 at 2024-10-21 07:45

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

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +hyperqueue

hyperqueue

0.20.0

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

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 7349cab83..0d2544268 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 -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 d5f133601..e59f30a8e 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 -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 e63de0b50..8e3d37521 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() -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 c83e513cf..fc96b5f45 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] -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 d4c601acd..2560027b9 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() -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 8c02f5659..f4db7bef2 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) -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 8e410a2ae..7b0139cf9 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() -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 20d0c30a1..50aa6d1fb 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] -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 2cb916d0c..9c20ef3b1 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 -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 3142994cc..9e84e31a3 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)] -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 d611ac042..4c2f74306 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 -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 0a88094fb..d8478fde8 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), ) -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 8ca0a4570..662a594dd 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 -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 4fd841a2d..5c825f45c 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`." ) -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 7ad95217c..7914e9ec0 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." -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 d876d0f50..9af676c1f 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" -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 d056238db..33876a5c1 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)}`." ) -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ 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 0da7b3a33..94f72bd53 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) -

Generated by nedoc v0.10 at 2024-10-17 06:35

\ No newline at end of file +

Generated by nedoc v0.10 at 2024-10-21 07:45

\ No newline at end of file diff --git a/latest/sitemap.xml b/latest/sitemap.xml index d5107616d..ffd6ba944 100644 --- a/latest/sitemap.xml +++ b/latest/sitemap.xml @@ -2,152 +2,152 @@ https://it4innovations.github.io/hyperqueue/stable/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/cheatsheet/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/faq/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/installation/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/other-tools/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/quickstart/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/cli/dashboard/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/cli/output-mode/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/cli/shortcuts/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/deployment/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/deployment/allocation/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/deployment/cloud/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/deployment/server/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/deployment/worker/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/examples/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/examples/iterative-computation/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/arrays/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/cresources/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/directives/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/failure/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/jobfile/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/jobs/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/multinode/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/openjobs/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/resources/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/jobs/streaming/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/python/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/python/client/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/python/dependencies/ - 2024-10-17 + 2024-10-21 daily https://it4innovations.github.io/hyperqueue/stable/python/submit/ - 2024-10-17 + 2024-10-21 daily \ No newline at end of file diff --git a/latest/sitemap.xml.gz b/latest/sitemap.xml.gz index a096221c63e013ada6ed594bdbe1796f32c5629f..8968068a4cedd3a2cbecbd0120dc1ff3b1d9acca 100644 GIT binary patch literal 451 zcmV;!0X+U6iwFpx1{P-m|8r?{Wo=<_E_iKh0M(bllAACLhVT0n8SdaDvxl}r*xNoq z`vAr$*j?KqmYghaUnR?Q@&KLA$OjObAMv3PLhj!_Q`}vlP{4d@4&A=lL3TKWJfE6h zKi}JL&D-$O*AfYMC*n+}#xpNJjJe%z9R-GD7wWLghMboRGMm%vyYJ2LvXgZW@MS$# zAJGl>C?sJ5zlNOgYFQYln*;kgb^(oF7buqs6%4T*BbeUYZ+wnpi4#u4aesVm5Bv6b z5Xt6yk~wel4CexuVX`5vy?OF{0h+&r|A?-Rj^9h!SYl6&Lv85}b)7KZD z-oQnylU8_wB6F2i`Wu!HW%TfA(-MJnLd(cpM1O_WVUk|2@5B9#BNqE2vyb&_i2khP7!4|H50>rA@ho=9B4rjTb<=*!Ap t*H$_OIS*j0Kjw#JjMKkg7m5tBtK!VZ#)~XJjk#X09S4DA7w(W|!_L?>_ONdc z->PKuJ;;Xh)nxv;_>KvZF$>{%6W$kmAPu2cn%;(=O0 zjI4_LT!MSAHtDKs7lWBB`w=Zo>d3LkQlzakppKnAlDHze%6x();+i0fR_xjp(dp}p z4{zWimPso-1J$`oEBzJeT^T)m*tA4oozQh;rmDX{>oC<`ukXYCgCiSDWLMV5?FbkP zIZ((x1p;>~9fj9wvd*L{?uje}HibN^LSI(# u%KrKra^2`@+bV73b?AjWL3Tk|op1bH#uWZT=I