From cc15db44767efd06f6405d5d2409a136352a418c Mon Sep 17 00:00:00 2001 From: Fran Cabrera Date: Wed, 18 Dec 2024 14:43:04 +0000 Subject: [PATCH] Improved documentation for the private option (#2086) * Improved documentation for the private option * Updating docstring * updating incorrect wording --- qiskit_ibm_runtime/runtime_options.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/qiskit_ibm_runtime/runtime_options.py b/qiskit_ibm_runtime/runtime_options.py index 19c56013a..822fc0aa0 100644 --- a/qiskit_ibm_runtime/runtime_options.py +++ b/qiskit_ibm_runtime/runtime_options.py @@ -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