Class Client

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

Declaration

class Client

▶ 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]
source link
▶ 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
source link