Translate all job statuses to Qiskit terminology in client #1062

caleb-johnson · 2023-10-30T16:12:16Z

Summary

In this PR, we translate job statuses from all job clients to Qiskit terminology. Rather than changing the DB structure (currently uses ray status names), we will just do a translation in the serverless client when the user requests the status.

Serverless --> Qiskit nomenclature changes

Pending --> Initializing
Stopped --> Canceled
Succeeded --> Done
Failed --> Error

IceKhan13

Also, when changing records in existing db you need to take care of entries in DB that are already there and convert them too.

Other hotfix option to close this issue would be just to do mapping in client, so you will not need to change anything on a backend and just show in client mapped statuses. Something like

def gateway_to_runtime_statuses(gateway_status):
     mapping = {
         "SUCCEEDED": "DONE"
     }
     return mapping.get(gateway_status, f"APIStatus[{gateway_status}]")

gateway/api/migrations/0001_initial.py

IceKhan13 · 2023-10-30T18:43:58Z

Basically what migrations are doing:

they are checking in which state db is (which migration version is applied to DB recenty)
if there are upapplied migrations, they are applied
if any of previous migrations changed, migration will fail

caleb-johnson · 2023-11-01T19:05:04Z

client/quantum_serverless/core/job.py

@@ -127,7 +127,7 @@ def __init__(self, client: JobSubmissionClient):
        self._job_client = client

    def status(self, job_id: str):
-        return self._job_client.get_job_status(job_id)
+        return self._job_client.get_job_status(job_id).value



Since status is an unimplemented BaseJobClient method, I think both the ray and gateway job clients should return a string indicating the status. I updated this in this PR because it affects how I do the status translation in the user-facing job client

so, you basically do not want to return status class? and return status string?
I have no objections, just to confirm :)

I figured since the gateway job client returns a string, we may as well return a string from the ray job client as well, since they both derive from the same base class. Not a big deal, but I thought it was a clean simplification.

caleb-johnson · 2023-11-01T19:06:12Z

client/quantum_serverless/core/job.py

@@ -473,7 +473,7 @@ def __init__(

    def status(self):
        """Returns status of the job."""
-        return self._job_client.status(self.job_id)
+        return _map_status_to_serverless(self._job_client.status(self.job_id))


We will do the translation from any supported job client status to Qiskit terminology here in the user-facing Job client. This is the only place we'll do the translation. Everything underneath this will be Ray terminology.

caleb-johnson · 2023-11-01T19:07:41Z

client/quantum_serverless/core/job.py

@@ -496,7 +496,7 @@ def result(self, wait=True, cadence=5, verbose=False):
        if wait:
            if verbose:
                logging.info("Waiting for job result.")
-            while not self._in_terminal_state():
+            while not self.in_terminal_state():


We don't have a JobStatus object like ray that we can query like Ray's JobStatus.is_terminal, so we will make this Job.in_terminal_state method public, so clients have a way to query whether the job has finished.

caleb-johnson · 2023-11-01T19:49:15Z

@IceKhan13 , I've fixed this up as you suggested. I don't currently have an idea about this strange sphinx error, but Im looking into it. Doesn't seem to be related to the work in this PR, so it's a little confusing

caleb-johnson · 2023-11-01T19:51:30Z

@IceKhan13 , I've fixed this up as you suggested. I don't currently have an idea about this strange sphinx error, but Im looking into it. Doesn't seem to be related to the work in this PR, so it's a little confusing

Hmm, I fixed it locally by removing Program from the docstring in the init file, but the error is still happening in CI. Can't reproduce this locally after removing Program from the docstring.

client/quantum_serverless/core/__init__.py

caleb-johnson · 2023-11-02T13:58:56Z

client/quantum_serverless/core/job.py

+    try:
+        return status_map[status]
+    except KeyError as exc:
+        raise KeyError(f"Cannot interpret unknown job status: {status}") from exc


Maybe we shouldn't error, maybe we should just print the status like you suggested? Not really sure

I think printing is more user friendly :)

IceKhan13 · 2023-11-02T14:49:23Z

Hmm, I fixed it locally by removing Program from the docstring in the init file, but the error is still happening in CI. Can't reproduce this locally after removing Program from the docstring.

merge main and you will be good :)

IceKhan13 · 2023-11-02T14:55:12Z

PR looks good! simple and clean like all great things 😃

caleb-johnson · 2023-11-06T16:05:01Z

Also, when changing records in existing db you need to take care of entries in DB that are already there and convert them too.

Other hotfix option to close this issue would be just to do mapping in client, so you will not need to change anything on a backend and just show in client mapped statuses. Something like
def gateway_to_runtime_statuses(gateway_status):
     mapping = {
         "SUCCEEDED": "DONE"
     }
     return mapping.get(gateway_status, f"APIStatus[{gateway_status}]")

Any particular reason you included the APIStatus[] in the print statement? As of now, status just prints the status name in all caps.

IceKhan13

LGTM

…iskit#1062)" This reverts commit 7a62247.

caleb-johnson marked this pull request as ready for review October 30, 2023 17:21

caleb-johnson requested review from IceKhan13 and Tansito October 30, 2023 17:21

IceKhan13 requested changes Oct 30, 2023

View reviewed changes

gateway/api/migrations/0001_initial.py Outdated Show resolved Hide resolved

IceKhan13 marked this pull request as draft October 31, 2023 13:25

