Support retrieving interim results from runtime jobs #162

kt474 · 2021-10-18T02:43:00Z

Summary

fixes #64

Details and comments

* Remove version field from runtime program * Add release note

This needs to change in the program upload body request in order to meet the IBM Cloud API guidance. Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

qiskit_ibm/api/clients/runtime.py

Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

kt474 · 2021-10-19T15:33:21Z

Should the interim results be returned as a string or object? Also my understanding is this is just for retrieving interim results of completed jobs since they can also be streamed through a websocket?

qiskit_ibm/runtime/runtime_job.py

releasenotes/notes/interim-results-c9f14ac517012191.yaml

test/ibm/runtime/fake_runtime_client.py

test/ibm/runtime/test_runtime.py

Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

rathishcholarajan · 2021-10-19T17:47:57Z

Should the interim results be returned as a string or object?

interim_results function should take an optional decoder parameter just like results and the decoded result should be returned, either using passed in decoder or self._result_decoder.

Also my understanding is this is just for retrieving interim results of completed jobs since they can also be streamed through a websocket?

Usually that is the case, but there is nothing stopping the user from invoking the function when the job is running.

* Remove version field from runtime program * Add release note

Qiskit#155)

This needs to change in the program upload body request in order to meet the IBM Cloud API guidance. Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

rathishcholarajan

Looks good! Thanks @kt474! Will wait on the duplicate entries issue NTC-786 to be resolved on server side before merging this issue.

* Remove version field from runtime program * Add release note

Qiskit#155)

This needs to change in the program upload body request in order to meet the IBM Cloud API guidance. Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

* Accept JSON schema as program metadata * Update qiskit_ibm/runtime/ibm_runtime_service.py Co-authored-by: Jessie Yu <jessieyu@us.ibm.com> * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Jessie Yu <jessieyu@us.ibm.com> Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

* update runtime metadata * return if no data * fix mypy * Update releasenotes/notes/update-runtime-metadata-d2ddbcfc0d034530.yaml Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

…rs/qiskit-ibm into runtime-release-q4

* Allow filtering runtime jobs by program ID * Fix lint

* retrieve program data * refetch once if no program data * remove unused import * refresh program on data property * fix lint * Update qiskit_ibm/runtime/runtime_program.py Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update qiskit_ibm/runtime/runtime_program.py Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update qiskit_ibm/runtime/runtime_program.py Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * add test case * add test case * add default data constant * add _validate_program method * Update test/ibm/runtime/test_runtime.py Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

* add provider param * split provider into hub/group/project * add reno * wip add test case * fix lint/docs * Update qiskit_ibm/runtime/ibm_runtime_service.py Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update releasenotes/notes/filter-jobs-by-provider-dead04faaf223840.yaml Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * refactor test cases * remove print * add integration test Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

* wip add limit/offset params * add reno * refactor & update test case * offset -> skip, implement refresh logic * refresh when skip/limit not default * Update releasenotes/notes/runtime-program-pagination-8d599ae984a5ce33.yaml Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update releasenotes/notes/runtime-program-pagination-8d599ae984a5ce33.yaml Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * add to test case * refactor refresh logic * refactor * fix lint * add integration test * update doc string * Update qiskit_ibm/api/clients/runtime.py Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * cleanup merge * Apply suggestions from code review * fix lint refactor * Fetch all programs upfront 20 at a time and store in cache For subsequent requests paginate and return from cache * Fix integration test Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> Co-authored-by: Rathish Cholarajan <Rathish.C@ibm.com>

rathishcholarajan · 2021-11-22T17:59:11Z

Moved to Qiskit/qiskit-ibm-runtime#15

kt474 and others added 8 commits October 17, 2021 22:39

retrieve interim results

2f024bd

