From b85828306aa2d7d0656f2ed2c8391f349f5d77a7 Mon Sep 17 00:00:00 2001 From: gh-ci-deploy-docs Date: Sun, 11 Feb 2024 09:19:19 +0000 Subject: [PATCH] Deployed 3f19eb87 to latest with MkDocs 1.2.3 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 | 4 ++-- .../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 | 4 ++-- .../apidoc/source+hyperqueue.client.py.html | 4 ++-- .../source+hyperqueue.cluster.__init__.py.html | 4 ++-- .../apidoc/source+hyperqueue.common.py.html | 4 ++-- .../source+hyperqueue.ffi.__init__.py.html | 4 ++-- .../apidoc/source+hyperqueue.ffi.client.py.html | 4 ++-- .../source+hyperqueue.ffi.cluster.py.html | 4 ++-- .../source+hyperqueue.ffi.protocol.py.html | 4 ++-- .../python/apidoc/source+hyperqueue.job.py.html | 4 ++-- .../apidoc/source+hyperqueue.output.py.html | 4 ++-- ...ce+hyperqueue.task.function.__init__.py.html | 4 ++-- ...rce+hyperqueue.task.function.wrapper.py.html | 4 ++-- .../source+hyperqueue.task.program.py.html | 4 ++-- .../apidoc/source+hyperqueue.task.task.py.html | 4 ++-- .../source+hyperqueue.utils.package.py.html | 4 ++-- .../source+hyperqueue.utils.string.py.html | 4 ++-- .../apidoc/source+hyperqueue.validation.py.html | 4 ++-- .../source+hyperqueue.visualization.py.html | 4 ++-- latest/sitemap.xml.gz | Bin 452 -> 452 bytes 63 files changed, 81 insertions(+), 81 deletions(-) diff --git a/latest/python/apidoc/hyperqueue.client.Client.html b/latest/python/apidoc/hyperqueue.client.Client.html index 1686cb6fb..ec9e07401 100644 --- a/latest/python/apidoc/hyperqueue.client.Client.html +++ b/latest/python/apidoc/hyperqueue.client.Client.html @@ -1 +1 @@ -hyperqueue.client.Client

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 0396139b7..92d341245 100644 --- a/latest/python/apidoc/hyperqueue.client.FailedJobsException.html +++ b/latest/python/apidoc/hyperqueue.client.FailedJobsException.html @@ -1 +1 @@ -hyperqueue.client.FailedJobsException

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

\ No newline at end of file +hyperqueue.client

hyperqueue

0.18.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-02-11 09:19

\ 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 522e25a10..5902726ca 100644 --- a/latest/python/apidoc/hyperqueue.cluster.LocalCluster.html +++ b/latest/python/apidoc/hyperqueue.cluster.LocalCluster.html @@ -1,5 +1,5 @@ -hyperqueue.cluster.LocalCluster

hyperqueue

0.17.0

Class LocalCluster

Represents a local deployed HyperQueue infrastructure.

Declaration

class LocalCluster
source link

Documentation

You can use LocalCluster to quickly spin up a HyperQueue server along with a set of workers locally.

The cluster can be used as a context manager. It will be stopped when the context ends:

with LocalCluster() as cluster:
+hyperqueue.cluster.LocalCluster
hyperqueue
 0.18.0 
Class LocalCluster
Represents a local deployed HyperQueue infrastructure.
Declaration
class LocalCluster
source link
Documentation
You can use LocalCluster to quickly spin up a HyperQueue server along with a set of workers locally.
The cluster can be used as a context manager. It will be stopped when the context ends:
with LocalCluster() as cluster:
     client = cluster.client()
     ...
 # The cluster was stopped
