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.

Sign up for GitHub

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

Regen Runtime and Provider with full release notes and precise GitHub links #931

Merged
merged 4 commits into from
Feb 29, 2024
Merged

Regen Runtime and Provider with full release notes and precise GitHub links #931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b4b724
Regen Runtime and Provider with full release notes and precise GitHub…
Eric-Arellano Feb 28, 2024
f8f6bfc
Merge branch 'main' of github.com:Qiskit/documentation into EA/regen-…
Eric-Arellano Feb 29, 2024
5893a4d
Remove release notes ignores
Eric-Arellano Feb 29, 2024
fec4606
Fix broken links
Eric-Arellano Feb 29, 2024
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
4 changes: 2 additions & 2 deletions docs/api/qiskit-ibm-provider/ibm_utils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism

<span id="qiskit_ibm_provider.utils.pubsub.Publisher" />

`Publisher` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py "view source code")
`Publisher` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L140-L155 "view source code")

Represents a “publisher”.

Expand All @@ -68,7 +68,7 @@ Triggers an event, and associates some data to it, so if there are any subscribe

<span id="qiskit_ibm_provider.utils.pubsub.Subscriber" />

`Subscriber` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py "view source code")
`Subscriber` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L158-L182 "view source code")

Represents a “subscriber”.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend

<span id="qiskit_ibm_provider.IBMBackend" />

`IBMBackend(configuration, provider, api_client, instance=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py "view source code")
`IBMBackend(configuration, provider, api_client, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py#L79-L895 "view source code")

Backend class interfacing with an IBM Quantum device.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError

<span id="qiskit_ibm_provider.IBMBackendApiError" />

`IBMBackendApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMBackendApiError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L78-L81 "view source code")

Errors that occur unexpectedly when querying the server.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError

<span id="qiskit_ibm_provider.IBMBackendApiProtocolError" />

`IBMBackendApiProtocolError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMBackendApiProtocolError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L84-L87 "view source code")

Errors raised when an unexpected value is received from the server.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError

<span id="qiskit_ibm_provider.IBMBackendError" />

`IBMBackendError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMBackendError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L72-L75 "view source code")

Base class for errors raised by the backend modules.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

<span id="qiskit_ibm_provider.IBMBackendService" />

`IBMBackendService(provider, hgp)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py "view source code")
`IBMBackendService(provider, hgp)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L61-L741 "view source code")

Backend namespace for an IBM Quantum account.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError

<span id="qiskit_ibm_provider.IBMBackendValueError" />

`IBMBackendValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMBackendValueError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L90-L93 "view source code")

Value errors raised by the backend modules.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMError

<span id="qiskit_ibm_provider.IBMError" />

`IBMError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L18-L21 "view source code")

Base class for errors raised by the provider modules.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

<span id="qiskit_ibm_provider.IBMProvider" />

`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py "view source code")
`IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L46-L671 "view source code")

Provides access to the IBM Quantum services available to an account.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError

<span id="qiskit_ibm_provider.IBMProviderError" />

`IBMProviderError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMProviderError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L30-L33 "view source code")

Base class for errors raise by IBMProvider.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError

<span id="qiskit_ibm_provider.IBMProviderValueError" />

`IBMProviderValueError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py "view source code")
`IBMProviderValueError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L36-L39 "view source code")

Value errors raised by IBMProvider.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.Session

<span id="qiskit_ibm_provider.Session" />

`Session(max_time=None, session_id=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py "view source code")
`Session(max_time=None, session_id=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L22-L123 "view source code")

Class for creating a flexible Qiskit Runtime session.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob

<span id="qiskit_ibm_provider.job.IBMCircuitJob" />

`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code")
`IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_circuit_job.py#L59-L860 "view source code")

Representation of a job that executes on an IBM Quantum backend.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob

<span id="qiskit_ibm_provider.job.IBMCompositeJob" />

`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py "view source code")
`IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py#L72-L1317 "view source code")

Representation of a set of jobs that execute on an IBM Quantum backend.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError

<span id="qiskit_ibm_provider.job.IBMJobApiError" />