caleb-johnson changed the title ~~Change job status verbiage~~ Translate all job status indicators to Qiskit terminology in client Nov 1, 2023

caleb-johnson changed the title ~~Translate all job status indicators to Qiskit terminology in client~~ Translate all job statuses to Qiskit terminology in client Nov 1, 2023

caleb-johnson commented Nov 1, 2023

View reviewed changes

caleb-johnson force-pushed the job-status branch from a823322 to aa0c2b4 Compare November 1, 2023 19:36

caleb-johnson marked this pull request as ready for review November 1, 2023 19:48

caleb-johnson requested a review from IceKhan13 November 1, 2023 19:48

caleb-johnson commented Nov 1, 2023

View reviewed changes

client/quantum_serverless/core/__init__.py Outdated Show resolved Hide resolved

caleb-johnson force-pushed the job-status branch from 940ebf4 to 4f3520e Compare November 1, 2023 21:24

caleb-johnson commented Nov 2, 2023

View reviewed changes

IceKhan13 added the feature label Nov 2, 2023

caleb-johnson added 9 commits November 6, 2023 10:07

Change job status verbiage

9711495

Don't overwrite ray statuses

aa3eadd

black

fa34fa5

Leftover PENDING. Remove dated status printouts in readmes

8d348f6

Remove old FAILED.

a109c3f

Add bytes to the status field for longer descriptions

63baf91

Add bytes to the status field for longer descriptions

5c55a2d

Add bytes to the status field for longer descriptions

d6ac25d

Restore migration files

dd0acc2

caleb-johnson added 8 commits November 6, 2023 10:07

Translate job statuses on client side.

af47d75

Leave model as-is. Translate statuses client-side

d094fe1

Linter errors. Use Ray terminology in gateway tests

4f5cbca

Revert init file

545f152

Fix weird changes that happened in init file

43893da

Revert change to core init

facfbcd

Revert init change

c14b351

Print unknown statuses rather than error

847c314

caleb-johnson force-pushed the job-status branch from c1dbf7a to 847c314 Compare November 6, 2023 16:08

caleb-johnson added 2 commits November 6, 2023 10:10

Remove unused exception variable

e189e8f

Don't print in the _map_status_to_serverless

3ccdf16

IceKhan13 approved these changes Nov 6, 2023

View reviewed changes

IceKhan13 added the release candidate PR which is a candidate for next release label Nov 6, 2023

caleb-johnson merged commit 7a62247 into Qiskit:main Nov 6, 2023
7 checks passed

caleb-johnson deleted the job-status branch November 6, 2023 18:47

caleb-johnson added a commit to caleb-johnson/quantum-serverless that referenced this pull request Nov 6, 2023

Revert "Translate all job statuses to Qiskit terminology in client (Q…

2f46385

…iskit#1062)" This reverts commit 7a62247.

caleb-johnson restored the job-status branch November 6, 2023 18:59

IceKhan13 mentioned this pull request Dec 12, 2023

Use same status names than Qiskit Job for the programs #684

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Translate all job statuses to Qiskit terminology in client #1062

Translate all job statuses to Qiskit terminology in client #1062

caleb-johnson commented Oct 30, 2023 •

edited

Loading

IceKhan13 left a comment •

edited

Loading

IceKhan13 commented Oct 30, 2023

caleb-johnson Nov 1, 2023

IceKhan13 Nov 2, 2023

caleb-johnson Nov 2, 2023

caleb-johnson Nov 1, 2023

caleb-johnson Nov 1, 2023

caleb-johnson commented Nov 1, 2023

caleb-johnson commented Nov 1, 2023 •

edited

Loading

caleb-johnson Nov 2, 2023

IceKhan13 Nov 2, 2023 •

edited

Loading

IceKhan13 commented Nov 2, 2023

IceKhan13 commented Nov 2, 2023

caleb-johnson commented Nov 6, 2023

IceKhan13 left a comment

Translate all job statuses to Qiskit terminology in client #1062

Translate all job statuses to Qiskit terminology in client #1062

Conversation

caleb-johnson commented Oct 30, 2023 • edited Loading

Summary

IceKhan13 left a comment • edited Loading

Choose a reason for hiding this comment

IceKhan13 commented Oct 30, 2023

caleb-johnson Nov 1, 2023

Choose a reason for hiding this comment

IceKhan13 Nov 2, 2023

Choose a reason for hiding this comment

caleb-johnson Nov 2, 2023

Choose a reason for hiding this comment

caleb-johnson Nov 1, 2023

Choose a reason for hiding this comment

caleb-johnson Nov 1, 2023

Choose a reason for hiding this comment

caleb-johnson commented Nov 1, 2023

caleb-johnson commented Nov 1, 2023 • edited Loading

caleb-johnson Nov 2, 2023

Choose a reason for hiding this comment

IceKhan13 Nov 2, 2023 • edited Loading

Choose a reason for hiding this comment

IceKhan13 commented Nov 2, 2023

IceKhan13 commented Nov 2, 2023

caleb-johnson commented Nov 6, 2023

IceKhan13 left a comment

Choose a reason for hiding this comment

caleb-johnson commented Oct 30, 2023 •

edited

Loading

IceKhan13 left a comment •

edited

Loading

caleb-johnson commented Nov 1, 2023 •

edited

Loading

IceKhan13 Nov 2, 2023 •

edited

Loading