-
Methods
  • ▷ def __enter__(self) 
    source link
  • ▷ def __exit__(self, exc_type, exc_val, exc_tb) 
    source link
  • ▶ def __init__(self, server_dir: Optional[Path] = None, ...) 
    def __init__( 
    self,
    server_dir: Optional[Path] = None,
    worker_config: Optional[WorkerConfig] = None,
     ) 
    source link
    Parameters
    • server_dir: Optional[Path] 
      Server directory where will the cluster store its files. :param worker_config: Configuration of workers spawned in the cluster.
  • ▷ def client(self, **client_args) -> Client 
    Creates a client connected to this cluster.
  • ▷ def start_worker(self, config: WorkerConfig = None) 
    Adds a new worker with the given config to the cluster.
  • ▷ def stop(self) 
    Stops the server and all workers of this cluster.
Reexports
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Methods

  • ▷ def __enter__(self)
    source link
  • ▷ def __exit__(self, exc_type, exc_val, exc_tb)
    source link
  • ▶ def __init__(self, server_dir: Optional[Path] = None, ...)
    def __init__(
    self,
    server_dir: Optional[Path] = None,
    worker_config: Optional[WorkerConfig] = None,
    )
    source link

    Parameters

    • server_dir: Optional[Path]

      Server directory where will the cluster store its files. :param worker_config: Configuration of workers spawned in the cluster.

  • ▷ def client(self, **client_args) -> Client

    Creates a client connected to this cluster.

  • ▷ def start_worker(self, config: WorkerConfig = None)

    Adds a new worker with the given config to the cluster.

  • ▷ def stop(self)

    Stops the server and all workers of this cluster.

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.cluster.html b/latest/python/apidoc/hyperqueue.cluster.html index 51340dc12..1ac4290e1 100644 --- a/latest/python/apidoc/hyperqueue.cluster.html +++ b/latest/python/apidoc/hyperqueue.cluster.html @@ -1 +1 @@ -hyperqueue.cluster

hyperqueue

0.17.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-02-11 08:48

\ No newline at end of file +hyperqueue.cluster

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.0

Module common

source link

Generated by nedoc v0.10 at 2024-02-11 08:48

\ No newline at end of file +hyperqueue.common

hyperqueue

0.18.0

Module common

source link

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 30cf5741b..971eb2672 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.17.0

Class ClientConnection

Declaration

class ClientConnection
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class ClientConnection

Declaration

class ClientConnection
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 270e76dca..c1b87d1fe 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.17.0

Class FailedTaskContext

Declaration

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

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class FailedTaskContext

Declaration

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

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 159951c47..dd8e9bae1 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 29fdf78c6..3a9e6958f 100644 --- a/latest/python/apidoc/hyperqueue.ffi.client.html +++ b/latest/python/apidoc/hyperqueue.ffi.client.html @@ -1 +1 @@ -hyperqueue.ffi.client

hyperqueue

0.17.0

Module client

source link

Classes

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Module client

source link

Classes

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 09dac97f8..4928b430b 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.17.0

Class Cluster

Declaration

class Cluster
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class Cluster

Declaration

class Cluster
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 11dbac4f9..996696bdd 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.0

Module ffi

source link

Functions

Submodules

Generated by nedoc v0.10 at 2024-02-11 08:48

\ No newline at end of file +hyperqueue.ffi

hyperqueue

0.18.0

Module ffi

source link

Functions

Submodules

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 dee19c68d..131b4e8c8 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.17.0

Class JobDescription

Declaration

@dataclasses.dataclass
class JobDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class JobDescription

Declaration

@dataclasses.dataclass
class JobDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 1f23c5e37..9fb72ee51 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 e076934d4..d32a747c3 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.17.0

Class TaskDescription

Declaration

@dataclasses.dataclass()
class TaskDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class TaskDescription

Declaration

@dataclasses.dataclass()
class TaskDescription
source link

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 34df40d85..d0136ffcb 100644 --- a/latest/python/apidoc/hyperqueue.ffi.protocol.html +++ b/latest/python/apidoc/hyperqueue.ffi.protocol.html @@ -1 +1 @@ -hyperqueue.ffi.protocol

hyperqueue

0.17.0

Module protocol

source link

Classes

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Module protocol

source link

Classes

Generated by nedoc v0.10 at 2024-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

\ No newline at end of file +hyperqueue