Remove version field from runtime program (Qiskit#152)

464192f

* Remove version field from runtime program * Add release note

Rename isPublic to is_public when creating or reading runtime programs (

abb98d0

Qiskit#155)

Update programId to program_id when running program (Qiskit#139)

31fdd4b

This needs to change in the program upload body request in order to meet the IBM Cloud API guidance. Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

Add support to view program update date (Qiskit#160)

0d5ebf8

add reno

f187cbf

Upload runtime program using 'data' field (Qiskit#157)

767afeb

Read programs from "programs" array in response (Qiskit#161)

24dfa95

rathishcholarajan added this to the 0.1 milestone Oct 19, 2021

rathishcholarajan reviewed Oct 19, 2021

View reviewed changes

qiskit_ibm/api/clients/runtime.py Outdated Show resolved Hide resolved

kt474 and others added 2 commits October 18, 2021 23:19

add test case

6b9db0d

Update qiskit_ibm/api/clients/runtime.py

c1587d0

Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

kt474 changed the title ~~[WIP] Support retrieving interim results from runtime jobs~~ Support retrieving interim results from runtime jobs Oct 19, 2021

rathishcholarajan suggested changes Oct 19, 2021

View reviewed changes

kt474 and others added 2 commits October 19, 2021 13:31

Update qiskit_ibm/runtime/runtime_job.py

b690574

Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

interim_result -> interim_results

9011435

rathishcholarajan added the Changelog: New Feature Include in the Added section of the changelog label Oct 19, 2021

update interim_results method & cleanup

16e6373

kt474 requested a review from rathishcholarajan October 20, 2021 00:29

rathishcholarajan changed the base branch from main to runtime-release-q4 October 20, 2021 18:18

rathishcholarajan and others added 7 commits October 21, 2021 15:26

Remove version field from runtime program (Qiskit#152)

79cd9bd

* Remove version field from runtime program * Add release note

Rename isPublic to is_public when creating or reading runtime programs (

45ab0b2

Qiskit#155)

Update programId to program_id when running program (Qiskit#139)

faff4e2

This needs to change in the program upload body request in order to meet the IBM Cloud API guidance. Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

Add support to view program update date (Qiskit#160)

bcc27fb

Upload runtime program using 'data' field (Qiskit#157)

866d045

Read programs from "programs" array in response (Qiskit#161)

eda2a51

Pass program as base64 string to update (Qiskit#168)

ab33b52

rathishcholarajan force-pushed the runtime-release-q4 branch from 15a9d5d to ab33b52 Compare October 21, 2021 19:26

rathishcholarajan added the backport potential The bug might be minimal and/or important enough to be port to stable label Nov 2, 2021

rathishcholarajan approved these changes Nov 2, 2021

View reviewed changes

rathishcholarajan added the on hold Cannot fix yet label Nov 2, 2021

rathishcholarajan and others added 12 commits November 2, 2021 13:20

Remove version field from runtime program (Qiskit#152)

f5b4e54

* Remove version field from runtime program * Add release note

Rename isPublic to is_public when creating or reading runtime programs (

93a2b85

Qiskit#155)

Update programId to program_id when running program (Qiskit#139)

966d42a

This needs to change in the program upload body request in order to meet the IBM Cloud API guidance. Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>

Add support to view program update date (Qiskit#160)

031fc25

Upload runtime program using 'data' field (Qiskit#157)

1561a9b

Read programs from "programs" array in response (Qiskit#161)

b656ece

Pass program as base64 string to update (Qiskit#168)

8fb3669

Pass program params as object (Qiskit#171)

ee76158

Fix integration tests

da52271

Use count to reduce one last extra call to API (Qiskit#172)

f3033b8

Allow updating runtime metadata in place (Qiskit#188)

aea236b

* update runtime metadata * return if no data * fix mypy * Update releasenotes/notes/update-runtime-metadata-d2ddbcfc0d034530.yaml Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>

rathishcholarajan force-pushed the runtime-release-q4 branch from f8a0abb to aea236b Compare November 2, 2021 17:20

kt474 and others added 7 commits November 2, 2021 13:24

Merge branch 'runtime-release-q4' of https://github.com/Qiskit-Partne…

e71b402

…rs/qiskit-ibm into runtime-release-q4

Allow filtering runtime jobs by program ID (Qiskit#193)

4102480

* Allow filtering runtime jobs by program ID * Fix lint

Update cache after updating program (Qiskit#196)

07f0d53

Merge branch 'runtime-release-q4' into interim-results-endpoint

0a9721a

rathishcholarajan changed the base branch from runtime-release-q4 to main November 9, 2021 22:18

rathishcholarajan and others added 2 commits November 9, 2021 17:19

Merge branch 'main' into interim-results-endpoint

87fa2b9

Merge branch 'main' into interim-results-endpoint

0e63479

kt474 mentioned this pull request Nov 17, 2021

Retrieve interim results from runtime jobs Qiskit/qiskit-ibm-runtime#15

Merged

rathishcholarajan closed this Nov 22, 2021

kt474 deleted the interim-results-endpoint branch April 21, 2022 17:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support retrieving interim results from runtime jobs #162

Support retrieving interim results from runtime jobs #162

kt474 commented Oct 18, 2021

kt474 commented Oct 19, 2021

rathishcholarajan commented Oct 19, 2021 •

edited

Loading

rathishcholarajan left a comment

rathishcholarajan commented Nov 22, 2021

Support retrieving interim results from runtime jobs #162

Support retrieving interim results from runtime jobs #162

Conversation

kt474 commented Oct 18, 2021

Summary

Details and comments

kt474 commented Oct 19, 2021

rathishcholarajan commented Oct 19, 2021 • edited Loading

rathishcholarajan left a comment

Choose a reason for hiding this comment

rathishcholarajan commented Nov 22, 2021

rathishcholarajan commented Oct 19, 2021 •

edited

Loading