-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed 85e0155 to latest with MkDocs 1.2.4 and mike 1.1.2
- Loading branch information
gh-ci-deploy-docs
committed
Sep 13, 2024
1 parent
a9d9ba2
commit 715af6e
Showing
63 changed files
with
62 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| <!DOCTYPE html><html><head><meta charset=utf-8><title>hyperqueue.client.Client</title><meta name=viewport content="width=device-width, initial-scale=1.0"><link rel=stylesheet href=./assets/purecss/pure-min.css><link rel=stylesheet href=./assets/purecss/grids-responsive-min.css><link rel=stylesheet href=./assets/style.css><link rel=stylesheet href=./assets/pygments/default.css><link rel=stylesheet href=./assets/jquery/jquery-ui.min.css><script src=./assets/jquery/jquery-3.0.0.min.js></script><script src=./assets/jquery/jquery-ui.min.js></script><script src=nedoc.js></script></head><body><div id=layout class=pure-g><div class="sidebar pure-u-1 pure-u-md-1-4"><div class=header><h1 class=brand-title>hyperqueue</h1> 0.19.0 </div><div id=sbox><input id=search style="color: black;" placeholder="search ..."></div><div class=tree><ul><li><a href=hyperqueue.html>▾ hyperqueue</a> </li><li><ul><li><a href=hyperqueue.client.html>▾ client</a> </li><li><ul><li><div class=select><a href=hyperqueue.client.Client.html> <i>class</i> Client</a> </div></li><li><a href=hyperqueue.client.FailedJobsException.html> <i>class</i> FailedJobsException</a> </li></ul></li><li><a href=hyperqueue.cluster.html>▸ cluster</a> </li><li><a href=hyperqueue.common.html>▸ common</a> </li><li><a href=hyperqueue.ffi.html>▸ ffi</a> </li><li><a href=hyperqueue.job.html>▸ job</a> </li><li><a href=hyperqueue.output.html>▸ output</a> </li><li><a href=hyperqueue.task.html>▸ task</a> </li><li><a href=hyperqueue.utils.html>▸ utils</a> </li><li><a href=hyperqueue.validation.html>▸ validation</a> </li><li><a href=hyperqueue.visualization.html>▸ visualization</a> </li></ul></ul></div></div><div class="content pure-u-1 pure-u-md-3-4"><h1>Class Client</h1><div id=path><a class=symbol href=hyperqueue.html>hyperqueue</a>.<a class=symbol href=hyperqueue.client.html>client</a>.<a class=symbol href=hyperqueue.client.Client.html>Client</a></div><p><div class=docline><div class=md-doc><p>A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.</p></div></div></p><h2>Declaration</h2><div class=decl><span class=kw>class</span> Client</div><a class=sourcelink href=source+hyperqueue.client.py.html#line-53>source</a> <a class=sourcelink href=hyperqueue.client.Client.html>link</a><h2>Documentation</h2><h2>Methods</h2><ul class=deflst><li><div class=fn><a id=f___init__></a><div class=fshort><span class=def><span class=ftoggle>▶</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f___init__>__init__</a>(<span class=args>self, server_dir: Optional[GenericPath] = None, ...</span>) </span><div class=docline><div class=md-doc><p>A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.</p></div></div></div><div class=fdetail id=fn___init__><div class=decl><div class=def><span class=kw>def</span> __init__( <div class=args style="padding-left: 2em"><span class=kw>self</span>,</div><div class=args style="padding-left: 2em">server_dir: Optional[GenericPath] = <i>None</i>,</div><div class=args style="padding-left: 2em">python_env: Optional[PythonEnv] = <i>None</i>,</div> ) </div></div><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-54>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f___init__>link</a></div><h3>Parameters</h3><ul class=params><li><strong>server_dir</strong>: Optional[GenericPath] <br><div class=md-doc><div class=md-doc><p>Path to a server directory of a running HyperQueue server.</p></div></div></li><li><strong>python_env</strong>: Optional[PythonEnv] <br><div class=md-doc><div class=md-doc><p>Python environment which configures Python tasks created by <a href=hyperqueue.job.Job.html#f_function><code>function</code></a>.</p></div></div></li></ul></div></div></li><li><div class=fn><a id=f_forget></a><div class=fshort><span class=def><span class=ftoggle>▶</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_forget>forget</a>(<span class=args>self, job: HasJobId</span>) </span><div class=docline><div class=md-doc><p>Forget a completed job to free up its resources from the server.</p></div></div></div><div class=fdetail id=fn_forget><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-110>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_forget>link</a></div><h3>Parameters</h3><ul class=params><li><strong>job</strong>: HasJobId <br><div class=md-doc><div class=md-doc><p>Submitted job (or job ID) that will be forgotten.</p></div></div></li></ul></div></div></li><li><div class=fn><a id=f_get_failed_tasks></a><div class=fshort><span class=def><span class=ftoggle-empty>▷</span> def <a class="fexpand symbol-no-doc" href=hyperqueue.client.Client.html#f_get_failed_tasks>get_failed_tasks</a>(<span class=args>self, job: SubmittedJob</span>) -> Dict[TaskId, FailedTaskContext] </span></div><div class=fdetail id=fn_get_failed_tasks><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-106>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_get_failed_tasks>link</a></div></div></div></li><li><div class=fn><a id=f_submit></a><div class=fshort><span class=def><span class=ftoggle>▶</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_submit>submit</a>(<span class=args>self, job: Job</span>) -> SubmittedJob </span><div class=docline><div class=md-doc><p>Submit a job into HyperQueue.</p></div></div></div><div class=fdetail id=fn_submit><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-73>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_submit>link</a></div><h3>Parameters</h3><ul class=params><li><strong>job</strong>: Job <br><div class=md-doc><div class=md-doc><p>Job that will be submitted.</p></div></div></li></ul></div></div></li><li><div class=fn><a id=f_wait_for_jobs></a><div class=fshort><span class=def><span class=ftoggle-empty>▷</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_wait_for_jobs>wait_for_jobs</a>(<span class=args>self, jobs: Sequence[SubmittedJob], raise_on_error=True</span>) -> bool </span><div class=docline><div class=md-doc><p>Returns True if all tasks were successfully finished</p></div></div></div><div class=fdetail id=fn_wait_for_jobs><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-88>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_wait_for_jobs>link</a></div></div></div></li></ul><h2>Reexports</h2><ul class=deflst><li> Imported in <a class=symbol href=hyperqueue.cluster.html>hyperqueue.cluster</a>. </li><li> Imported in <a class=symbol href=hyperqueue.html>hyperqueue</a>. </li></ul><p class=footer> Generated by <a href=https://github.com/spirali/nedoc>nedoc</a> v0.10 at 2024-09-13 11:02 </p></div></div></body></html> | ||
| <!DOCTYPE html><html><head><meta charset=utf-8><title>hyperqueue.client.Client</title><meta name=viewport content="width=device-width, initial-scale=1.0"><link rel=stylesheet href=./assets/purecss/pure-min.css><link rel=stylesheet href=./assets/purecss/grids-responsive-min.css><link rel=stylesheet href=./assets/style.css><link rel=stylesheet href=./assets/pygments/default.css><link rel=stylesheet href=./assets/jquery/jquery-ui.min.css><script src=./assets/jquery/jquery-3.0.0.min.js></script><script src=./assets/jquery/jquery-ui.min.js></script><script src=nedoc.js></script></head><body><div id=layout class=pure-g><div class="sidebar pure-u-1 pure-u-md-1-4"><div class=header><h1 class=brand-title>hyperqueue</h1> 0.19.0 </div><div id=sbox><input id=search style="color: black;" placeholder="search ..."></div><div class=tree><ul><li><a href=hyperqueue.html>▾ hyperqueue</a> </li><li><ul><li><a href=hyperqueue.client.html>▾ client</a> </li><li><ul><li><div class=select><a href=hyperqueue.client.Client.html> <i>class</i> Client</a> </div></li><li><a href=hyperqueue.client.FailedJobsException.html> <i>class</i> FailedJobsException</a> </li></ul></li><li><a href=hyperqueue.cluster.html>▸ cluster</a> </li><li><a href=hyperqueue.common.html>▸ common</a> </li><li><a href=hyperqueue.ffi.html>▸ ffi</a> </li><li><a href=hyperqueue.job.html>▸ job</a> </li><li><a href=hyperqueue.output.html>▸ output</a> </li><li><a href=hyperqueue.task.html>▸ task</a> </li><li><a href=hyperqueue.utils.html>▸ utils</a> </li><li><a href=hyperqueue.validation.html>▸ validation</a> </li><li><a href=hyperqueue.visualization.html>▸ visualization</a> </li></ul></ul></div></div><div class="content pure-u-1 pure-u-md-3-4"><h1>Class Client</h1><div id=path><a class=symbol href=hyperqueue.html>hyperqueue</a>.<a class=symbol href=hyperqueue.client.html>client</a>.<a class=symbol href=hyperqueue.client.Client.html>Client</a></div><p><div class=docline><div class=md-doc><p>A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.</p></div></div></p><h2>Declaration</h2><div class=decl><span class=kw>class</span> Client</div><a class=sourcelink href=source+hyperqueue.client.py.html#line-53>source</a> <a class=sourcelink href=hyperqueue.client.Client.html>link</a><h2>Documentation</h2><h2>Methods</h2><ul class=deflst><li><div class=fn><a id=f___init__></a><div class=fshort><span class=def><span class=ftoggle>▶</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f___init__>__init__</a>(<span class=args>self, server_dir: Optional[GenericPath] = None, ...</span>) </span><div class=docline><div class=md-doc><p>A client serves as a gateway for submitting jobs and querying information about a running HyperQueue server.</p></div></div></div><div class=fdetail id=fn___init__><div class=decl><div class=def><span class=kw>def</span> __init__( <div class=args style="padding-left: 2em"><span class=kw>self</span>,</div><div class=args style="padding-left: 2em">server_dir: Optional[GenericPath] = <i>None</i>,</div><div class=args style="padding-left: 2em">python_env: Optional[PythonEnv] = <i>None</i>,</div> ) </div></div><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-54>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f___init__>link</a></div><h3>Parameters</h3><ul class=params><li><strong>server_dir</strong>: Optional[GenericPath] <br><div class=md-doc><div class=md-doc><p>Path to a server directory of a running HyperQueue server.</p></div></div></li><li><strong>python_env</strong>: Optional[PythonEnv] <br><div class=md-doc><div class=md-doc><p>Python environment which configures Python tasks created by <a href=hyperqueue.job.Job.html#f_function><code>function</code></a>.</p></div></div></li></ul></div></div></li><li><div class=fn><a id=f_forget></a><div class=fshort><span class=def><span class=ftoggle>▶</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_forget>forget</a>(<span class=args>self, job: HasJobId</span>) </span><div class=docline><div class=md-doc><p>Forget a completed job to free up its resources from the server.</p></div></div></div><div class=fdetail id=fn_forget><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-110>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_forget>link</a></div><h3>Parameters</h3><ul class=params><li><strong>job</strong>: HasJobId <br><div class=md-doc><div class=md-doc><p>Submitted job (or job ID) that will be forgotten.</p></div></div></li></ul></div></div></li><li><div class=fn><a id=f_get_failed_tasks></a><div class=fshort><span class=def><span class=ftoggle-empty>▷</span> def <a class="fexpand symbol-no-doc" href=hyperqueue.client.Client.html#f_get_failed_tasks>get_failed_tasks</a>(<span class=args>self, job: SubmittedJob</span>) -> Dict[TaskId, FailedTaskContext] </span></div><div class=fdetail id=fn_get_failed_tasks><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-106>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_get_failed_tasks>link</a></div></div></div></li><li><div class=fn><a id=f_submit></a><div class=fshort><span class=def><span class=ftoggle>▶</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_submit>submit</a>(<span class=args>self, job: Job</span>) -> SubmittedJob </span><div class=docline><div class=md-doc><p>Submit a job into HyperQueue.</p></div></div></div><div class=fdetail id=fn_submit><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-73>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_submit>link</a></div><h3>Parameters</h3><ul class=params><li><strong>job</strong>: Job <br><div class=md-doc><div class=md-doc><p>Job that will be submitted.</p></div></div></li></ul></div></div></li><li><div class=fn><a id=f_wait_for_jobs></a><div class=fshort><span class=def><span class=ftoggle-empty>▷</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_wait_for_jobs>wait_for_jobs</a>(<span class=args>self, jobs: Sequence[SubmittedJob], raise_on_error=True</span>) -> bool </span><div class=docline><div class=md-doc><p>Returns True if all tasks were successfully finished</p></div></div></div><div class=fdetail id=fn_wait_for_jobs><div class=idnt><a class=sourcelink href=source+hyperqueue.client.py.html#line-88>source</a> <a class=sourcelink href=hyperqueue.client.Client.html#f_wait_for_jobs>link</a></div></div></div></li></ul><h2>Reexports</h2><ul class=deflst><li> Imported in <a class=symbol href=hyperqueue.cluster.html>hyperqueue.cluster</a>. </li><li> Imported in <a class=symbol href=hyperqueue.html>hyperqueue</a>. </li></ul><p class=footer> Generated by <a href=https://github.com/spirali/nedoc>nedoc</a> v0.10 at 2024-09-13 11:06 </p></div></div></body></html> |
Oops, something went wrong.