hyperqueue

0.18.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-02-11 09:19

\ 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 5b0efb370..171665d52 100644 --- a/latest/python/apidoc/hyperqueue.job.Job.html +++ b/latest/python/apidoc/hyperqueue.job.Job.html @@ -1 +1 @@ -hyperqueue.job.Job

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.0

Class SubmittedJob

Successfully submitted job.

Declaration

@dataclasses.dataclass
class SubmittedJob
source link

Documentation

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class SubmittedJob

Successfully submitted job.

Declaration

@dataclasses.dataclass
class SubmittedJob
source link

Documentation

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.job.html b/latest/python/apidoc/hyperqueue.job.html index 5e62f2b9e..048d4c8e9 100644 --- a/latest/python/apidoc/hyperqueue.job.html +++ b/latest/python/apidoc/hyperqueue.job.html @@ -1 +1 @@ -hyperqueue.job

hyperqueue

0.17.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-02-11 08:48

\ No newline at end of file +hyperqueue.job

hyperqueue

0.18.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-02-11 09:19

\ 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 2feb02ae1..5712854b3 100644 --- a/latest/python/apidoc/hyperqueue.output.Output.html +++ b/latest/python/apidoc/hyperqueue.output.Output.html @@ -1 +1 @@ -hyperqueue.output.Output

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.0

Class StdioDef

Declaration

@dataclasses.dataclass
class StdioDef
source link

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-02-11 08:48

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

hyperqueue

0.18.0

Class StdioDef

Declaration

@dataclasses.dataclass
class StdioDef
source link

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-02-11 09:19

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

hyperqueue

0.17.0

Module output

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-02-11 08:48

\ No newline at end of file +hyperqueue.output

hyperqueue

0.18.0

Module output

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 d7b8f7482..7104e102a 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 58126228b..5dc1b6109 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 372ebf24c..553e19b46 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 8bd9be28e..7eb05c708 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.task.html b/latest/python/apidoc/hyperqueue.task.html index 646bad158..63af9a4dd 100644 --- a/latest/python/apidoc/hyperqueue.task.html +++ b/latest/python/apidoc/hyperqueue.task.html @@ -1 +1 @@ -hyperqueue.task

hyperqueue

0.17.0

Module task

source link

Submodules

Generated by nedoc v0.10 at 2024-02-11 08:48

\ No newline at end of file +hyperqueue.task

hyperqueue

0.18.0

Module task

source link

Submodules

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 57f9fc775..258a96fc1 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 ac53d4004..9da60d7e8 100644 --- a/latest/python/apidoc/hyperqueue.task.program.html +++ b/latest/python/apidoc/hyperqueue.task.program.html @@ -1 +1 @@ -hyperqueue.task.program

hyperqueue

0.17.0

Module program

source link

Classes

  • Task that represents the execution of an executable binary.

Functions

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Module program

source link

Classes

  • Task that represents the execution of an executable binary.

Functions

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 0257ec3eb..e3472c09e 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.17.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-02-11 08:48

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

hyperqueue

0.18.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-02-11 09:19

\ 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 462987fc5..3f93b5be1 100644 --- a/latest/python/apidoc/hyperqueue.task.task.html +++ b/latest/python/apidoc/hyperqueue.task.task.html @@ -1 +1 @@ -hyperqueue.task.task

hyperqueue

0.17.0

Module task

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Module task

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-02-11 09:19

\ No newline at end of file diff --git a/latest/python/apidoc/hyperqueue.utils.html b/latest/python/apidoc/hyperqueue.utils.html index dbef1c210..6b7a385dd 100644 --- a/latest/python/apidoc/hyperqueue.utils.html +++ b/latest/python/apidoc/hyperqueue.utils.html @@ -1 +1 @@ -hyperqueue.utils

hyperqueue

0.17.0

Module utils

source link

Submodules

Generated by nedoc v0.10 at 2024-02-11 08:48

\ No newline at end of file +hyperqueue.utils

hyperqueue

0.18.0

Module utils

source link

