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

Remove name attribute from API components #1284

Merged
merged 42 commits into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
257b3cc
Remove `name` attribute from API components
Eric-Arellano May 2, 2024
fd65ac5
Regenerate qiskit-ibm-provider 0.10.0
Eric-Arellano May 2, 2024
3c0883e
Regenerate qiskit-ibm-provider 0.7.3
Eric-Arellano May 2, 2024
6ba5cf8
Regenerate qiskit-ibm-provider 0.8.0
Eric-Arellano May 2, 2024
f88a2b5
Regenerate qiskit-ibm-provider 0.9.0
Eric-Arellano May 2, 2024
d28aa50
Regenerate qiskit-ibm-provider 0.11.0
Eric-Arellano May 2, 2024
e5b1f35
Regenerate qiskit-ibm-runtime 0.14.0
Eric-Arellano May 2, 2024
181fb8b
Regenerate qiskit-ibm-runtime 0.15.0
Eric-Arellano May 2, 2024
e3b035a
Regenerate qiskit-ibm-runtime 0.16.1
Eric-Arellano May 2, 2024
5e92ff6
Regenerate qiskit-ibm-runtime 0.17.0
Eric-Arellano May 2, 2024
54de1cc
Regenerate qiskit-ibm-runtime 0.18.0
Eric-Arellano May 2, 2024
01bc55b
Regenerate qiskit-ibm-runtime 0.19.1
Eric-Arellano May 2, 2024
5fced21
Regenerate qiskit-ibm-runtime 0.20.0
Eric-Arellano May 2, 2024
4046f45
Regenerate qiskit-ibm-runtime 0.21.1
Eric-Arellano May 2, 2024
c8ce7dd
Regenerate qiskit-ibm-runtime 0.22.0
Eric-Arellano May 2, 2024
4a9ba6c
Regenerate qiskit-ibm-runtime 0.23.0
Eric-Arellano May 2, 2024
840e121
Regenerate qiskit-ibm-runtime 0.24.0-dev
Eric-Arellano May 2, 2024
0b13815
Regenerate qiskit 0.19.6
Eric-Arellano May 2, 2024
0e0042f
Regenerate qiskit 0.24.1
Eric-Arellano May 2, 2024
389517d
Regenerate qiskit 0.25.4
Eric-Arellano May 2, 2024
43bf3ff
Regenerate qiskit 0.26.2
Eric-Arellano May 2, 2024
0fbdb7c
Regenerate qiskit 0.27.0
Eric-Arellano May 2, 2024
e470ea7
Regenerate qiskit 0.28.0
Eric-Arellano May 2, 2024
59dd008
Regenerate qiskit 0.29.1
Eric-Arellano May 2, 2024
5353d13
Regenerate qiskit 0.30.1
Eric-Arellano May 2, 2024
f64a778
Regenerate qiskit 0.31.0
Eric-Arellano May 2, 2024
962a68b
Regenerate qiskit 0.32.1
Eric-Arellano May 2, 2024
795c096
Regenerate qiskit 0.33.1
Eric-Arellano May 2, 2024
7dd57df
Regenerate qiskit 0.35.0
Eric-Arellano May 2, 2024
b798d94
Regenerate qiskit 0.36.0
Eric-Arellano May 2, 2024
7e7f515
Regenerate qiskit 0.37.2
Eric-Arellano May 2, 2024
41011f2
Regenerate qiskit 0.38.0
Eric-Arellano May 2, 2024
463b3e1
Regenerate qiskit 0.39.5
Eric-Arellano May 2, 2024
9044aa3
Regenerate qiskit 0.40.0
Eric-Arellano May 2, 2024
8c1cf4c
Regenerate qiskit 0.41.0
Eric-Arellano May 2, 2024
00af4ac
Regenerate qiskit 0.42.0
Eric-Arellano May 2, 2024
291286d
Regenerate qiskit 0.43.0
Eric-Arellano May 2, 2024
19f743c
Regenerate qiskit 0.44.0
Eric-Arellano May 2, 2024
ea5d9a0
Regenerate qiskit 0.45.3
Eric-Arellano May 2, 2024
d1326af
Regenerate qiskit 0.46.1
Eric-Arellano May 2, 2024
ae535c3
Regenerate qiskit 1.0.2
Eric-Arellano May 2, 2024
ad44ce6
Regenerate qiskit 1.1.0-dev
Eric-Arellano May 2, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
8 changes: 4 additions & 4 deletions docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Message broker for the Publisher / Subscriber mechanism

