@@ -406,11 +406,11 @@ <h1>qiskit_serverless.core.IBMServerlessClient<a class="headerlink" href="#qiski
406406< tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> from_dict</ span > </ code > (dictionary)</ p > </ td >
407407< td > < p > Converts dict to object.</ p > </ td >
408408</ tr >
409- < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> function</ span > </ code > (**kwargs )</ p > </ td >
410- < td > < p > The wrapper </ p > </ td >
409+ < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> function</ span > </ code > (title[, provider] )</ p > </ td >
410+ < td > < p > Returns program based on parameters. </ p > </ td >
411411</ tr >
412412< tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> functions</ span > </ code > (**kwargs)</ p > </ td >
413- < td > < p > The wrapper </ p > </ td >
413+ < td > < p > Returns list of available functions. </ p > </ td >
414414</ tr >
415415< tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> get</ span > </ code > (title[, provider])</ p > </ td >
416416< td > < p > Returns program based on parameters.</ p > </ td >
@@ -421,17 +421,17 @@ <h1>qiskit_serverless.core.IBMServerlessClient<a class="headerlink" href="#qiski
421421< tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> get_jobs</ span > </ code > (**kwargs)</ p > </ td >
422422< td > < p > Return list of jobs.</ p > </ td >
423423</ tr >
424- < tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> job</ span > </ code > (**kwargs )</ p > </ td >
425- < td > < p > The wrapper </ p > </ td >
424+ < tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> job</ span > </ code > (job_id )</ p > </ td >
425+ < td > < p > Returns job by job id. </ p > </ td >
426426</ tr >
427427< tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> jobs</ span > </ code > (**kwargs)</ p > </ td >
428- < td > < p > The wrapper </ p > </ td >
428+ < td > < p > Return list of jobs. </ p > </ td >
429429</ tr >
430430< tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> list</ span > </ code > (**kwargs)</ p > </ td >
431431< td > < p > Returns list of available programs.</ p > </ td >
432432</ tr >
433- < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> logs</ span > </ code > (**kwargs )</ p > </ td >
434- < td > < p > The wrapper </ p > </ td >
433+ < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> logs</ span > </ code > (job_id )</ p > </ td >
434+ < td > < p > Return logs. </ p > </ td >
435435</ tr >
436436< tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> provider_file_delete</ span > </ code > (file, function)</ p > </ td >
437437< td > < p > Deletes a file available to the provider for the specific Qiskit Function.</ p > </ td >
@@ -445,23 +445,23 @@ <h1>qiskit_serverless.core.IBMServerlessClient<a class="headerlink" href="#qiski
445445< tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> provider_files</ span > </ code > (function)</ p > </ td >
446446< td > < p > Returns the list of files available for the provider in the Qiskit Function folder.</ p > </ td >
447447</ tr >
448- < tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> provider_jobs</ span > </ code > (**kwargs)</ p > </ td >
449- < td > < p > The wrapper </ p > </ td >
448+ < tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> provider_jobs</ span > </ code > (function, **kwargs)</ p > </ td >
449+ < td > < p > List of jobs created in this provider and function. </ p > </ td >
450450</ tr >
451- < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> result</ span > </ code > (**kwargs )</ p > </ td >
452- < td > < p > The wrapper </ p > </ td >
451+ < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> result</ span > </ code > (job_id )</ p > </ td >
452+ < td > < p > Return results. </ p > </ td >
453453</ tr >
454454< tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> run</ span > </ code > (program[, arguments, config, provider])</ p > </ td >
455455< td > < p > Run a function and return its job.</ p > </ td >
456456</ tr >
457457< tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> save_account</ span > </ code > ([token, name, overwrite, ...])</ p > </ td >
458458< td > < p > Save the account to disk for future use.</ p > </ td >
459459</ tr >
460- < tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> status</ span > </ code > (**kwargs )</ p > </ td >
461- < td > < p > The wrapper </ p > </ td >
460+ < tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> status</ span > </ code > (job_id )</ p > </ td >
461+ < td > < p > Check status. </ p > </ td >
462462</ tr >
463- < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> stop</ span > </ code > (**kwargs )</ p > </ td >
464- < td > < p > The wrapper </ p > </ td >
463+ < tr class ="row-even "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> stop</ span > </ code > (job_id[, service] )</ p > </ td >
464+ < td > < p > Stops job/program. </ p > </ td >
465465</ tr >
466466< tr class ="row-odd "> < td > < p > < code class ="xref py py-obj docutils literal notranslate "> < span class ="pre "> to_dict</ span > </ code > ()</ p > </ td >
467467< td > < p > Converts class to dict.</ p > </ td >
0 commit comments