Add job_tags and max_execution_time to options #510
Conversation
Pull Request Test Coverage Report for Build 3191875458
💛 - Coveralls |
qiskit_ibm_runtime/options.py
Outdated
| "job_tags": options.get("job_tags"), | ||
| "max_execution_time": options.get("max_execution_time"), |
There was a problem hiding this comment.
This function is actually meant to return only fields inside the RuntimeOptions class to be passed to QiskitRuntimeService.run(). The docstring of QiskitRuntimeService.run() says the options parameter can only be backend, image, and log_level. If you want to change that you'll need to update docstring + release note.
qiskit_ibm_runtime/options.py
Outdated
| max_execution_time: Maximum execution time in seconds. This overrides | ||
| the max_execution_time of the program and cannot exceed it. |
There was a problem hiding this comment.
I find this description a bit confusing. What does "overrides the max_execution_time of the program" mean? Does it update the max_execution_time metadata of a program? I don't think that's how this works?
qiskit_ibm_runtime/options.py
Outdated
| the max_execution_time of the program and cannot exceed it. | ||
|
|
||
| job_tags: Tags to be assigned to the job. The tags can subsequently be used | ||
| as a filter in the :meth:`jobs()` function call. |
There was a problem hiding this comment.
| as a filter in the :meth:`jobs()` function call. | |
| as a filter in the :meth:`qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. |
There is no jobs() method in this file so the reference link needs to be fully qualified.
| @@ -860,6 +860,7 @@ def run( | |||
| inputs: Program input parameters. These input values are passed | |||
| to the runtime program. | |||
| options: Runtime options that control the execution environment. | |||
| ``job_tags`` and ``max_execution_time`` can also be set here. | |||
There was a problem hiding this comment.
I think your intent is to move job_tags and max_execution_time to be part of RuntimeOptions class. If that's the case, then 1) the use of them as separate input args should be deprecated and 2) docstring should list them as bullet points, similar to backend, image, and log_level.
There was a problem hiding this comment.
Is this something we want to do? Deprecate job_tags and max_execution_time as input args and have them passed in through in options instead?
There was a problem hiding this comment.
Yeah since I think it's rather confusing to have some options inside options and some outside.
| @@ -860,6 +860,7 @@ def run( | |||
| inputs: Program input parameters. These input values are passed | |||
| to the runtime program. | |||
| options: Runtime options that control the execution environment. | |||
| ``job_tags`` and ``max_execution_time`` can also be set here. | |||
There was a problem hiding this comment.
Yeah since I think it's rather confusing to have some options inside options and some outside.
qiskit_ibm_runtime/options.py
Outdated
| @@ -191,6 +198,8 @@ class Options: | |||
| Default: ``True``. | |||
| """ | |||
|
|
|||
| max_execution_time: int = None | |||
| job_tags: List[str] = None | |||
There was a problem hiding this comment.
I created a new EnvironmentOptions in my last PR as an attempt to organize less commonly used options (such as image) that is not related to transpilation or execution. I think job_tags can go there too, but max_execution_time can stay at level 1 as it's more likely to be used.
|
closing in favor of #565 |
Summary
Details and comments
Fixes #473