### publish

<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" name="publish" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L152-L155" signature="publish(event, *args, **kwargs)">
<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L152-L155" signature="publish(event, *args, **kwargs)">
Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.

**Return type**
Expand All @@ -69,7 +69,7 @@ Message broker for the Publisher / Subscriber mechanism

### clear

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" name="clear" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L180-L182" signature="clear()">
<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L180-L182" signature="clear()">
Unsubscribe everything

**Return type**
Expand All @@ -79,7 +79,7 @@ Message broker for the Publisher / Subscriber mechanism

### subscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" name="subscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L168-L173" signature="subscribe(event, callback)">
<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L168-L173" signature="subscribe(event, callback)">
Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.

This is a blocking call, so try to keep callbacks as lightweight as possible.
Expand All @@ -91,7 +91,7 @@ Message broker for the Publisher / Subscriber mechanism

### unsubscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" name="unsubscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L175-L178" signature="unsubscribe(event, callback)">
<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L175-L178" signature="unsubscribe(event, callback)">
Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.

**Return type**
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError

# IBMBackendApiError

<Class id="qiskit_ibm_provider.IBMBackendApiError" name="IBMBackendApiError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L78-L81" signature="IBMBackendApiError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendApiError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L78-L81" signature="IBMBackendApiError(*message)">
Errors that occur unexpectedly when querying the server.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError

# IBMBackendApiProtocolError

<Class id="qiskit_ibm_provider.IBMBackendApiProtocolError" name="IBMBackendApiProtocolError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L84-L87" signature="IBMBackendApiProtocolError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendApiProtocolError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L84-L87" signature="IBMBackendApiProtocolError(*message)">
Errors raised when an unexpected value is received from the server.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError

# IBMBackendError

<Class id="qiskit_ibm_provider.IBMBackendError" name="IBMBackendError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L72-L75" signature="IBMBackendError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L72-L75" signature="IBMBackendError(*message)">
Base class for errors raised by the backend modules.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

### backends

<Function id="qiskit_ibm_provider.IBMBackendService.backends" name="backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L118-L218" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)">
<Function id="qiskit_ibm_provider.IBMBackendService.backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L118-L218" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)">
Return all backends accessible via this account, subject to optional filtering.

**Parameters**
Expand Down Expand Up @@ -96,7 +96,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

### jobs

<Function id="qiskit_ibm_provider.IBMBackendService.jobs" name="jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L220-L368" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
<Function id="qiskit_ibm_provider.IBMBackendService.jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L220-L368" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
Return a list of jobs, subject to optional filtering.

Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
Expand Down Expand Up @@ -134,7 +134,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

### retrieve\_job

<Function id="qiskit_ibm_provider.IBMBackendService.retrieve_job" name="retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L621-L662" signature="retrieve_job(job_id)">
<Function id="qiskit_ibm_provider.IBMBackendService.retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L621-L662" signature="retrieve_job(job_id)">
Return a single job.

**Parameters**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError

# IBMBackendValueError

<Class id="qiskit_ibm_provider.IBMBackendValueError" name="IBMBackendValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L90-L93" signature="IBMBackendValueError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L90-L93" signature="IBMBackendValueError(*message)">
Value errors raised by the backend modules.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError

# IBMError

<Class id="qiskit_ibm_provider.IBMError" name="IBMError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L18-L21" signature="IBMError(*message)">
<Class id="qiskit_ibm_provider.IBMError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L18-L21" signature="IBMError(*message)">
Base class for errors raised by the provider modules.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### backend

<Attribute id="qiskit_ibm_provider.IBMProvider.backend" name="backend">
<Attribute id="qiskit_ibm_provider.IBMProvider.backend">
Return the backend service.

**Return type**
Expand All @@ -124,13 +124,13 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### version

<Attribute id="qiskit_ibm_provider.IBMProvider.version" name="version" attributeValue="1" />
<Attribute id="qiskit_ibm_provider.IBMProvider.version" attributeValue="1" />

## Methods

### active\_account

<Function id="qiskit_ibm_provider.IBMProvider.active_account" name="active_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L426-L435" signature="active_account()">
<Function id="qiskit_ibm_provider.IBMProvider.active_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L426-L435" signature="active_account()">
Return the IBM Quantum account currently in use for the session.

