Deployed 3987dc2 to latest with MkDocs 1.2.4 and mike 1.1.2

latest/examples/iterative-computation/index.html

@@ -32,4 +32,4 @@
 <span class=w>      </span><span class=k>break</span>
 <span class=w>  </span><span class=k>fi</span>
 <span class=k>done</span>
-</code></pre></div> <hr> <div class=md-source-date> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 12, 2024</span> <br>Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 12, 2024</span> </small> </div> </article> </div> </div> <a href=# class="md-top md-icon" data-md-component=top data-md-state=hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg> Back to top </a> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../ class="md-footer__link md-footer__link--prev" aria-label="Previous: Examples" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </div> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> Examples </div> </div> </a> <a href=../../deployment/ class="md-footer__link md-footer__link--next" aria-label="Next: Architecture" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> Architecture </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["header.autohide", "navigation.instant", "navigation.top"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.e99e714c.min.js", "version": {"provider": "mike", "default": "stable"}}</script> <script src=../../assets/javascripts/bundle.bc35569b.min.js></script> </body> </html>
+</code></pre></div> <hr> <div class=md-source-date> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 13, 2024</span> <br>Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 13, 2024</span> </small> </div> </article> </div> </div> <a href=# class="md-top md-icon" data-md-component=top data-md-state=hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg> Back to top </a> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../ class="md-footer__link md-footer__link--prev" aria-label="Previous: Examples" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </div> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> Examples </div> </div> </a> <a href=../../deployment/ class="md-footer__link md-footer__link--next" aria-label="Next: Architecture" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> Architecture </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["header.autohide", "navigation.instant", "navigation.top"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.e99e714c.min.js", "version": {"provider": "mike", "default": "stable"}}</script> <script src=../../assets/javascripts/bundle.bc35569b.min.js></script> </body> </html>

latest/python/apidoc/hyperqueue.client.Client.html

@@ -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>&#9662; hyperqueue</a> </li><li><ul><li><a href=hyperqueue.client.html>&#9662; 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>&#9656; cluster</a> </li><li><a href=hyperqueue.common.html>&#9656; common</a> </li><li><a href=hyperqueue.ffi.html>&#9656; ffi</a> </li><li><a href=hyperqueue.job.html>&#9656; job</a> </li><li><a href=hyperqueue.output.html>&#9656; output</a> </li><li><a href=hyperqueue.task.html>&#9656; task</a> </li><li><a href=hyperqueue.utils.html>&#9656; utils</a> </li><li><a href=hyperqueue.validation.html>&#9656; validation</a> </li><li><a href=hyperqueue.visualization.html>&#9656; 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>&#9654;</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>&#9654;</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>&#9655;</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>) -&gt; 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>&#9654;</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_submit>submit</a>(<span class=args>self, job: Job</span>) -&gt; 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>&#9655;</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>) -&gt; 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-12 10:05 </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>&#9662; hyperqueue</a> </li><li><ul><li><a href=hyperqueue.client.html>&#9662; 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>&#9656; cluster</a> </li><li><a href=hyperqueue.common.html>&#9656; common</a> </li><li><a href=hyperqueue.ffi.html>&#9656; ffi</a> </li><li><a href=hyperqueue.job.html>&#9656; job</a> </li><li><a href=hyperqueue.output.html>&#9656; output</a> </li><li><a href=hyperqueue.task.html>&#9656; task</a> </li><li><a href=hyperqueue.utils.html>&#9656; utils</a> </li><li><a href=hyperqueue.validation.html>&#9656; validation</a> </li><li><a href=hyperqueue.visualization.html>&#9656; 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>&#9654;</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>&#9654;</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>&#9655;</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>) -&gt; 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>&#9654;</span> def <a class="fexpand symbol" href=hyperqueue.client.Client.html#f_submit>submit</a>(<span class=args>self, job: Job</span>) -&gt; 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>&#9655;</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>) -&gt; 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>