Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved documentation for the private option #2086

Merged
merged 3 commits into from
Dec 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion qiskit_ibm_runtime/runtime_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,12 @@ def __init__(
this time limit, it is forcibly cancelled. Simulator jobs continue to use wall
clock time.
session_time: Length of session in seconds.
private: Boolean of whether or not the job is marked as private.
private: Boolean that indicates whether the job is marked as private. This is only
supported for ``ibm_quantum`` channel. When set to true, input parameters are not
returned, and the results can only be read once. After the results are read or after
a specified time after the job is completed, the results are deleted from the service.
When set to false, the input parameters and results follow the standard retention
behavior.
"""
self.backend = backend
self.image = image
Expand Down
Loading