Submodules

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 06ac5eb94..f6a187d96 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.17.0

Class MissingPackageException

Declaration

class MissingPackageException(BaseException)
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class MissingPackageException

Declaration

class MissingPackageException(BaseException)
source link

Methods

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

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

hyperqueue

0.17.0

Module package

source link

Classes

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Module package

source link

Classes

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 e88d70a08..2d9dd5092 100644 --- a/latest/python/apidoc/hyperqueue.utils.string.html +++ b/latest/python/apidoc/hyperqueue.utils.string.html @@ -1 +1 @@ -hyperqueue.utils.string

hyperqueue

0.17.0

Module string

source link

Functions

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Module string

source link

Functions

Generated by nedoc v0.10 at 2024-02-11 09:19

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

hyperqueue

0.17.0

Class ValidationException

Declaration

class ValidationException(BaseException)
source link

Reexports

Generated by nedoc v0.10 at 2024-02-11 08:48

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

hyperqueue

0.18.0

Class ValidationException

Declaration

class ValidationException(BaseException)
source link

Reexports

Generated by nedoc v0.10 at 2024-02-11 09:19

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

hyperqueue

0.17.0

Module validation

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-02-11 08:48

\ No newline at end of file +hyperqueue.validation

hyperqueue

0.18.0

Module validation

source link

Classes

Functions

Generated by nedoc v0.10 at 2024-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

\ No newline at end of file +hyperqueue.visualization

hyperqueue

0.18.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-02-11 09:19

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

hyperqueue

0.17.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-02-11 08:48

\ No newline at end of file +hyperqueue

hyperqueue

0.18.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-02-11 09:19

\ 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 ff61aa08b..d721216a2 100644 --- a/latest/python/apidoc/source+hyperqueue.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.__init__.py.html @@ -1,4 +1,4 @@ -hyperqueue

hyperqueue

0.17.0

Source code hyperqueue/__init__.py

 1
+hyperqueue
hyperqueue
 0.18.0 
Source code hyperqueue/__init__.py
 1
  2
  3
  4
@@ -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-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 84a910424..d55a5f058 100644 --- a/latest/python/apidoc/source+hyperqueue.client.py.html +++ b/latest/python/apidoc/source+hyperqueue.client.py.html @@ -1,4 +1,4 @@ -hyperqueue.client

hyperqueue

0.17.0

Source code hyperqueue/client.py

  1
+hyperqueue.client
hyperqueue
 0.18.0 
Source code hyperqueue/client.py
  1
   2
   3
   4
@@ -285,4 +285,4 @@
             bar.update(delta)
 
     return cb
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 06b448168..e2bc1b084 100644 --- a/latest/python/apidoc/source+hyperqueue.cluster.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.cluster.__init__.py.html @@ -1,4 +1,4 @@ -hyperqueue.cluster

hyperqueue

0.17.0

Source code hyperqueue/cluster/__init__.py

 1
+hyperqueue.cluster
hyperqueue
 0.18.0 
Source code hyperqueue/cluster/__init__.py
 1
  2
  3
  4
@@ -143,4 +143,4 @@
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         self.stop()
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 5a7e0d77c..c360da82f 100644 --- a/latest/python/apidoc/source+hyperqueue.common.py.html +++ b/latest/python/apidoc/source+hyperqueue.common.py.html @@ -1,8 +1,8 @@ -hyperqueue.common

hyperqueue

0.17.0

Source code hyperqueue/common.py

1
+hyperqueue.common
hyperqueue
 0.18.0 
Source code hyperqueue/common.py
1
 2
 3
 4
from pathlib import Path
 from typing import Union
 
 GenericPath = Union[Path, str]
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 22a5071bb..9ab4f2ad2 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.__init__.py.html @@ -1,4 +1,4 @@ -hyperqueue.ffi

hyperqueue

0.17.0

Source code hyperqueue/ffi/__init__.py

1
+hyperqueue.ffi
hyperqueue
 0.18.0 
Source code hyperqueue/ffi/__init__.py
1
 2
 3
 4