`IBMJobApiError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code")
`IBMJobApiError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L26-L29 "view source code")

Errors that occur unexpectedly when querying the server.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError

<span id="qiskit_ibm_provider.job.IBMJobError" />

`IBMJobError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code")
`IBMJobError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L20-L23 "view source code")

Base class for errors raised by the job modules.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError

<span id="qiskit_ibm_provider.job.IBMJobFailureError" />

`IBMJobFailureError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code")
`IBMJobFailureError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L32-L35 "view source code")

Errors raised when a job failed.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError

<span id="qiskit_ibm_provider.job.IBMJobInvalidStateError" />

`IBMJobInvalidStateError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code")
`IBMJobInvalidStateError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L38-L41 "view source code")

Errors raised when a job is not in a valid state for the operation.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError

<span id="qiskit_ibm_provider.job.IBMJobTimeoutError" />

`IBMJobTimeoutError(*message)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py "view source code")
`IBMJobTimeoutError(*message)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L44-L47 "view source code")

Errors raised when a job operation times out.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo

<span id="qiskit_ibm_provider.job.QueueInfo" />

`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/queueinfo.py "view source code")
`QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/queueinfo.py#L25-L183 "view source code")

Queue information for a job.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.job.job_monitor

<span id="qiskit_ibm_provider.job.job_monitor" />

`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/job_monitor.py "view source code")
`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/job_monitor.py#L99-L116 "view source code")

Monitor the status of an `IBMJob` instance.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.least_busy

<span id="qiskit_ibm_provider.least_busy" />

`least_busy(backends)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/__init__.py "view source code")
`least_busy(backends)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/__init__.py#L104-L140 "view source code")

Return the least busy backend from a list.

Expand Down
2 changes: 1 addition & 1 deletion ...ovider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAn

<span id="qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis" />

`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code")
`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py#L437-L665 "view source code")

Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass.

Expand Down
2 changes: 1 addition & 1 deletion ...ovider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAn

<span id="qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis" />

`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py "view source code")
`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/scheduler.py#L304-L434 "view source code")

Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass.

Expand Down
2 changes: 1 addition & 1 deletion ...bm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadde

<span id="qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder" />

`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py "view source code")
`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/block_base_padder.py#L38-L641 "view source code")

The base class of padding pass.

Expand Down
2 changes: 1 addition & 1 deletion ...ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit

<span id="qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations" />

`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py "view source code")
`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/utils.py#L133-L367 "view source code")

For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends.

Expand Down
2 changes: 1 addition & 1 deletion ...iskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay

<span id="qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay" />

`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py "view source code")
`PadDelay(fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/pad_delay.py#L22-L78 "view source code")

Padding idle time with Delay instructions.

Expand Down
2 changes: 1 addition & 1 deletion ...ider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDe

<span id="qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling" />

`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py "view source code")
`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/transpiler/passes/scheduling/dynamical_decoupling.py#L39-L583 "view source code")

Dynamical decoupling insertion pass for IBM dynamic circuit backends.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.seconds_to_duration

<span id="qiskit_ibm_provider.utils.seconds_to_duration" />

`seconds_to_duration(seconds)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py "view source code")
`seconds_to_duration(seconds)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py#L140-L160 "view source code")

Converts seconds in a datetime delta to a duration.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.to_python_identifier

<span id="qiskit_ibm_provider.utils.to_python_identifier" />

`to_python_identifier(name)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py "view source code")
`to_python_identifier(name)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py#L66-L89 "view source code")

Convert a name to a valid Python identifier.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.utc_to_local

<span id="qiskit_ibm_provider.utils.utc_to_local" />

`utc_to_local(utc_dt)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py "view source code")
`utc_to_local(utc_dt)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/converters.py#L25-L43 "view source code")

Convert a UTC `datetime` object or string to a local timezone `datetime`.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python_api_name: qiskit_ibm_provider.utils.validate_job_tags

<span id="qiskit_ibm_provider.utils.validate_job_tags" />

`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py "view source code")
`validate_job_tags(job_tags, exception)` [GitHub](https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/utils.py#L92-L108 "view source code")

Validates input job tags.

Expand Down
Loading
Loading