**Return type**
Expand All @@ -144,7 +144,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### backends

<Function id="qiskit_ibm_provider.IBMProvider.backends" name="backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L523-L567" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, **kwargs)">
<Function id="qiskit_ibm_provider.IBMProvider.backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L523-L567" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, **kwargs)">
Return all backends accessible via this account, subject to optional filtering.

**Parameters**
Expand Down Expand Up @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### delete\_account

<Function id="qiskit_ibm_provider.IBMProvider.delete_account" name="delete_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L445-L456" signature="static delete_account(name=None)">
<Function id="qiskit_ibm_provider.IBMProvider.delete_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L445-L456" signature="static delete_account(name=None)">
Delete a saved account from disk.

**Parameters**
Expand All @@ -208,7 +208,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### get\_backend

<Function id="qiskit_ibm_provider.IBMProvider.get_backend" name="get_backend" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L637-L668" signature="get_backend(name=None, instance=None, **kwargs)">
<Function id="qiskit_ibm_provider.IBMProvider.get_backend" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L637-L668" signature="get_backend(name=None, instance=None, **kwargs)">
Return a single backend matching the specified filtering.

**Parameters**
Expand All @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### instances

<Function id="qiskit_ibm_provider.IBMProvider.instances" name="instances" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L437-L443" signature="instances()">
<Function id="qiskit_ibm_provider.IBMProvider.instances" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L437-L443" signature="instances()">
Return the IBM Quantum instances list currently in use for the session.

**Return type**
Expand All @@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### jobs

<Function id="qiskit_ibm_provider.IBMProvider.jobs" name="jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L569-L624" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
<Function id="qiskit_ibm_provider.IBMProvider.jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L569-L624" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
Return a list of jobs, subject to optional filtering.

Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
Expand Down Expand Up @@ -278,7 +278,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### retrieve\_job

<Function id="qiskit_ibm_provider.IBMProvider.retrieve_job" name="retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L626-L635" signature="retrieve_job(job_id)">
<Function id="qiskit_ibm_provider.IBMProvider.retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L626-L635" signature="retrieve_job(job_id)">
Return a single job.

**Parameters**
Expand All @@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### save\_account

<Function id="qiskit_ibm_provider.IBMProvider.save_account" name="save_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L458-L494" signature="static save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)">
<Function id="qiskit_ibm_provider.IBMProvider.save_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L458-L494" signature="static save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)">
Save the account to disk for future use.

**Parameters**
Expand All @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### saved\_accounts

<Function id="qiskit_ibm_provider.IBMProvider.saved_accounts" name="saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L496-L521" signature="static saved_accounts(default=None, name=None)">
<Function id="qiskit_ibm_provider.IBMProvider.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L496-L521" signature="static saved_accounts(default=None, name=None)">
List the accounts saved on disk.

**Parameters**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError

# IBMProviderError

<Class id="qiskit_ibm_provider.IBMProviderError" name="IBMProviderError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L30-L33" signature="IBMProviderError(*message)">
<Class id="qiskit_ibm_provider.IBMProviderError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L30-L33" signature="IBMProviderError(*message)">
Base class for errors raise by IBMProvider.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError

# IBMProviderValueError

<Class id="qiskit_ibm_provider.IBMProviderValueError" name="IBMProviderValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L36-L39" signature="IBMProviderValueError(*message)">
<Class id="qiskit_ibm_provider.IBMProviderValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L36-L39" signature="IBMProviderValueError(*message)">
Value errors raised by IBMProvider.

Set the error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ python_api_name: qiskit_ibm_provider.Session

### active

<Attribute id="qiskit_ibm_provider.Session.active" name="active">
<Attribute id="qiskit_ibm_provider.Session.active">
Return the status of the session.

**Return type**
Expand All @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_provider.Session

### session\_id

<Attribute id="qiskit_ibm_provider.Session.session_id" name="session_id">
<Attribute id="qiskit_ibm_provider.Session.session_id">
Return the session ID.

**Return type**
Expand All @@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_provider.Session

### cancel

<Function id="qiskit_ibm_provider.Session.cancel" name="cancel" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L109-L111" signature="cancel()">
<Function id="qiskit_ibm_provider.Session.cancel" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L109-L111" signature="cancel()">
Set the session.\_active status to False

**Return type**
Expand Down
Loading
Loading