@@ -13,4 +13,4 @@
 
 def get_version() -> str:
     return ffi.get_hq_version()
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 7af6401ee..0aee5a91e 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.client.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.client.py.html @@ -1,4 +1,4 @@ -hyperqueue.ffi.client

hyperqueue

0.17.0

Source code hyperqueue/ffi/client.py

 1
+hyperqueue.ffi.client
hyperqueue
 0.18.0 
Source code hyperqueue/ffi/client.py
 1
  2
  3
  4
@@ -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-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 a81b5705f..99a68a7a8 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.cluster.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.cluster.py.html @@ -1,4 +1,4 @@ -hyperqueue.ffi.cluster

hyperqueue

0.17.0

Source code hyperqueue/ffi/cluster.py

 1
+hyperqueue.ffi.cluster
hyperqueue
 0.18.0 
Source code hyperqueue/ffi/cluster.py
 1
  2
  3
  4
@@ -49,4 +49,4 @@
 
     def stop(self):
         return self.ctx.stop()
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 f98a069b9..17c8c080c 100644 --- a/latest/python/apidoc/source+hyperqueue.ffi.protocol.py.html +++ b/latest/python/apidoc/source+hyperqueue.ffi.protocol.py.html @@ -1,4 +1,4 @@ -hyperqueue.ffi.protocol

hyperqueue

0.17.0

Source code hyperqueue/ffi/protocol.py

 1
+hyperqueue.ffi.protocol
hyperqueue
 0.18.0 
Source code hyperqueue/ffi/protocol.py
 1
  2
  3
  4
@@ -97,4 +97,4 @@
 class JobDescription:
     tasks: List[TaskDescription]
     max_fails: Optional[int]
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 60b46bf2f..671e71257 100644 --- a/latest/python/apidoc/source+hyperqueue.job.py.html +++ b/latest/python/apidoc/source+hyperqueue.job.py.html @@ -1,4 +1,4 @@ -hyperqueue.job

hyperqueue

0.17.0

Source code hyperqueue/job.py

  1
+hyperqueue.job
hyperqueue
 0.18.0 
Source code hyperqueue/job.py
  1
   2
   3
   4
@@ -353,4 +353,4 @@
     if env:
         environment.update(env)
     return environment
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 4f6989539..54189bf84 100644 --- a/latest/python/apidoc/source+hyperqueue.output.py.html +++ b/latest/python/apidoc/source+hyperqueue.output.py.html @@ -1,4 +1,4 @@ -hyperqueue.output

hyperqueue

0.17.0

Source code hyperqueue/output.py

 1
+hyperqueue.output
hyperqueue
 0.18.0 
Source code hyperqueue/output.py
 1
  2
  3
  4
@@ -163,4 +163,4 @@
     elif isinstance(collection, Output):
         items = [collection]
     return [item for item in items if isinstance(item, Output)]
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 bc4b64851..5ada2140c 100644 --- a/latest/python/apidoc/source+hyperqueue.task.function.__init__.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.function.__init__.py.html @@ -1,4 +1,4 @@ -hyperqueue.task.function

hyperqueue

0.17.0

Source code hyperqueue/task/function/__init__.py

  1
+hyperqueue.task.function
hyperqueue
 0.18.0 
Source code hyperqueue/task/function/__init__.py
  1
   2
   3
   4
@@ -309,4 +309,4 @@
     if hasattr(fn, "__name__"):
         return f"{fn.__name__}/{id}"
     return None
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 212f28cfa..4d57b8599 100644 --- a/latest/python/apidoc/source+hyperqueue.task.function.wrapper.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.function.wrapper.py.html @@ -1,4 +1,4 @@ -hyperqueue.task.function.wrapper

hyperqueue

0.17.0

Source code hyperqueue/task/function/wrapper.py

 1
+hyperqueue.task.function.wrapper
hyperqueue
 0.18.0 
Source code hyperqueue/task/function/wrapper.py
 1
  2
  3
  4
