iO>SrSSKJr SSKJrJrJrJrJr SSK J r SSK J r SSK Jr SSKJr SS KJr SS KJrJr SS KJr SS KJr SS KJr SSKJr SSKJr SSK J!r! Sr""SS5r#g)z Qiskit Runtime flexible session.) annotations)DictOptionalTypeUnionAny) TracebackTypewraps) BackendV2)QiskitRuntimeService)RequestsApiError)IBMInputValueErrorIBMRuntimeError) RuntimeJobV2) ResultDecoder) IBMBackendset_cm_session)hms_to_seconds)QiskitRuntimeLocalServicec0^[T5U4Sj5nU$)z/Decorator used to ensure the session is active.cT>UR(d [S5eT"U/UQ70UD6$)NzThe session is closed.)_activer)selfargskwargsfuncs T/home/james-whalen/.local/lib/python3.13/site-packages/qiskit_ibm_runtime/session.py_wrapper!_active_session.._wrapper%s+||!":; ;D*4*6**r )rr!s` r _active_sessionr$"s" 4[++ Or#c\rSrSrSrSSS.SSjjjrSS.SSjjr\SSSjj5rSS jr SS jr SS jr SS jr SS jr SSjr\SSj5r\SSj5r\SSj5rS SjrS!SjrSrg)"Session.aVClass for creating a Qiskit Runtime session. A Qiskit Runtime ``session`` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. You can open a Qiskit Runtime session using this ``Session`` class and submit jobs to one or more primitives. For example:: from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager from qiskit_ibm_runtime import QiskitRuntimeService, Session, SamplerV2 as Sampler service = QiskitRuntimeService() backend = service.least_busy(operational=True, simulator=False) # Bell Circuit qr = QuantumRegister(2, name="qr") cr = ClassicalRegister(2, name="cr") qc = QuantumCircuit(qr, cr, name="bell") qc.h(qr[0]) qc.cx(qr[0], qr[1]) qc.measure(qr, cr) pm = generate_preset_pass_manager(backend=backend, optimization_level=1) isa_circuit = pm.run(qc) with Session(backend=backend) as session: sampler = Sampler(mode=session) job = sampler.run([isa_circuit]) pub_result = job.result()[0] print(f"Sampler job ID: {job.job_id()}") print(f"Counts: {pub_result.data.cr.get_counts()}") NT create_newcpSUlSUlSUlSUlSUl[ U[ 5(aURUlXlOB[ U[5(a[5UlXlO[S[U535eUb[ U[5(aUO [US5Ul[ UR[ 5(aZURRUlURR5R (dUR#US9Ulggg)ajSession constructor. Args: backend: Instance of ``Backend`` class. max_time: Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like "2h 30m 40s". This value must be less than the `system imposed maximum `_. create_new: If True, the POST session API endpoint will be called to create a new session. Prevents creating a new session when ``from_id()`` is called. Raises: ValueError: If an input value is invalid. NTzInvalid backend type zInvalid max_time value: r()_service_backend _instancer _session_id isinstancerservicer r ValueErrortypeintr _max_time configuration simulator_create_session)rbackendmax_timer)s r __init__Session.__init__Ts.UY -1   gz * *#OODM#M ) - -57DM#M4T']ODE E:h#<#< *DE  dmmZ 0 0!]]44DN==..0::#'#7#7:#7#N ; 1r#c$[UR[5(aqU(ajURRUR5R UR 5URURS5nURS5$g)zCreate a session. dedicatedidN) r/r+r _get_api_clientr-create_sessionr8r4get)rr)sessions r r7Session._create_sessionsd dmm%9 : :zmm33DNNCRR  G;;t$ $r#c tU=(d 0nSU;aURUS'URUS'[UR[5(aMURR UUUUR SUUS9nURcUR5UlU$URR UUUUS9nU$)aPRun a program in the session. Args: program_id: Program ID. inputs: Program input parameters. These input values are passed to the runtime program. options: Runtime options that control the execution environment. calibration_id: The calibration id to use with the program execution Returns: Submitted job. instancer8F) program_idoptionsinputs session_id start_sessionresult_decodercalibration_id)rFrGrHrL)r-r,r/r+r _runr.r8)rrFrHrGrKrLjobs r rM Session._runs*-R W $"&..GJ !]]  dmm%9 : :--$$%++#--%C}}$ #   --$$%- %C r#cSUlUR(a_[UR[5(a?URR UR 5RUR5 ggg)z%Cancel all pending jobs in a session.FN)rr.r/r+r r?r-cancel_sessionrs r cancelSession.cancelsS    4==:N O O MM ) )$.. 9 H HIYIY Z!P r#cSUlUR(a_[UR[5(a?URR UR 5RUR5 ggg)zClose the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs.FN)rr.r/r+r r?r- close_sessionrRs r close Session.closesU    4==:N O O MM ) )$.. 9 G GHXHX Y!P r#cUR(aJURRS:XaURR$URR5$g)zZReturn backend for this session. Returns: Backend for this session. None if unknown. N)r,versionnamerRs r r8Session.backendsA ==)-)>)>!)C4==%% ]I[I[I] ]r#cUR5nU(aIUSnUSnUS;agUS:XaU(dUS:XagUS:XaU(aUS:Xag UR5$g ) aReturn current session status. Returns: Session status as a string. * ``Pending``: Session is created but not active. It will become active when the next job of this session is dequeued. * ``In progress, accepting new jobs``: session is active and accepting new jobs. * ``In progress, not accepting new jobs``: session is active and not accepting new jobs. * ``Closed``: max_time expired or session was explicitly closed. * ``None``: status details are not available. stateaccepting_jobs)openinactivePendingactivepending_inactivezIn progress, accepting new jobspending_closedz#In progress, not accepting new jobsN)details capitalize)rrgr_r`s r statusSession.statusso,,. G$E$%56N,, !nBT9T8!.UFV=V<##% %r#cUR(au[UR[5(aVURR UR 5R UR5nU(aURS5$g)zReturn session usage in seconds. Session usage is the time from when the first job starts until the session goes inactive, is closed, or when its last job completes, whichever happens last. Batch usage is the amount of time all jobs spend on the QPU. elapsed_timeNr.r/r+r r?r-session_detailsrArresponses r usage Session.usagesa    4==:N O O}}44T^^DTT  H||N33r#cUR(GaH[UR[5(Ga(URR UR 5R UR5nU(aURS5URS5URS5URS5URS5URS5URS5URS5URS 5URS 5URS 5URS 5URS 5URS5S.$g)aReturn session details. Returns: A dictionary with the sessions details. * ``id``: id of the session. * ``backend_name``: backend used for the session. * ``interactive_timeout``: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. * ``max_time``: Maximum allowed time (in seconds) for the session, subject to plan limits. * ``active_timeout``: The maximum time (in seconds) a session can stay active. * ``state``: State of the session - open, active, inactive, or closed. * ``accepting_jobs``: Whether or not the session is accepting jobs. * ``last_job_started``: Timestamp of when the last job in the session started. * ``last_job_completed``: Timestamp of when the last job in the session completed. * ``started_at``: Timestamp of when the session was started. * ``closed_at``: Timestamp of when the session was closed. * ``activated_at``: Timestamp of when the session state was changed to active. * ``mode``: Execution mode of the session. * ``usage_time``: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job. r> backend_nameinteractive_ttlmax_ttl active_ttlr_r`last_job_startedlast_job_completed started_at closed_at activated_atmoderl)r>rtinteractive_timeoutr9active_timeoutr_r`rxryrzr{r|r} usage_timeNrmros r rgSession.detailss .     4==:N O O}}44T^^DTT  H",,t,$,LL$@+3<<8I+J ( Y 7&.ll<&@%\\'2&.ll3C&D(0 5G(H*2,,7K*L"*,,|" r#cUR$)zUReturn the session ID. Returns: Session ID. None if the backend is a simulator. )r.rRs r rISession.session_id2sr#cUR$)zReturn service associated with this session. Returns: :class:`qiskit_ibm_runtime.QiskitRuntimeService` associated with this session. )r+rRs r r0Session.service;s}}r#c bUR5nURU5nUR5RU5nURS5n U (d [S5eURU 5n URS5n URS5n URR5S:XaS OURR5n X:wa[S US U S U S 35eU"U SS9nU S:XaSUlXlU$![anURS:XaSnUR 5R 5HAupgXs:wdM UcMXrlURU5n O![a nSnAM;SnAff=f Uc[SUR35SeSnAGNSnAff=f)aConstruct a Session object with a given ``session_id``. For example: .. code-block:: from qiskit_ibm_runtime import QiskitRuntimeService, Session service = QiskitRuntimeService() job = service.job() existing_session_id = job.session_id new_session = Session.from_id(existing_session_id, service) Args: session_id: the id of the session to be created. This must be an already existing session id. service: instance of the ``QiskitRuntimeService`` class. Raises: IBMInputValueError: If given `session_id` does not exist. IBMRuntimeError: If the backend of the session is unknown. Returns: A new Session with the given ``session_id`` iNzSession not found: rtz@The backend of this session is unknown. Try running a job first.r}r_rBr=z Input ID z has execution mode z instead of .Fr(closed)r?rnr status_code_get_api_clientsitems_active_api_clientrmessagerArr8__name__lowerrr.)clsrIr0current_clientrpexrEclient_rtr8r}r_ class_namerBs r from_idSession.from_idDs4!002 [%55jAH**,<rsH'"33.3,;(/#1,B aar#