Use websocket stream to retrieve runtime job results by kt474 · Pull Request #175 · Qiskit/qiskit-ibm-provider

kt474 · 2021-10-23T22:33:27Z

Summary

fixes #117

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>

* 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>

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

* 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>

* 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>

rathishcholarajan

The test_runtime.py unit test suite is throwing some websocket errors in most of the tests after this update. (but tests are still passing) See here - https://github.com/Qiskit-Partners/qiskit-ibm/runs/4112663719?check_suite_focus=true#step:5:201

We need to figure out why that's happening. You can compare the logs with runtime-release-q4 PR runs (those are clean).

jyu00 · 2021-11-06T19:36:01Z

+        if not self._is_streaming():
+            self._ws_client_future = self._executor.submit(self._start_websocket_client)


So if the job is already done (i.e. self._ws_client_future.done() is true), we'll still open a connection? Presumably the server will just close it immediate?

Also if I call this method, which times out, then I try to do stream_results() (maybe trying to figure out why the job is taking so long), it's going to tell me a callback function is already streaming results, which is not true.

I suppose we could do if self._ws_client_future is None we can open a connection and avoid the other case

As for if wait_for_final_state() times out and then stream_results() is called, is there a better way to handle this other than just updating the error message?

I suppose we could do if self._ws_client_future is None we can open a connection and avoid the other case

Except we also have the cancel_result_streaming() method which would cancel the future without setting it to None. Instead of relying on the status of the future, we can just check if status is in JOB_FINAL_STATES and only open a connection if it isn't.

As for if wait_for_final_state() times out and then stream_results() is called, is there a better way to handle this other than just updating the error message?

Yeah you can update stream_results() to not raise immediately if there is a stream already open. You can instead start calling the user's callback function with message from the stream.

jyu00 · 2021-11-06T19:38:23Z

            if timeout is not None and elapsed_time >= timeout:
                raise JobTimeoutError(
                    'Timeout while waiting for job {}.'.format(self.job_id))
            time.sleep(wait)


Since the reason to switch to ws streaming is to avoid polling, you can just do self._ws_client_future.result(timeout).

You don't need this sleep() now that you have future.result(), or the while loop.

* 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>

kt474 · 2021-11-17T20:00:40Z

This is failing one integration test test_stream_results_done - which I'm not sure I understand.

We're trying to force call stream results on a completed job with interim results and expect the callback function to not be called so the variable called_back remains false?

kt474 · 2021-11-29T21:24:25Z

closing, moved to Qiskit/qiskit-ibm-runtime#33

rathishcholarajan and others added 20 commits October 18, 2021 01:14

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

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

767afeb

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

24dfa95

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

remove runtime job results poll

095c620

fix lint

98a29fe

refactor

68edf13

add reno

5807fa9

Merge branch 'main' into job-results-stream

0fd4bad

update result stream & test case

8afba87

kt474 changed the title ~~[WIP] remove runtime job results poll~~ Use websocket stream to retrieve runtime job results Oct 26, 2021

kt474 and others added 6 commits October 26, 2021 19:58

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

1b26e0b

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

Pass program params as object (Qiskit#171)

df4eb81

Fix integration tests

e3e4315

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

f5712bc

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

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

0f95825

Allow updating runtime metadata in place (Qiskit#188)

b532b14

* 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 suggested changes Nov 1, 2021

View reviewed changes

Comment thread qiskit_ibm/runtime/runtime_job.py Outdated

Comment thread releasenotes/notes/job-results-stream-3a43d8277bdb6fea.yaml Outdated

kt474 added 2 commits November 1, 2021 02:45

remove reno, start stream logic

f395f81

Merge branch 'main' into job-results-stream

da3ae88

kt474 and others added 2 commits November 4, 2021 11:58

add call to self.status()

5e7e992

kt474 requested a review from rathishcholarajan November 5, 2021 00:27

Update cache after updating program (Qiskit#196)

07f0d53

rathishcholarajan changed the base branch from main to runtime-release-q4 November 5, 2021 01:57

Merge branch 'runtime-release-q4' into job-results-stream

bef1107

rathishcholarajan suggested changes Nov 5, 2021

View reviewed changes

jyu00 reviewed Nov 6, 2021

View reviewed changes

kt474 and others added 6 commits November 7, 2021 19:57

Merge branch 'runtime-release-q4' into job-results-stream

06f0e1f

refactor timeout

5f8e8db

fix lint

aac2d79

Merge branch 'runtime-release-q4' into job-results-stream

1fa914e

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

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

Merge branch 'main' into job-results-stream

8b59137

Merge branch 'main' into job-results-stream

7c481bd

This was referenced Nov 16, 2021

FAIL: test_websocket_proxy_invalid_port #203

Closed

FAIL: test_job_logs #202

Closed

kt474 added 4 commits November 17, 2021 01:48

add mock test method

0836763

update sleep time

78edfa7

update sleep times & refactor

42dfc76

removed unused import

374a32f

Merge branch 'main' into job-results-stream

883eef2

kt474 mentioned this pull request Nov 29, 2021

Use websocket stream to retrieve runtime job results Qiskit/qiskit-ibm-runtime#33

Merged

kt474 closed this Nov 29, 2021

kt474 added the on hold Cannot fix yet label Jan 11, 2022

kt474 deleted the job-results-stream branch April 21, 2022 17:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use websocket stream to retrieve runtime job results #175

Use websocket stream to retrieve runtime job results #175
kt474 wants to merge 64 commits intoQiskit:mainfrom
kt474:job-results-stream

kt474 commented Oct 23, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

rathishcholarajan left a comment

Uh oh!

jyu00 Nov 6, 2021

Uh oh!

kt474 Nov 16, 2021

Uh oh!

jyu00 Nov 17, 2021

Uh oh!

jyu00 Nov 6, 2021

Uh oh!

jyu00 Nov 17, 2021

Uh oh!

kt474 commented Nov 17, 2021

Uh oh!

kt474 commented Nov 29, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		if not self._is_streaming():
		self._ws_client_future = self._executor.submit(self._start_websocket_client)

Conversation

kt474 commented Oct 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details and comments

Uh oh!

Uh oh!

Uh oh!

rathishcholarajan left a comment

Choose a reason for hiding this comment

Uh oh!

jyu00 Nov 6, 2021

Choose a reason for hiding this comment

Uh oh!

kt474 Nov 16, 2021

Choose a reason for hiding this comment

Uh oh!

jyu00 Nov 17, 2021

Choose a reason for hiding this comment

Uh oh!

jyu00 Nov 6, 2021

Choose a reason for hiding this comment

Uh oh!

jyu00 Nov 17, 2021

Choose a reason for hiding this comment

Uh oh!

kt474 commented Nov 17, 2021

Uh oh!

kt474 commented Nov 29, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kt474 commented Oct 23, 2021 •

edited

Loading