@@ -121,4 +121,4 @@
             self.__class__,
             (None, self._get_pickled_fn(), self.cache, self.protocol),
         )
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 5e7e14b49..0d7ac3292 100644 --- a/latest/python/apidoc/source+hyperqueue.task.program.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.program.py.html @@ -1,4 +1,4 @@ -hyperqueue.task.program

hyperqueue

0.17.0

Source code hyperqueue/task/program.py

  1
+hyperqueue.task.program
hyperqueue
 0.18.0 
Source code hyperqueue/task/program.py
  1
   2
   3
   4
@@ -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-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 15806cdb8..632023c61 100644 --- a/latest/python/apidoc/source+hyperqueue.task.task.py.html +++ b/latest/python/apidoc/source+hyperqueue.task.task.py.html @@ -1,4 +1,4 @@ -hyperqueue.task.task

hyperqueue

0.17.0

Source code hyperqueue/task/task.py

 1
+hyperqueue.task.task
hyperqueue
 0.18.0 
Source code hyperqueue/task/task.py
 1
  2
  3
  4
@@ -135,4 +135,4 @@
         raise ValidationException(
             f"Invalid value provided for `{stream}`: {type(stdio)}. Expected str, Path or `StdioDef`."
         )
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 8b027ae8e..38bd6d58b 100644 --- a/latest/python/apidoc/source+hyperqueue.utils.package.py.html +++ b/latest/python/apidoc/source+hyperqueue.utils.package.py.html @@ -1,4 +1,4 @@ -hyperqueue.utils.package

hyperqueue

0.17.0

Source code hyperqueue/utils/package.py

1
+hyperqueue.utils.package
hyperqueue
 0.18.0 
Source code hyperqueue/utils/package.py
1
 2
 3
 4
@@ -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-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 5933963c2..1726d8588 100644 --- a/latest/python/apidoc/source+hyperqueue.utils.string.py.html +++ b/latest/python/apidoc/source+hyperqueue.utils.string.py.html @@ -1,8 +1,8 @@ -hyperqueue.utils.string

hyperqueue

0.17.0

Source code hyperqueue/utils/string.py

1
+hyperqueue.utils.string
hyperqueue
 0.18.0 
Source code hyperqueue/utils/string.py
1
 2
 3
 4
def pluralize(text: str, count: int) -> str:
     if count == 1:
         return text
     return f"{text}s"
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 23c362a41..9a39c99aa 100644 --- a/latest/python/apidoc/source+hyperqueue.validation.py.html +++ b/latest/python/apidoc/source+hyperqueue.validation.py.html @@ -1,4 +1,4 @@ -hyperqueue.validation

hyperqueue

0.17.0

Source code hyperqueue/validation.py

 1
+hyperqueue.validation
hyperqueue
 0.18.0 
Source code hyperqueue/validation.py
 1
  2
  3
  4
@@ -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-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ 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 903a94edd..c03765730 100644 --- a/latest/python/apidoc/source+hyperqueue.visualization.py.html +++ b/latest/python/apidoc/source+hyperqueue.visualization.py.html @@ -1,4 +1,4 @@ -hyperqueue.visualization

hyperqueue

0.17.0

Source code hyperqueue/visualization.py

 1
+hyperqueue.visualization
hyperqueue
 0.18.0 
Source code hyperqueue/visualization.py
 1
  2
  3
  4
@@ -79,4 +79,4 @@
         visit(task)
 
     graph.write(path)
-
 Generated by nedoc v0.10 at 2024-02-11 08:48 

\ No newline at end of file
+

Generated by nedoc v0.10 at 2024-02-11 09:19

\ No newline at end of file diff --git a/latest/sitemap.xml.gz b/latest/sitemap.xml.gz index ae5d5529835378865ad343d091e93ef5cc9396d7..05f38b0c800e0e8b1a13c3446ed5c21c5ee06cdb 100644 GIT binary patch delta 15 WcmX@Ye1w@zzMF$XY~n_?eT)DkOayEI delta 15 WcmX@Ye1w@zzMF&NRp&;weT)Dp90fQ4