diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json index 75418c97ff9..ea08ecb1cd7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_toc.json +++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json @@ -98,26 +98,14 @@ "title": "FakeAlgiers", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers" }, - { - "title": "FakeAlmaden", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden" - }, { "title": "FakeAlmadenV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" }, - { - "title": "FakeArmonk", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk" - }, { "title": "FakeArmonkV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2" }, - { - "title": "FakeAthens", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens" - }, { "title": "FakeAthensV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2" @@ -126,26 +114,14 @@ "title": "FakeAuckland", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland" }, - { - "title": "FakeBelem", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem" - }, { "title": "FakeBelemV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2" }, - { - "title": "FakeBoeblingen", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen" - }, { "title": "FakeBoeblingenV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" }, - { - "title": "FakeBogota", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota" - }, { "title": "FakeBogotaV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2" @@ -154,42 +130,22 @@ "title": "FakeBrisbane", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane" }, - { - "title": "FakeBrooklyn", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn" - }, { "title": "FakeBrooklynV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" }, - { - "title": "FakeBurlington", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington" - }, { "title": "FakeBurlingtonV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" }, - { - "title": "FakeCairo", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo" - }, { "title": "FakeCairoV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2" }, - { - "title": "FakeCambridge", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge" - }, { "title": "FakeCambridgeV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" }, - { - "title": "FakeCasablanca", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca" - }, { "title": "FakeCasablancaV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" @@ -198,10 +154,6 @@ "title": "FakeCusco", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco" }, - { - "title": "FakeEssex", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex" - }, { "title": "FakeEssexV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2" @@ -214,34 +166,18 @@ "title": "FakeGeneva", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva" }, - { - "title": "FakeGuadalupe", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe" - }, { "title": "FakeGuadalupeV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" }, - { - "title": "FakeHanoi", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi" - }, { "title": "FakeHanoiV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2" }, - { - "title": "FakeJakarta", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta" - }, { "title": "FakeJakartaV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2" }, - { - "title": "FakeJohannesburg", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg" - }, { "title": "FakeJohannesburgV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" @@ -250,10 +186,6 @@ "title": "FakeKawasaki", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki" }, - { - "title": "FakeKolkata", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata" - }, { "title": "FakeKolkataV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2" @@ -266,74 +198,38 @@ "title": "FakeKyoto", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto" }, - { - "title": "FakeLagos", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos" - }, { "title": "FakeLagosV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2" }, - { - "title": "FakeLima", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima" - }, { "title": "FakeLimaV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2" }, - { - "title": "FakeLondon", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon" - }, { "title": "FakeLondonV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2" }, - { - "title": "FakeManhattan", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan" - }, { "title": "FakeManhattanV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2" }, - { - "title": "FakeManila", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila" - }, { "title": "FakeManilaV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2" }, - { - "title": "FakeMelbourne", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne" - }, { "title": "FakeMelbourneV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" }, - { - "title": "FakeMontreal", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal" - }, { "title": "FakeMontrealV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2" }, - { - "title": "FakeMumbai", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai" - }, { "title": "FakeMumbaiV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" }, - { - "title": "FakeNairobi", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi" - }, { "title": "FakeNairobiV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2" @@ -346,18 +242,10 @@ "title": "FakeOslo", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo" }, - { - "title": "FakeOurense", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense" - }, { "title": "FakeOurenseV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2" }, - { - "title": "FakeParis", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis" - }, { "title": "FakeParisV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2" @@ -370,10 +258,6 @@ "title": "FakePerth", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth" }, - { - "title": "FakePoughkeepsie", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie" - }, { "title": "FakePoughkeepsieV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" @@ -382,10 +266,6 @@ "title": "FakePrague", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague" }, - { - "title": "FakeProvider", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider" - }, { "title": "FakeProviderForBackendV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" @@ -394,38 +274,18 @@ "title": "FakeQuebec", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec" }, - { - "title": "FakeQuito", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito" - }, { "title": "FakeQuitoV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2" }, - { - "title": "FakeRochester", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester" - }, { "title": "FakeRochesterV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2" }, - { - "title": "FakeRome", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome" - }, { "title": "FakeRomeV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2" }, - { - "title": "FakeRueschlikon", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon" - }, - { - "title": "FakeSantiago", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago" - }, { "title": "FakeSantiagoV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2" @@ -434,70 +294,34 @@ "title": "FakeSherbrooke", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke" }, - { - "title": "FakeSingapore", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore" - }, { "title": "FakeSingaporeV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2" }, - { - "title": "FakeSydney", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney" - }, { "title": "FakeSydneyV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2" }, - { - "title": "FakeTenerife", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife" - }, - { - "title": "FakeTokyo", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo" - }, { "title": "FakeTorino", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino" }, - { - "title": "FakeToronto", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto" - }, { "title": "FakeTorontoV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2" }, - { - "title": "FakeValencia", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia" - }, { "title": "FakeValenciaV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2" }, - { - "title": "FakeVigo", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo" - }, { "title": "FakeVigoV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2" }, - { - "title": "FakeWashington", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington" - }, { "title": "FakeWashingtonV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2" }, - { - "title": "FakeYorktown", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown" - }, { "title": "FakeYorktownV2", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2" diff --git a/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx b/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx index bfa3a7108e0..a2bbde4e8a9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx @@ -81,7 +81,6 @@ Fake providers provide access to a list of fake backends. | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2")() | Fake provider containing fake V2 backends. | -| [`FakeProvider`](qiskit_ibm_runtime.fake_provider.FakeProvider "qiskit_ibm_runtime.fake_provider.FakeProvider")() | Fake provider containing fake V1 backends. | ## Fake Backends @@ -149,53 +148,3 @@ Fake V2 backends are fake backends with IBM Quantum systems snapshots implemente | [`FakeWashingtonV2`](qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2")() | A fake 127 qubit backend. | | [`FakeYorktownV2`](qiskit_ibm_runtime.fake_provider.FakeYorktownV2 "qiskit_ibm_runtime.fake_provider.FakeYorktownV2")() | A fake 5 qubit backend. | -### Fake V1 Backends - -Fake V1 backends are fake backends with IBM Quantum systems snapshots implemented with `BackendV1` interface. - -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`FakeAlmaden`](qiskit_ibm_runtime.fake_provider.FakeAlmaden "qiskit_ibm_runtime.fake_provider.FakeAlmaden")() | A fake Almaden backend. | -| [`FakeArmonk`](qiskit_ibm_runtime.fake_provider.FakeArmonk "qiskit_ibm_runtime.fake_provider.FakeArmonk")() | A fake 1 qubit backend. | -| [`FakeAthens`](qiskit_ibm_runtime.fake_provider.FakeAthens "qiskit_ibm_runtime.fake_provider.FakeAthens")() | A fake 5 qubit backend. | -| [`FakeBelem`](qiskit_ibm_runtime.fake_provider.FakeBelem "qiskit_ibm_runtime.fake_provider.FakeBelem")() | A fake 5 qubit backend. | -| [`FakeBoeblingen`](qiskit_ibm_runtime.fake_provider.FakeBoeblingen "qiskit_ibm_runtime.fake_provider.FakeBoeblingen")() | A fake Boeblingen backend. | -| [`FakeBogota`](qiskit_ibm_runtime.fake_provider.FakeBogota "qiskit_ibm_runtime.fake_provider.FakeBogota")() | A fake 5 qubit backend. | -| [`FakeBrooklyn`](qiskit_ibm_runtime.fake_provider.FakeBrooklyn "qiskit_ibm_runtime.fake_provider.FakeBrooklyn")() | A fake Brooklyn backend. | -| [`FakeBurlington`](qiskit_ibm_runtime.fake_provider.FakeBurlington "qiskit_ibm_runtime.fake_provider.FakeBurlington")() | A fake 5 qubit backend. | -| [`FakeCairo`](qiskit_ibm_runtime.fake_provider.FakeCairo "qiskit_ibm_runtime.fake_provider.FakeCairo")() | A fake 27 qubit backend. | -| [`FakeCambridge`](qiskit_ibm_runtime.fake_provider.FakeCambridge "qiskit_ibm_runtime.fake_provider.FakeCambridge")() | A fake Cambridge backend. | -| [`FakeCasablanca`](qiskit_ibm_runtime.fake_provider.FakeCasablanca "qiskit_ibm_runtime.fake_provider.FakeCasablanca")() | A fake 7 qubit backend. | -| [`FakeEssex`](qiskit_ibm_runtime.fake_provider.FakeEssex "qiskit_ibm_runtime.fake_provider.FakeEssex")() | A fake 5 qubit backend. | -| [`FakeGuadalupe`](qiskit_ibm_runtime.fake_provider.FakeGuadalupe "qiskit_ibm_runtime.fake_provider.FakeGuadalupe")() | A fake 16 qubit backend. | -| [`FakeHanoi`](qiskit_ibm_runtime.fake_provider.FakeHanoi "qiskit_ibm_runtime.fake_provider.FakeHanoi")() | A fake 27 qubit backend. | -| [`FakeJakarta`](qiskit_ibm_runtime.fake_provider.FakeJakarta "qiskit_ibm_runtime.fake_provider.FakeJakarta")() | A fake 7 qubit backend. | -| [`FakeJohannesburg`](qiskit_ibm_runtime.fake_provider.FakeJohannesburg "qiskit_ibm_runtime.fake_provider.FakeJohannesburg")() | A fake Johannesburg backend. | -| [`FakeKolkata`](qiskit_ibm_runtime.fake_provider.FakeKolkata "qiskit_ibm_runtime.fake_provider.FakeKolkata")() | A fake 27 qubit backend. | -| [`FakeLagos`](qiskit_ibm_runtime.fake_provider.FakeLagos "qiskit_ibm_runtime.fake_provider.FakeLagos")() | A fake 7 qubit backend. | -| [`FakeLima`](qiskit_ibm_runtime.fake_provider.FakeLima "qiskit_ibm_runtime.fake_provider.FakeLima")() | A fake 5 qubit backend. | -| [`FakeLondon`](qiskit_ibm_runtime.fake_provider.FakeLondon "qiskit_ibm_runtime.fake_provider.FakeLondon")() | A fake 5 qubit backend. | -| [`FakeManhattan`](qiskit_ibm_runtime.fake_provider.FakeManhattan "qiskit_ibm_runtime.fake_provider.FakeManhattan")() | A fake Manhattan backend. | -| [`FakeManila`](qiskit_ibm_runtime.fake_provider.FakeManila "qiskit_ibm_runtime.fake_provider.FakeManila")() | A fake 5 qubit backend. | -| [`FakeMelbourne`](qiskit_ibm_runtime.fake_provider.FakeMelbourne "qiskit_ibm_runtime.fake_provider.FakeMelbourne")() | A fake 14 qubit backend. | -| [`FakeMontreal`](qiskit_ibm_runtime.fake_provider.FakeMontreal "qiskit_ibm_runtime.fake_provider.FakeMontreal")() | A fake 27 qubit backend. | -| [`FakeMumbai`](qiskit_ibm_runtime.fake_provider.FakeMumbai "qiskit_ibm_runtime.fake_provider.FakeMumbai")() | A fake 27 qubit backend. | -| [`FakeNairobi`](qiskit_ibm_runtime.fake_provider.FakeNairobi "qiskit_ibm_runtime.fake_provider.FakeNairobi")() | A fake 7 qubit backend. | -| [`FakeOurense`](qiskit_ibm_runtime.fake_provider.FakeOurense "qiskit_ibm_runtime.fake_provider.FakeOurense")() | A fake 5 qubit backend. | -| [`FakeParis`](qiskit_ibm_runtime.fake_provider.FakeParis "qiskit_ibm_runtime.fake_provider.FakeParis")() | A fake Paris backend. | -| [`FakePoughkeepsie`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsie "qiskit_ibm_runtime.fake_provider.FakePoughkeepsie")() | A fake Poughkeepsie backend. | -| [`FakeQuito`](qiskit_ibm_runtime.fake_provider.FakeQuito "qiskit_ibm_runtime.fake_provider.FakeQuito")() | A fake 5 qubit backend. | -| [`FakeRochester`](qiskit_ibm_runtime.fake_provider.FakeRochester "qiskit_ibm_runtime.fake_provider.FakeRochester")() | A fake Rochester backend. | -| [`FakeRome`](qiskit_ibm_runtime.fake_provider.FakeRome "qiskit_ibm_runtime.fake_provider.FakeRome")() | A fake 5 qubit backend. | -| [`FakeRueschlikon`](qiskit_ibm_runtime.fake_provider.FakeRueschlikon "qiskit_ibm_runtime.fake_provider.FakeRueschlikon")() | A fake 16 qubit backend. | -| [`FakeSantiago`](qiskit_ibm_runtime.fake_provider.FakeSantiago "qiskit_ibm_runtime.fake_provider.FakeSantiago")() | A fake Santiago backend. | -| [`FakeSingapore`](qiskit_ibm_runtime.fake_provider.FakeSingapore "qiskit_ibm_runtime.fake_provider.FakeSingapore")() | A fake Singapore backend. | -| [`FakeSydney`](qiskit_ibm_runtime.fake_provider.FakeSydney "qiskit_ibm_runtime.fake_provider.FakeSydney")() | A fake 27 qubit backend. | -| [`FakeTenerife`](qiskit_ibm_runtime.fake_provider.FakeTenerife "qiskit_ibm_runtime.fake_provider.FakeTenerife")() | A fake 5 qubit backend. | -| [`FakeTokyo`](qiskit_ibm_runtime.fake_provider.FakeTokyo "qiskit_ibm_runtime.fake_provider.FakeTokyo")() | A fake 20 qubit backend. | -| [`FakeToronto`](qiskit_ibm_runtime.fake_provider.FakeToronto "qiskit_ibm_runtime.fake_provider.FakeToronto")() | A fake 27 qubit backend. | -| [`FakeValencia`](qiskit_ibm_runtime.fake_provider.FakeValencia "qiskit_ibm_runtime.fake_provider.FakeValencia")() | A fake 5 qubit backend. | -| [`FakeVigo`](qiskit_ibm_runtime.fake_provider.FakeVigo "qiskit_ibm_runtime.fake_provider.FakeVigo")() | A fake 5 qubit backend. | -| [`FakeWashington`](qiskit_ibm_runtime.fake_provider.FakeWashington "qiskit_ibm_runtime.fake_provider.FakeWashington")() | A fake 127 qubit backend. | -| [`FakeYorktown`](qiskit_ibm_runtime.fake_provider.FakeYorktown "qiskit_ibm_runtime.fake_provider.FakeYorktown")() | A fake 5 qubit backend. | - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index 449d3d26409..fdc3133d58a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx deleted file mode 100644 index 7bdfdc23c2d..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: FakeAlmaden -description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmaden -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden ---- - -# FakeAlmaden - - - A fake Almaden backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ - 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 - ↕ ↕ ↕ - 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 - ↕ ↕ - 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlmaden.run "qiskit_ibm_runtime.fake_provider.FakeAlmaden.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 77d00086461..9b17e54e73d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx deleted file mode 100644 index 1f529419e83..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: FakeArmonk -description: API reference for qiskit_ibm_runtime.fake_provider.FakeArmonk -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk ---- - -# FakeArmonk - - - A fake 1 qubit backend. - - ```python - 0 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeArmonk.run "qiskit_ibm_runtime.fake_provider.FakeArmonk.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 693ce294e39..4d10c1177d3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -213,7 +213,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -229,7 +229,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### configuration - + Return the backend configuration. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -279,7 +279,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -314,7 +314,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -330,7 +330,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### properties - + Return the backend properties **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -398,7 +398,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -443,7 +443,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx deleted file mode 100644 index 0e0ef3b84f8..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeAthens -description: API reference for qiskit_ibm_runtime.fake_provider.FakeAthens -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens ---- - -# FakeAthens - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAthens.run "qiskit_ibm_runtime.fake_provider.FakeAthens.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index de1ba0110c9..d23d75e4d72 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index d1a77c75658..ce68a8cb100 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx deleted file mode 100644 index f34245a095b..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeBelem -description: API reference for qiskit_ibm_runtime.fake_provider.FakeBelem -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem ---- - -# FakeBelem - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBelem.run "qiskit_ibm_runtime.fake_provider.FakeBelem.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index e558104c0b4..5335f36c0a0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx deleted file mode 100644 index 1f7a0471ff8..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ /dev/null @@ -1,165 +0,0 @@ ---- -title: FakeBoeblingen -description: API reference for qiskit_ibm_runtime.fake_provider.FakeBoeblingen -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen ---- - -# FakeBoeblingen - - - A fake Boeblingen backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ - 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 - ↕ ↕ ↕ - 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 - ↕ ↕ - 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBoeblingen.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingen.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 1995c28e8e1..525be9a90c5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx deleted file mode 100644 index 704731db2b7..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeBogota -description: API reference for qiskit_ibm_runtime.fake_provider.FakeBogota -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota ---- - -# FakeBogota - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBogota.run "qiskit_ibm_runtime.fake_provider.FakeBogota.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 59108df7286..5757d00c8aa 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index 402e9ff6b94..4ceecc1ad01 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx deleted file mode 100644 index 3ac1e8ce929..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeBrooklyn -description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrooklyn -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn ---- - -# FakeBrooklyn - - - A fake Brooklyn backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrooklyn.run "qiskit_ibm_runtime.fake_provider.FakeBrooklyn.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index ddf95cfa022..ca3f11b6c48 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx deleted file mode 100644 index 3a538bdbfe2..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: FakeBurlington -description: API reference for qiskit_ibm_runtime.fake_provider.FakeBurlington -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington ---- - -# FakeBurlington - - - A fake 5 qubit backend. - - ```python - 0 ↔ 1 ↔ 3 ↔ 4 - ↕ - 2 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBurlington.run "qiskit_ibm_runtime.fake_provider.FakeBurlington.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 352f6fbe23e..bfd3a73c981 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx deleted file mode 100644 index 73dd7ea5baf..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeCairo -description: API reference for qiskit_ibm_runtime.fake_provider.FakeCairo -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo ---- - -# FakeCairo - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCairo.run "qiskit_ibm_runtime.fake_provider.FakeCairo.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index 0639196cb11..5c115428025 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx deleted file mode 100644 index e90426d3762..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: FakeCambridge -description: API reference for qiskit_ibm_runtime.fake_provider.FakeCambridge -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge ---- - -# FakeCambridge - - - A fake Cambridge backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ - 05 06 - ↕ ↕ - 07 ↔ 08 ↔ 09 ↔ 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 ↔ 15 - ↕ ↕ ↕ - 16 17 18 - ↕ ↕ ↕ - 19 ↔ 20 ↔ 21 ↔ 22 ↔ 23 ↔ 24 ↔ 25 ↔ 26 ↔ 27 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCambridge.run "qiskit_ibm_runtime.fake_provider.FakeCambridge.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index ab779a6dc70..762b17491f4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### configuration - + Return the backend configuration. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -287,7 +287,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### properties - + Return the backend properties **Parameters** @@ -381,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -406,7 +406,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -451,7 +451,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx deleted file mode 100644 index 93f3db0493c..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeCasablanca -description: API reference for qiskit_ibm_runtime.fake_provider.FakeCasablanca -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca ---- - -# FakeCasablanca - - - A fake 7 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCasablanca.run "qiskit_ibm_runtime.fake_provider.FakeCasablanca.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index cdeeb706f15..61ae23aad0d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index 82457735571..b47eb53c352 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx deleted file mode 100644 index 25a69d4a3fb..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: FakeEssex -description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssex -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex ---- - -# FakeEssex - - - A fake 5 qubit backend. - - ```python - 0 ↔ 1 ↔ 2 - ↕ - 3 - ↕ - 4 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeEssex.run "qiskit_ibm_runtime.fake_provider.FakeEssex.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index ed70da1bd40..e89ef820f1b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx index 7077f5e7fb2..e7bd841d271 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx @@ -216,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -232,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### configuration - + Return the backend configuration. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -282,7 +282,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -301,7 +301,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -317,7 +317,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -333,7 +333,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### properties - + Return the backend properties **Parameters** @@ -376,7 +376,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -401,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -446,7 +446,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 817f5c62a54..678006812fa 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx deleted file mode 100644 index 22106a1eeec..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeGuadalupe -description: API reference for qiskit_ibm_runtime.fake_provider.FakeGuadalupe -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe ---- - -# FakeGuadalupe - - - A fake 16 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGuadalupe.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupe.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index 233ed382be3..f08b260de4e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx deleted file mode 100644 index 4dde4670e21..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeHanoi -description: API reference for qiskit_ibm_runtime.fake_provider.FakeHanoi -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi ---- - -# FakeHanoi - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeHanoi.run "qiskit_ibm_runtime.fake_provider.FakeHanoi.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index 95621ac6874..68b68d33dfb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx deleted file mode 100644 index 9d07e1b3cc1..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeJakarta -description: API reference for qiskit_ibm_runtime.fake_provider.FakeJakarta -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta ---- - -# FakeJakarta - - - A fake 7 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJakarta.run "qiskit_ibm_runtime.fake_provider.FakeJakarta.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index eb1823393ff..15bfc96012e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx deleted file mode 100644 index aa643bbca20..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: FakeJohannesburg -description: API reference for qiskit_ibm_runtime.fake_provider.FakeJohannesburg -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg ---- - -# FakeJohannesburg - - - A fake Johannesburg backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ - 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 - ↕ ↕ ↕ - 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 - ↕ ↕ - 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJohannesburg.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburg.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index 2641e1f6080..e1369c4713a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index 57e536a89b0..9d074fa4d18 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx deleted file mode 100644 index 27b1f6dc19c..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeKolkata -description: API reference for qiskit_ibm_runtime.fake_provider.FakeKolkata -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata ---- - -# FakeKolkata - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKolkata.run "qiskit_ibm_runtime.fake_provider.FakeKolkata.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index 9be5840d86d..3c47270d6fa 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index b01143510e7..9c052802774 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index f5e55051572..34f7d062777 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx deleted file mode 100644 index 5ac215a2d82..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeLagos -description: API reference for qiskit_ibm_runtime.fake_provider.FakeLagos -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos ---- - -# FakeLagos - - - A fake 7 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLagos.run "qiskit_ibm_runtime.fake_provider.FakeLagos.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index ad6ff9860f6..ff33ff615e5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx deleted file mode 100644 index 39a7f94ca47..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeLima -description: API reference for qiskit_ibm_runtime.fake_provider.FakeLima -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima ---- - -# FakeLima - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLima.run "qiskit_ibm_runtime.fake_provider.FakeLima.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 3e919f188f8..902760c8b47 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx deleted file mode 100644 index 6096537e4a8..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: FakeLondon -description: API reference for qiskit_ibm_runtime.fake_provider.FakeLondon -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon ---- - -# FakeLondon - - - A fake 5 qubit backend. - - ```python - 0 ↔ 1 ↔ 2 - ↕ - 3 - ↕ - 4 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLondon.run "qiskit_ibm_runtime.fake_provider.FakeLondon.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index b94c5b611d9..5728b2604e8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx deleted file mode 100644 index 386c6f4895f..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeManhattan -description: API reference for qiskit_ibm_runtime.fake_provider.FakeManhattan -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan ---- - -# FakeManhattan - - - A fake Manhattan backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManhattan.run "qiskit_ibm_runtime.fake_provider.FakeManhattan.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index 0ec3f23e2aa..2237a5d17df 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx deleted file mode 100644 index a3ee4f790c1..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeManila -description: API reference for qiskit_ibm_runtime.fake_provider.FakeManila -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila ---- - -# FakeManila - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManila.run "qiskit_ibm_runtime.fake_provider.FakeManila.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 275d8a938ca..cce2a39fa06 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx deleted file mode 100644 index 6e8155de839..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: FakeMelbourne -description: API reference for qiskit_ibm_runtime.fake_provider.FakeMelbourne -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne ---- - -# FakeMelbourne - - - A fake 14 qubit backend. - - ```python - 0 ← 1 → 2 → 3 ← 4 ← 5 → 6 - ↑ ↑ ↑ ↓ ↓ ↓ - 13 → 12 ← 11 → 10 ← 9 → 8 ← 7 - ``` - - ## Attributes - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMelbourne.run "qiskit_ibm_runtime.fake_provider.FakeMelbourne.run") method. - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index c91519ae148..7e70120730c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx deleted file mode 100644 index 0505171f6b4..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeMontreal -description: API reference for qiskit_ibm_runtime.fake_provider.FakeMontreal -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal ---- - -# FakeMontreal - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMontreal.run "qiskit_ibm_runtime.fake_provider.FakeMontreal.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 7789e0890ed..ef22a836cd6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx deleted file mode 100644 index 4bec75f8482..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeMumbai -description: API reference for qiskit_ibm_runtime.fake_provider.FakeMumbai -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai ---- - -# FakeMumbai - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMumbai.run "qiskit_ibm_runtime.fake_provider.FakeMumbai.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index 5d362f547c8..dee02ff89f1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx deleted file mode 100644 index 310c5d3e994..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeNairobi -description: API reference for qiskit_ibm_runtime.fake_provider.FakeNairobi -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi ---- - -# FakeNairobi - - - A fake 7 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeNairobi.run "qiskit_ibm_runtime.fake_provider.FakeNairobi.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index a7c7fa5781d..11eb2a67a8f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index ab15096daf3..a943b59e0fc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 4f52933b795..9955bc1b47c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx deleted file mode 100644 index 0af3017bf01..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: FakeOurense -description: API reference for qiskit_ibm_runtime.fake_provider.FakeOurense -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense ---- - -# FakeOurense - - - A fake 5 qubit backend. - - ```python - 0 ↔ 1 ↔ 3 ↔ 4 - ↕ - 2 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOurense.run "qiskit_ibm_runtime.fake_provider.FakeOurense.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index 25ef901fd4f..6dda2655d39 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx deleted file mode 100644 index f1f324fa71e..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: FakeParis -description: API reference for qiskit_ibm_runtime.fake_provider.FakeParis -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis ---- - -# FakeParis - - - A fake Paris backend. - - ```python - 06 17 - ↕ ↕ - 00 ↔ 01 ↔ 04 ↔ 07 ↔ 10 ↔ 12 ↔ 15 ↔ 18 ↔ 20 ↔ 23 - ↕ ↕ ↕ - 02 13 24 - ↕ ↕ ↕ - 03 ↔ 05 ↔ 08 ↔ 11 ↔ 14 ↔ 16 ↔ 19 ↔ 22 ↔ 25 ↔ 26 - ↕ ↕ - 09 20 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeParis.run "qiskit_ibm_runtime.fake_provider.FakeParis.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index 2ed848ea0e0..3e50ce59fd3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### configuration - + Return the backend configuration. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -287,7 +287,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### properties - + Return the backend properties **Parameters** @@ -381,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -406,7 +406,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -451,7 +451,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 5d84cec340e..008c426cc5e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 24a5b523470..e0280bca34d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx deleted file mode 100644 index 8889e7ad01a..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: FakePoughkeepsie -description: API reference for qiskit_ibm_runtime.fake_provider.FakePoughkeepsie -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie ---- - -# FakePoughkeepsie - - - A fake Poughkeepsie backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ - 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 - ↕ ↕ ↕ - 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 - ↕ ↕ - 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 - ``` - - ## Attributes - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.run") method. - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index c4398ab6cc1..d2939bd7103 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index 7f5417d5b9e..9c67ec6f11c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx deleted file mode 100644 index eedb62a83ed..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: FakeProvider -description: API reference for qiskit_ibm_runtime.fake_provider.FakeProvider -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider ---- - -# FakeProvider - - - Fake provider containing fake V1 backends. - - Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). - - - The class `qiskit.providers.provider.Provider` is deprecated as of qiskit 1.1. It will be removed no earlier than 3 months after the release date. The abstract Provider and ProviderV1 classes are deprecated and will be removed in 2.0. You can just remove it as the parent class and a get\_backend method that returns the backends from self.backend. - - - ## Attributes - - ### version - - - - ## Methods - - ### backends - - - Return a list of backends matching the specified filtering. - - **Parameters** - - * **name** (*str*) – name of the backend. - * **\*\*kwargs** – dict used for filtering. - - **Returns** - - **a list of Backends that match the filtering** - - criteria. - - **Return type** - - list\[Backend] - - - ### get\_backend - - - Return a single backend matching the specified filtering. - - - The method `qiskit.providers.provider.ProviderV1.get_backend()` is deprecated as of qiskit 1.1. It will be removed no earlier than 3 months after the release date. The abstract Provider and ProviderV1 classes are deprecated and will be removed in 2.0. You can just remove it as the parent class and a get\_backend method that returns the backends from self.backend. - - - **Parameters** - - * **name** (*str*) – name of the backend. - * **\*\*kwargs** – dict used for filtering. - - **Returns** - - a backend matching the filtering. - - **Return type** - - Backend - - **Raises** - - **QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index d85596dd229..0d3c90566ea 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). @@ -17,7 +17,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backend - + Filter backends in provider by name. **Return type** @@ -27,22 +27,12 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backends - + Return all backends accessible via this account. **Return type** `List`\[`FakeBackendV2`] - - ### get\_backend - - - Return a single backend matching the specified filtering. - - **Return type** - - `FakeBackendV2` - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 4f97cc4ca54..2093f386bbf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx deleted file mode 100644 index 45904d6b354..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeQuito -description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuito -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito ---- - -# FakeQuito - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuito.run "qiskit_ibm_runtime.fake_provider.FakeQuito.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 5f6b0f80c3b..bff23d7e4de 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx deleted file mode 100644 index 1dc8dc3498f..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: FakeRochester -description: API reference for qiskit_ibm_runtime.fake_provider.FakeRochester -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester ---- - -# FakeRochester - - - A fake Rochester backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRochester.run "qiskit_ibm_runtime.fake_provider.FakeRochester.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index f8dad5be0db..164cc740dd4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx deleted file mode 100644 index aa824999a8b..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeRome -description: API reference for qiskit_ibm_runtime.fake_provider.FakeRome -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome ---- - -# FakeRome - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRome.run "qiskit_ibm_runtime.fake_provider.FakeRome.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 16ab72b0b82..f453c17b617 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx deleted file mode 100644 index 0899f1366a0..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: FakeRueschlikon -description: API reference for qiskit_ibm_runtime.fake_provider.FakeRueschlikon -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon ---- - -# FakeRueschlikon - - - A fake 16 qubit backend. - - ```python - 1 → 2 → 3 → 4 ← 5 ← 6 → 7 ← 8 - ↓ ↑ ↓ ↓ ↑ ↓ ↓ ↑ - 0 ← 15 → 14 ← 13 ← 12 → 11 → 10 ← 9 - ``` - - ## Attributes - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRueschlikon.run "qiskit_ibm_runtime.fake_provider.FakeRueschlikon.run") method. - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Return backend properties - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx deleted file mode 100644 index a3283f90beb..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeSantiago -description: API reference for qiskit_ibm_runtime.fake_provider.FakeSantiago -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago ---- - -# FakeSantiago - - - A fake Santiago backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSantiago.run "qiskit_ibm_runtime.fake_provider.FakeSantiago.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index a029ff63fd0..cc3f82194e2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 1a8df4092c7..6c75d4dac72 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx deleted file mode 100644 index ffc340d7b6d..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: FakeSingapore -description: API reference for qiskit_ibm_runtime.fake_provider.FakeSingapore -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore ---- - -# FakeSingapore - - - A fake Singapore backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ - 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 - ↕ ↕ ↕ - 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 - ↕ ↕ - 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSingapore.run "qiskit_ibm_runtime.fake_provider.FakeSingapore.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index 224203fff3c..6bfce6bca73 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx deleted file mode 100644 index 085996b8285..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeSydney -description: API reference for qiskit_ibm_runtime.fake_provider.FakeSydney -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney ---- - -# FakeSydney - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSydney.run "qiskit_ibm_runtime.fake_provider.FakeSydney.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index c08a45c654b..3e6bdef3498 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx deleted file mode 100644 index 17006b8286f..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: FakeTenerife -description: API reference for qiskit_ibm_runtime.fake_provider.FakeTenerife -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife ---- - -# FakeTenerife - - - A fake 5 qubit backend. - - ```python - 1 - ↙ ↑ - 0 ← 2 ← 3 - ↑ ↙ - 4 - ``` - - ## Attributes - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTenerife.run "qiskit_ibm_runtime.fake_provider.FakeTenerife.run") method. - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties as recorded on 8/30/19. - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx deleted file mode 100644 index 828f4e7764a..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: FakeTokyo -description: API reference for qiskit_ibm_runtime.fake_provider.FakeTokyo -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo ---- - -# FakeTokyo - - - A fake 20 qubit backend. - - ```python - 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 - ↕ ↕ ↕ ↕ ⤫ ↕ - 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 - ↕ ⤫ ↕ ↕ ⤫ ↕ - 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 - ↕ ↕ ⤫ ↕ ⤫ ↕ - 15 ↔ 16 ↔ 17 18 19 - ``` - - ## Attributes - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTokyo.run "qiskit_ibm_runtime.fake_provider.FakeTokyo.run") method. - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties as recorded on 8/30/19. - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index 8e9f9a5d48c..896444a28da 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx deleted file mode 100644 index da6cbf0e615..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeToronto -description: API reference for qiskit_ibm_runtime.fake_provider.FakeToronto -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto ---- - -# FakeToronto - - - A fake 27 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeToronto.run "qiskit_ibm_runtime.fake_provider.FakeToronto.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index de0daf6f154..33338aea7df 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx deleted file mode 100644 index 52460277a84..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeValencia -description: API reference for qiskit_ibm_runtime.fake_provider.FakeValencia -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia ---- - -# FakeValencia - - - A fake 5 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeValencia.run "qiskit_ibm_runtime.fake_provider.FakeValencia.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 7d5eae06736..4af35e97ba3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx deleted file mode 100644 index 7d5b67ad381..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: FakeVigo -description: API reference for qiskit_ibm_runtime.fake_provider.FakeVigo -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo ---- - -# FakeVigo - - - A fake 5 qubit backend. - - ```python - 0 ↔ 1 ↔ 3 ↔ 4 - ↕ - 2 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeVigo.run "qiskit_ibm_runtime.fake_provider.FakeVigo.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index 404b5d6ccb6..f5189b3f2ea 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx deleted file mode 100644 index 5c200b891a5..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: FakeWashington -description: API reference for qiskit_ibm_runtime.fake_provider.FakeWashington -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington ---- - -# FakeWashington - - - A fake 127 qubit backend. - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### defs\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeWashington.run "qiskit_ibm_runtime.fake_provider.FakeWashington.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### defaults - - - Returns a snapshot of device defaults - - **Return type** - - `PulseDefaults` - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 738fe4d4c9c..d791f0604ae 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx deleted file mode 100644 index fd452e586ec..00000000000 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: FakeYorktown -description: API reference for qiskit_ibm_runtime.fake_provider.FakeYorktown -in_page_toc_min_heading_level: 1 -python_api_type: class -python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown ---- - -# FakeYorktown - - - A fake 5 qubit backend. - - ```python - 1 - / | - 0 - 2 - 3 - | / - 4 - ``` - - FakeBackend initializer. - - **Parameters** - - * **configuration** (*BackendConfiguration*) – backend configuration - * **time\_alive** (*int*) – time to wait before returning result - - ## Attributes - - ### backend\_name - - - - ### conf\_filename - - - - ### dirname - - - - ### options - - - Return the options for the backend - - The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeYorktown.run "qiskit_ibm_runtime.fake_provider.FakeYorktown.run") method. - - - ### props\_filename - - - - ### version - - - - ## Methods - - ### configuration - - - Return the backend configuration. - - **Returns** - - the configuration for the backend. - - **Return type** - - BackendConfiguration - - - ### name - - - Return the backend name. - - **Returns** - - the name of the backend. - - **Return type** - - str - - - ### properties - - - Returns a snapshot of device properties - - **Return type** - - `BackendProperties` - - - ### provider - - - Return the backend Provider. - - **Returns** - - the Provider responsible for the backend. - - **Return type** - - Provider - - - ### run - - - Main job in simulator - - - ### set\_options - - - Set the options fields for the backend - - This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. - - **Parameters** - - **fields** – The fields to update the options - - **Raises** - - **AttributeError** – If the field passed in is not part of the options - - - ### status - - - Return the backend status. - - **Returns** - - the status of the backend. - - **Return type** - - BackendStatus - - - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index 0db5e4303e5..5a7931098dd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index e2d46a11b36..c18e1ea73d0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,47 +8,56 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). - **Parameters** + ## Attributes - * **enable** – Whether to enable DD as specified by the other options in this class. Default: False. + ### enable - * **sequence\_type** – + + Whether to enable DD as specified by the other options in this class. - Which dynamical decoupling sequence to use. Default: “XX”. + Default: False. + - * `"XX"`: use the sequence `tau/2 - (+X) - tau - (+X) - tau/2` - * `"XpXm"`: use the sequence `tau/2 - (+X) - tau - (-X) - tau/2` - * `"XY4"`: : use the sequence `tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2` + ### extra\_slack\_distribution - * **extra\_slack\_distribution** – + + Where to put extra timing delays due to rounding issues. Rounding issues arise because the discrete time step `dt` of the system cannot be divided. This option takes following values. - Where to put extra timing delays due to rounding issues. Rounding issues arise because the discrete time step `dt` of the system cannot be divided. This option takes following values. Default: “middle”. + Default: “middle”. - * `"middle"`: Put the extra slack to the interval at the middle of the sequence. - * `"edges"`: Divide the extra slack as evenly as possible into intervals at beginning and end of the sequence. + * `"middle"`: Put the extra slack to the interval at the middle of the sequence. - * **scheduling\_method** – Whether to schedule gates as soon as (“asap”) or as late as (“alap”) possible. Default: “alap”. + * **`"edges"`: Divide the extra slack as evenly as possible into intervals at** - ## Attributes + beginning and end of the sequence. + - ### enable + ### scheduling\_method - + + Whether to schedule gates as soon as (“asap”) or as late as (“alap”) possible. - ### extra\_slack\_distribution + Default: “alap”. + - + ### sequence\_type - ### scheduling\_method + + Which dynamical decoupling sequence to use. - + Default: “XX”. - ### sequence\_type + * `"XX"`: use the sequence `tau/2 - (+X) - tau - (+X) - tau/2` + + * `"XpXm"`: use the sequence `tau/2 - (+X) - tau - (-X) - tau/2` + + * **`"XY4"`:use the sequence** - + `tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2` + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index f05b8ad42c3..1767b6f67f7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -11,40 +11,40 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions Options related to the execution environment. - **Parameters** - - * **log\_level** – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. Default: `WARNING`. - - * **callback** – - - Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: - - > 1. Job ID - > 2. Job result. - - Default: `None`. - - * **job\_tags** – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. Default: `None`. - - * **private** – Boolean value for marking jobs as private. - ## Attributes ### callback - + + Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job result. + + Default: `None`. + ### job\_tags - + + Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. + + Default: `None`. + ### log\_level - + + logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. + + Default: `WARNING`. + ### private - + + Boolean value for marking jobs as private. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx index 047b8aafbb4..b84bf338c86 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,73 +8,40 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. - **Parameters** - - * **default\_precision** – The default precision to use for any PUB or `run()` call that does not specify one. Each estimator pub can specify its own precision. If the `run()` method is given a precision, then that value is used for all PUBs in the `run()` call that do not specify their own. Default: 0.015625 (1 / sqrt(4096)). - - * **default\_shots** – - - The total number of shots to use per circuit per configuration. - - - If set, this value overrides [`default_precision`](#qiskit_ibm_runtime.options.EstimatorOptions.default_precision "qiskit_ibm_runtime.options.EstimatorOptions.default_precision"). - - - A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions. - - If twirling is enabled, the value of this option will be divided over circuit, randomizations, with a smaller number of shots per randomization. See the [`twirling`](#qiskit_ibm_runtime.options.EstimatorOptions.twirling "qiskit_ibm_runtime.options.EstimatorOptions.twirling") options. - - Default: `None`. - - * **optimization\_level** – - - (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. - - * 0: no optimization - * 1: light optimization - - Default: 0. - - * **resilience\_level** – - - How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times. - - * 0: No mitigation. - * 1: Minimal mitigation costs. Mitigate error associated with readout errors. - * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. - - Refer to the [Configure error mitigation for Qiskit Runtime](/guides/configure-error-mitigation). for more information about the error mitigation methods used at each level. - - Default: 1. - - * **seed\_estimator** – Seed used to control sampling. Default: `None`. - - * **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + ## Attributes - * **resilience** – Advanced resilience options to fine tune the resilience strategy. See [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") for all available options. + ### default\_precision - * **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + + The default precision to use for any PUB or `run()` call that does not specify one. Each Estimator PUB can specify its own precision. If the `run()` method is given a precision, then that value is used for all PUBs in the `run()` call that do not specify their own. - * **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + Default: 0.015625 (1 / sqrt(4096)). + - * **experimental** – Experimental options. These options are subject to change without notification, and stability is not guaranteed. + ### default\_shots - ## Attributes + + The total number of shots to use per circuit per configuration. - ### default\_precision + + If set, this value overrides [`default_precision`](#qiskit_ibm_runtime.options.EstimatorOptions.default_precision "qiskit_ibm_runtime.options.EstimatorOptions.default_precision"). + - + A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions. - ### default\_shots + If twirling is enabled, the value of this option will be divided over circuit randomizations, with a smaller number of shots per randomization. See the [`twirling`](#qiskit_ibm_runtime.options.EstimatorOptions.twirling "qiskit_ibm_runtime.options.EstimatorOptions.twirling") options. - + Default: `None`. + ### dynamical\_decoupling - + + Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + ### environment @@ -82,11 +49,15 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions ### execution - + + Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + ### experimental - + + Experimental options. These options are subject to change without notification, and stability is not guaranteed. + ### max\_execution\_time @@ -94,19 +65,46 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions ### optimization\_level - + + (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. + + * 0: no optimization + * 1: light optimization + + Default: 0. + ### resilience - + + Advanced resilience options to fine-tune the resilience strategy. See [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") for all available options. + ### resilience\_level - + + How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times. + + * 0: No mitigation. + + * 1: Minimal mitigation costs. Mitigate error associated with readout errors. + + * **2: Medium mitigation costs. Typically reduces bias in estimators but** + + is not guaranteed to be zero bias. + + Refer to the [Configure error mitigation for Qiskit Runtime](/guides/configure-error-mitigation) guide for more information about the error mitigation methods used at each level. + + Default: 1. + ### seed\_estimator - + + Seed used to control sampling. + + Default: `None`. + ### simulator @@ -114,7 +112,9 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions ### twirling - + + Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index b600b764b8b..02412c1e3df 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,37 +8,46 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. This is only used by V2 Estimator. These options are only used when the resilience level or options specify a technique that requires layer noise learning. - **Parameters** - - * **max\_layers\_to\_learn** – The max number of unique layers to learn. A `None` value indicates that there is no limit. If there are more unique layers present, then some layers will not be learned or mitigated. The learned layers are prioritized based on the number of times they occur in a set of run estimator PUBs, and for equally occurring layers are further sorted by the number of two-qubit gates in the layer. Default: 4. - * **shots\_per\_randomization** – The total number of shots to use per random learning circuit. A learning circuit is a random circuit at a specific learning depth with a specific measurement basis that is executed on hardware. Default: 128. - * **num\_randomizations** – The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). Default: 32. - * **layer\_pair\_depths** – The circuit depths (measured in number of pairs) to use in learning experiments. Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. A value of `3` would correspond to 6 layers of the layer of interest, for example. Default: (0, 1, 2, 4, 16, 32). - ## Attributes ### layer\_pair\_depths - + + The circuit depths (measured in number of pairs) to use in learning experiments. Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. A value of `3` would correspond to 6 layers of the layer of interest, for example. + + Default: (0, 1, 2, 4, 16, 32). + ### max\_layers\_to\_learn - + + The max number of unique layers to learn. A `None` value indicates that there is no limit. If there are more unique layers present, then some layers will not be learned or mitigated. The learned layers are prioritized based on the number of times they occur in a set of run Estimator PUBs, and for equally occurring layers are further sorted by the number of two-qubit gates in the layer. + + Default: 4. + ### num\_randomizations - + + The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). + + Default: 32. + ### shots\_per\_randomization - + + The total number of shots to use per random learning circuit. A learning circuit is a random circuit at a specific learning depth with a specific measurement basis that is executed on hardware. + + Default: 128. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx index 7a7e86281e4..d7385cae7b8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,27 +8,30 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. This is only used by V2 Estimator. These options are only used when the resilience level or options specify a technique that requires measurement noise learning. - **Parameters** - - * **num\_randomizations** – The number of random circuits to draw for the measurement learning experiment. Default: 32. - * **shots\_per\_randomization** – The number of shots to use for the learning experiment per random circuit. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. - ## Attributes ### num\_randomizations - + + The number of random circuits to draw for the measurement learning experiment. + + Default: 32. + ### shots\_per\_randomization - + + The number of shots to use for the learning experiment per random circuit. If “auto”, the value will be chosen automatically based on the input PUBs. + + Default: “auto”. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx index b4506ab0bc6..d169c518683 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,33 +8,33 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. This is only used by V2 Estimator. - **Parameters** - - * **max\_overhead** – The maximum circuit sampling overhead allowed, or `None` for no maximum. Default: 100. - - * **noise\_gain** – + ## Attributes - The amount by which to scale the noise, where: + ### max\_overhead - * A value of 0 corresponds to removing the full learned noise. - * A value of 1 corresponds to no removal of the learned noise. - * A value between 0 and 1 corresponds to partially removing the learned noise. - * A value greater than one corresponds to amplifying the learned noise. + + The maximum circuit sampling overhead allowed, or `None` for no maximum. - If “auto”, the value in the range `[0, 1]` will be chosen automatically for each input PUB based on the learned noise strength, `max_overhead`, and the depth of the PUB. Default: “auto”. + Default: 100. + - ## Attributes + ### noise\_gain - ### max\_overhead + + The amount by which to scale the noise, where: - + * A value of 0 corresponds to removing the full learned noise. + * A value of 1 corresponds to no removal of the learned noise. + * A value between 0 and 1 corresponds to partially removing the learned noise. + * A value greater than one corresponds to amplifying the learned noise. - ### noise\_gain + If “auto”, the value in the range `[0, 1]` will be chosen automatically for each input PUB based on the learned noise strength, `max_overhead`, and the depth of the PUB. - + Default: “auto”. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx index 312e039af6d..06ce5c79774 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -8,53 +8,64 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 # ResilienceOptionsV2 - + Resilience options for V2 Estimator. - **Parameters** - - * **measure\_mitigation** – Whether to enable measurement error mitigation method. If you enable measurement mitigation, you can fine tune its noise learning by using [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all measurement mitigation noise learning options. Default: True. - * **measure\_noise\_learning** – Additional measurement noise learning options. See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all options. - * **zne\_mitigation** – Whether to turn on Zero Noise Extrapolation error mitigation method. If you enable ZNE, you can fine tune its options by using [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for additional ZNE related options. Default: False. - * **zne** – Additional zero noise extrapolation mitigation options. See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for all options. - * **pec\_mitigation** – Whether to turn on Probabilistic Error Cancellation error mitigation method. If you enable PEC, you can fine tune its options by using [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for additional PEC related options. Default: False. - * **pec** – Additional probabalistic error cancellation mitigation options. See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for all options. - * **layer\_noise\_learning** – Layer noise learning options. See [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for all options. - * **layer\_noise\_model** – A `NoiseLearnerResult` or a sequence of `LayerError` objects. If set, all the mitigation strategies that require noise data (e.g., PEC and PEA) skip the noise learning stage, and instead gather the required information from `layer_noise_model`. Layers whose information is missing in `layer_noise_model` are treated as noiseless and their noise is not mitigated. - ## Attributes ### layer\_noise\_learning - + + Layer noise learning options. See [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for all options. + ### layer\_noise\_model - + + A `NoiseLearnerResult` or a sequence of `LayerError` objects. If set, all the mitigation strategies that require noise data (e.g., PEC and PEA) skip the noise-learning stage, and instead gather the required information from `layer_noise_model`. Layers whose information is missing in `layer_noise_model` are treated as noiseless and their noise is not mitigated. + ### measure\_mitigation - + + Whether to enable measurement error mitigation method. If you enable measurement mitigation, you can fine-tune its noise learning by using [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all measurement mitigation noise learning options. + + Default: True. + ### measure\_noise\_learning - + + Additional measurement noise learning options. See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all options. + ### pec - + + Additional probabalistic error cancellation mitigation options. See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for all options. + ### pec\_mitigation - + + Whether to turn on Probabilistic Error Cancellation error mitigation method. If you enable PEC, you can fine-tune its options by using [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for additional PEC-related options. + + Default: False. + ### zne - + + Additional zero-noise extrapolation mitigation options. See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for all options. + ### zne\_mitigation - + + Whether to turn on Zero-Noise Extrapolation error mitigation method. If you enable ZNE, you can fine-tune its options by using [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for additional ZNE related options. + + Default: False. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx index 357c221d353..cb7a5bd3e1f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,26 +8,24 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. - **Parameters** - - * **default\_shots** – The default number of shots to use if none are specified in the PUBs or in the run method. Default: 4096. - * **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. - * **execution** – Execution time options. See [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") for all available options. - * **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. - * **experimental** – Experimental options. - ## Attributes ### default\_shots - + + The default number of shots to use if none are specified in the PUBs or in the run method. + + Default: 4096. + ### dynamical\_decoupling - + + Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + ### environment @@ -35,11 +33,15 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### execution - + + Execution time options. See [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") for all available options. + ### experimental - + + Experimental options. + ### max\_execution\_time @@ -51,7 +53,9 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### twirling - + + Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx index 6a696f552f5..75bf98aa6f0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,41 +8,50 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. - **Parameters** - - * **noise\_model** – Noise model for the simulator. Default: `None`. - * **seed\_simulator** – Random seed to control sampling. Default: `None`. - * **coupling\_map** – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]`. Default: `None`, which implies no connectivity constraints. - * **basis\_gates** – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. Default: all basis gates supported by the simulator. - ## Attributes ### basis\_gates - + + List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. + + Default: all basis gates supported by the simulator. + ### coupling\_map - + + Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interaction, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]`. + + Default: `None`, which implies no connectivity constraints. + ### noise\_model - + + Noise model for the simulator. + + Default: `None`. + ### seed\_simulator - + + Random seed to control sampling. + + Default: `None`. + ## Methods ### set\_backend - + Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. **Parameters** diff --git a/docs/api/qiskit/dev/circuit.mdx b/docs/api/qiskit/dev/circuit.mdx index 4625e16445d..9a07463bf0b 100644 --- a/docs/api/qiskit/dev/circuit.mdx +++ b/docs/api/qiskit/dev/circuit.mdx @@ -812,9 +812,9 @@ For a more backend-like simulation experience, there are simulator-backed implem A common task in mapping abstract circuits to physical hardware and optimizing the result is to find equivalence relations that map a gate to a different basis set. Qiskit stores this information in a database class called [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"). -| | | -| ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")(\*\[, base]) | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | +| | | +| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | Qiskit ships with a large set of predefined equivalence relationships for all of its standard gates. This base library is called [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"), and should be treated as immutable. diff --git a/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx index 307facf977b..f94b143e2e6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp.mdx @@ -70,6 +70,10 @@ python_api_name: qiskit.circuit.BreakLoopOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -114,6 +118,10 @@ python_api_name: qiskit.circuit.BreakLoopOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -126,7 +134,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### assemble - + Assemble a QasmQobjInstruction @@ -136,7 +144,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -155,7 +163,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -165,7 +173,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### copy - + Copy of the instruction. **Parameters** @@ -183,7 +191,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -213,7 +221,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -237,7 +245,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx index 52a94687ef8..292c9e506d0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp.mdx @@ -70,6 +70,10 @@ python_api_name: qiskit.circuit.ContinueLoopOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -114,6 +118,10 @@ python_api_name: qiskit.circuit.ContinueLoopOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -126,7 +134,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### assemble - + Assemble a QasmQobjInstruction @@ -136,7 +144,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -155,7 +163,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -165,7 +173,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### copy - + Copy of the instruction. **Parameters** @@ -183,7 +191,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -213,7 +221,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -237,7 +245,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx index e8cf90d66c8..473b2c0a67c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx @@ -89,6 +89,10 @@ python_api_name: qiskit.circuit.ControlFlowOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -133,6 +137,10 @@ python_api_name: qiskit.circuit.ControlFlowOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -145,7 +153,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### assemble - + Assemble a QasmQobjInstruction @@ -155,7 +163,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -174,7 +182,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -184,7 +192,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### copy - + Copy of the instruction. **Parameters** @@ -202,7 +210,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -242,7 +250,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -301,7 +309,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx index d1d6811c848..9e5b04d2481 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx @@ -123,6 +123,10 @@ python_api_name: qiskit.circuit.ControlledGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -197,6 +201,10 @@ python_api_name: qiskit.circuit.ControlledGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -209,7 +217,7 @@ python_api_name: qiskit.circuit.ControlledGate ### assemble - + Assemble a QasmQobjInstruction @@ -272,7 +280,7 @@ python_api_name: qiskit.circuit.ControlledGate ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -305,7 +313,7 @@ python_api_name: qiskit.circuit.ControlledGate ### copy - + Copy of the instruction. **Parameters** @@ -360,7 +368,7 @@ python_api_name: qiskit.circuit.ControlledGate ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -384,7 +392,7 @@ python_api_name: qiskit.circuit.ControlledGate ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx index 9d46ec616e3..8cbc564e196 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.EquivalenceLibrary.mdx @@ -8,40 +8,22 @@ python_api_name: qiskit.circuit.EquivalenceLibrary # EquivalenceLibrary - - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") + + Bases: `BaseEquivalenceLibrary` A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. - Create a new equivalence library. - - **Parameters** - - **base** (*Optional\[*[*EquivalenceLibrary*](#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")*]*) – Base equivalence library to be referenced if an entry is not found in this library. - ## Attributes ### graph - - Return graph representing the equivalence library data. - - This property should be treated as read-only as it provides a reference to the internal state of the [`EquivalenceLibrary`](#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") object. If the graph returned by this property is mutated it could corrupt the the contents of the object. If you need to modify the output `PyDiGraph` be sure to make a copy prior to any modification. - - **Returns** - - A graph object with equivalence data in each node. - - **Return type** - - PyDiGraph - + ## Methods ### add\_equivalence - + Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.params) can be marked equivalent to parameterized circuits, provided the parameters match. @@ -54,7 +36,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary ### draw - + Draws the equivalence relations available in the library. **Parameters** @@ -78,7 +60,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary ### get\_entry - + Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. Parameterized circuits will have their parameters replaced with the corresponding entries from Gate.params. @@ -102,7 +84,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary ### has\_entry - + Check if a library contains any decompositions for gate. **Parameters** @@ -122,39 +104,15 @@ python_api_name: qiskit.circuit.EquivalenceLibrary ### keys - - Return list of keys to key to node index map. - - **Returns** - - Keys to the key to node index map. - - **Return type** - - List - + ### node\_index - - Return node index for a given key. - - **Parameters** - - **key** (*Key*) – Key to an equivalence. - - **Returns** - - Index to the node in the graph for the given key. - - **Return type** - - Int - + ### set\_entry - + Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.params) can be marked equivalent to parameterized circuits, provided the parameters match. diff --git a/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx index 4dae041ee17..5e709748bbc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp.mdx @@ -75,6 +75,10 @@ python_api_name: qiskit.circuit.ForLoopOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -117,6 +121,10 @@ python_api_name: qiskit.circuit.ForLoopOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -129,7 +137,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### assemble - + Assemble a QasmQobjInstruction @@ -139,7 +147,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -158,7 +166,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -168,7 +176,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### copy - + Copy of the instruction. **Parameters** @@ -186,7 +194,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -226,7 +234,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -281,7 +289,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx index 18b417b1be1..2a8226d43e3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Gate.mdx @@ -73,6 +73,10 @@ python_api_name: qiskit.circuit.Gate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -117,6 +121,10 @@ python_api_name: qiskit.circuit.Gate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -129,7 +137,7 @@ python_api_name: qiskit.circuit.Gate ### assemble - + Assemble a QasmQobjInstruction @@ -192,7 +200,7 @@ python_api_name: qiskit.circuit.Gate ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -225,7 +233,7 @@ python_api_name: qiskit.circuit.Gate ### copy - + Copy of the instruction. **Parameters** @@ -243,7 +251,7 @@ python_api_name: qiskit.circuit.Gate ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -294,7 +302,7 @@ python_api_name: qiskit.circuit.Gate ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -318,7 +326,7 @@ python_api_name: qiskit.circuit.Gate ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx index ef32db37965..7fdb02a1fd8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.IfElseOp.mdx @@ -79,6 +79,10 @@ python_api_name: qiskit.circuit.IfElseOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -121,6 +125,10 @@ python_api_name: qiskit.circuit.IfElseOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -133,7 +141,7 @@ python_api_name: qiskit.circuit.IfElseOp ### assemble - + Assemble a QasmQobjInstruction @@ -143,7 +151,7 @@ python_api_name: qiskit.circuit.IfElseOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -172,7 +180,7 @@ python_api_name: qiskit.circuit.IfElseOp ### copy - + Copy of the instruction. **Parameters** @@ -190,7 +198,7 @@ python_api_name: qiskit.circuit.IfElseOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -230,7 +238,7 @@ python_api_name: qiskit.circuit.IfElseOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -272,7 +280,7 @@ python_api_name: qiskit.circuit.IfElseOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx index 2f5896e3f5c..365560476e8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Instruction.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction # Instruction - + Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") Generic quantum instruction. @@ -81,6 +81,10 @@ python_api_name: qiskit.circuit.Instruction Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -125,6 +129,10 @@ python_api_name: qiskit.circuit.Instruction Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -137,7 +145,7 @@ python_api_name: qiskit.circuit.Instruction ### assemble - + Assemble a QasmQobjInstruction @@ -147,7 +155,7 @@ python_api_name: qiskit.circuit.Instruction ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -166,7 +174,7 @@ python_api_name: qiskit.circuit.Instruction ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -176,7 +184,7 @@ python_api_name: qiskit.circuit.Instruction ### copy - + Copy of the instruction. **Parameters** @@ -194,7 +202,7 @@ python_api_name: qiskit.circuit.Instruction ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -224,7 +232,7 @@ python_api_name: qiskit.circuit.Instruction ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -248,7 +256,7 @@ python_api_name: qiskit.circuit.Instruction ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx index 2835f8c9490..9f0dfb57045 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class - + Core Qiskit representation of a quantum circuit. @@ -100,13 +100,13 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qregs - + A list of the [`QuantumRegister`](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")s in this circuit. You should not mutate this. ### cregs - + A list of the [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")s in this circuit. You should not mutate this. @@ -214,14 +214,22 @@ python_api_name: qiskit.circuit.QuantumCircuit ### duration - + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.QuantumCircuit.unit "qiskit.circuit.QuantumCircuit.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### unit The unit that [`duration`](#qiskit.circuit.QuantumCircuit.duration "qiskit.circuit.QuantumCircuit.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### op\_start\_times @@ -313,7 +321,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### \_\_init\_\_ - + Default constructor of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -365,7 +373,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### copy - + Copy the circuit. **Parameters** @@ -385,7 +393,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### copy\_empty\_like - + Return a copy of self with the same structure but empty. That structure includes: @@ -432,7 +440,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_instructions - + Construct a circuit from an iterable of [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s. **Parameters** @@ -457,7 +465,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -479,7 +487,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -520,7 +528,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_bits - + Add Bits to the circuit. @@ -528,7 +536,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_register - + Add registers. @@ -536,7 +544,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_var - + Add a classical variable with automatic storage and scope to this circuit. The variable is considered to have been “declared” at the beginning of the circuit, but it only becomes initialized at the point of the circuit that you call this method, so it can depend on variables defined before it. @@ -606,7 +614,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_input - + Register a variable as an input to the circuit. **Parameters** @@ -627,7 +635,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_uninitialized\_var - + Add a variable with no initializer. In most cases, you should use [`add_var()`](#qiskit.circuit.QuantumCircuit.add_var "qiskit.circuit.QuantumCircuit.add_var") to initialize the variable. To use this function, you must already hold a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") instance, as the use of the function typically only makes sense in copying contexts. @@ -645,7 +653,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_capture - + Add a variable to the circuit that it should capture from a scope it will be contained within. This method requires a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node to enforce that you’ve got a handle to one, because you will need to declare the same variable using the same object into the outer circuit. @@ -667,7 +675,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### find\_bit - + Find locations in the circuit which can be used to reference a given [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit"). In particular, this function can find the integer index of a qubit, which corresponds to its hardware index for a transpiled circuit. @@ -726,7 +734,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### has\_register - + Test if this circuit has the register r. **Parameters** @@ -756,7 +764,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### assign\_parameters - + Assign parameters to new parameters or values. If `parameters` is passed as a dictionary, the keys should be [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects. @@ -832,7 +840,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### has\_parameter - + Check whether a parameter object exists in this circuit. **Parameters** @@ -860,7 +868,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### get\_parameter - + Retrieve a compile-time parameter that is accessible in this circuit scope by name. **Parameters** @@ -932,7 +940,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### get\_var - + Retrieve a variable that is accessible in this circuit scope by name. **Parameters** @@ -982,7 +990,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### has\_var - + Check whether a variable is accessible in this scope. **Parameters** @@ -1012,7 +1020,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iter\_vars - + Get an iterable over all real-time classical variables in scope within this circuit. This method will iterate over all variables in scope. For more fine-grained iterators, see [`iter_declared_vars()`](#qiskit.circuit.QuantumCircuit.iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars"), [`iter_input_vars()`](#qiskit.circuit.QuantumCircuit.iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars") and [`iter_captured_vars()`](#qiskit.circuit.QuantumCircuit.iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars"). @@ -1024,7 +1032,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iter\_input\_vars - + Get an iterable over all real-time classical variables that are declared as inputs to this circuit scope. This excludes locally declared variables (see [`iter_declared_vars()`](#qiskit.circuit.QuantumCircuit.iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars")) and captured variables (see [`iter_captured_vars()`](#qiskit.circuit.QuantumCircuit.iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars")). **Return type** @@ -1034,7 +1042,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iter\_captured\_vars - + Get an iterable over all real-time classical variables that are captured by this circuit scope from a containing scope. This excludes input variables (see [`iter_input_vars()`](#qiskit.circuit.QuantumCircuit.iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars")) and locally declared variables (see [`iter_declared_vars()`](#qiskit.circuit.QuantumCircuit.iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars")). **Return type** @@ -1044,7 +1052,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iter\_declared\_vars - + Get an iterable over all real-time classical variables that are declared with automatic storage duration in this scope. This excludes input variables (see [`iter_input_vars()`](#qiskit.circuit.QuantumCircuit.iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars")) and captured variables (see [`iter_captured_vars()`](#qiskit.circuit.QuantumCircuit.iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars")). **Return type** @@ -1087,7 +1095,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### append - + Append one or more instructions to the end of the circuit, modifying the circuit in place. The `qargs` and `cargs` will be expanded and broadcast according to the rules of the given [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), and any non-[`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") specifiers (such as integer indices) will be resolved into the relevant instances. @@ -1118,7 +1126,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### \_append - + Append an instruction to the end of the circuit, modifying the circuit in place. @@ -1160,7 +1168,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### compose - + Apply the instructions from one circuit onto specified qubits and/or clbits on another. @@ -1242,7 +1250,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### tensor - + Tensor `self` with `other`. Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](/guides/construct-circuits) for more information. @@ -1386,7 +1394,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### barrier - + Apply `Barrier`. If `qargs` is empty, applies to all qubits in the circuit. **Parameters** @@ -1405,7 +1413,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccx - + Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1428,7 +1436,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccz - + Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1452,7 +1460,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ch - + Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1475,7 +1483,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cp - + Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1499,7 +1507,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crx - + Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1523,7 +1531,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cry - + Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1547,7 +1555,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crz - + Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1571,7 +1579,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cs - + Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1594,7 +1602,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csdg - + Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1617,7 +1625,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cswap - + Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1641,7 +1649,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csx - + Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1664,7 +1672,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cu - + Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1691,7 +1699,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cx - + Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1714,7 +1722,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cy - + Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1737,7 +1745,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cz - + Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1760,7 +1768,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### dcx - + Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1781,7 +1789,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### delay - + Apply [`Delay`](circuit#qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is `None`, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. **Parameters** @@ -1805,7 +1813,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ecr - + Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1826,7 +1834,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### h - + Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1846,7 +1854,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### id - + Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1866,7 +1874,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### initialize - + Initialize qubits in a specific state. Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by calling [`StatePreparation`](qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") class to prepare the qubits in a specified state. Both these steps are included in the [`Initialize`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") instruction. @@ -1955,7 +1963,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iswap - + Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1976,7 +1984,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcp - + Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2055,7 +2063,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcx - + Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are: @@ -2091,7 +2099,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure - + Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`). When a quantum state is measured, a qubit is projected in the computational (Pauli Z) basis to either $\lvert 0 \rangle$ or $\lvert 1 \rangle$. The classical bit `cbit` indicates the result of that projection as a `0` or a `1` respectively. This operation is non-reversible. @@ -2167,7 +2175,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ms - + Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2188,7 +2196,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### p - + Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2209,7 +2217,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### pauli - + Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). **Parameters** @@ -2228,7 +2236,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### prepare\_state - + Prepare qubits in a specific state. This class implements a state preparing unitary. Unlike [`initialize()`](#qiskit.circuit.QuantumCircuit.initialize "qiskit.circuit.QuantumCircuit.initialize") it does not reset the qubits first. @@ -2323,7 +2331,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### r - + Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2345,7 +2353,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rcccx - + Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2368,7 +2376,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rccx - + Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2390,7 +2398,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### reset - + Reset the quantum bit(s) to their default state. **Parameters** @@ -2408,7 +2416,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rv - + Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2433,7 +2441,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rx - + Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2455,7 +2463,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rxx - + Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2477,7 +2485,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ry - + Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2499,7 +2507,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ryy - + Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2521,7 +2529,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rz - + Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2542,7 +2550,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzx - + Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2564,7 +2572,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzz - + Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2586,7 +2594,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### s - + Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2606,7 +2614,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sdg - + Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2626,7 +2634,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### store - + Store the result of the given real-time classical expression `rvalue` in the memory location defined by `lvalue`. Typically `lvalue` will be a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node and `rvalue` will be some [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") to write into it, but anything that [`expr.lift()`](circuit_classical#qiskit.circuit.classical.expr.lift "qiskit.circuit.classical.expr.lift") can raise to an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is permissible in both places, and it will be called on them. @@ -2653,7 +2661,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### swap - + Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2674,7 +2682,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sx - + Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2694,7 +2702,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sxdg - + Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2714,7 +2722,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### t - + Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2734,7 +2742,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### tdg - + Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2754,7 +2762,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### u - + Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2777,7 +2785,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### unitary - + Apply unitary gate specified by `obj` to `qubits`. **Parameters** @@ -2811,7 +2819,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### x - + Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2832,7 +2840,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### y - + Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2852,7 +2860,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### z - + Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2896,7 +2904,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### break\_loop - + Apply [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp"). @@ -2918,7 +2926,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### continue\_loop - + Apply [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp"). @@ -2940,7 +2948,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### for\_loop - + Create a `for` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which, when entered, provides a loop variable (unless one is given, in which case it will be reused) and will automatically build a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -2991,7 +2999,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_else - + Apply [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp"). @@ -3035,7 +3043,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_test - + Create an `if` statement on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") with the given `true_body`, and there will be no branch for the `false` condition (see also the [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else") method). However, if `true_body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which can be used to build `if` statements. The return value of the `with` statement is a chainable context manager, which can be used to create subsequent `else` blocks. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3089,7 +3097,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### switch - + Create a `switch`/`case` structure on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") with the given case structure. If `cases` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3136,7 +3144,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### while\_loop - + Create a `while` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a `WhileLoopOp` with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a `WhileLoopOp` when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3181,7 +3189,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### to\_instruction - + Create an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") out of this circuit. @@ -3208,7 +3216,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### to\_gate - + Create a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") out of this circuit. The circuit must act only qubits and contain only unitary operations. @@ -3237,7 +3245,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure\_active - + Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. Returns a new circuit with measurements if inplace=False. @@ -3257,7 +3265,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure\_all - + Adds measurement to all qubits. By default, adds new classical bits in a [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") to store these measurements. If `add_bits=False`, the results of the measurements will instead be stored in the already existing classical bits, with qubit `n` being measured into classical bit `n`. @@ -3286,7 +3294,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### clear - + Clear all instructions in self. Clearing the circuits will keep the metadata and calibrations. @@ -3300,7 +3308,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### remove\_final\_measurements - + Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -3350,7 +3358,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_calibration - + Register a low-level, custom pulse definition for the given gate. **Parameters** @@ -3367,7 +3375,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### has\_calibration\_for - + Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -3446,7 +3454,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### count\_ops - + Count each operation kind in the circuit. **Returns** @@ -3460,7 +3468,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### depth - + Return circuit depth (i.e., length of critical path). @@ -3502,7 +3510,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### get\_instructions - + Get instructions matching name. **Parameters** @@ -3520,7 +3528,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_connected\_components - + How many non-entangled subcircuits can the circuit be factored to. **Parameters** @@ -3538,7 +3546,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_nonlocal\_gates - + Return number of non-local gates (i.e. involving 2+ qubits). Conditional nonlocal gates are also included. @@ -3550,7 +3558,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_tensor\_factors - + Computes the number of tensor factors in the unitary (quantum) part of the circuit only. **Notes** @@ -3564,7 +3572,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_unitary\_factors - + Computes the number of tensor factors in the unitary (quantum) part of the circuit only. **Return type** @@ -3574,7 +3582,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### size - + Returns total number of instructions in circuit. **Parameters** @@ -3592,7 +3600,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### width - + Return number of qubits plus clbits in circuit. **Returns** @@ -3610,7 +3618,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_duration - + Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. **Parameters** @@ -3628,7 +3636,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_start\_time - + Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. Return 0 if there are no instructions over qubits @@ -3653,7 +3661,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_stop\_time - + Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. Return 0 if there are no instructions over qubits @@ -3682,7 +3690,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### control - + Control this circuit on `num_ctrl_qubits` qubits. **Parameters** @@ -3707,7 +3715,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### inverse - + Invert (take adjoint of) this circuit. This is done by recursively inverting all gates. @@ -3753,7 +3761,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### power - + Raise this circuit to the power of `power`. If `power` is a positive integer and both `matrix_power` and `annotated` are `False`, this implementation defaults to calling `repeat`. Otherwise, the circuit is converted into a gate, and a new circuit, containing this gate raised to the given power, is returned. The gate raised to the given power is implemented either as a unitary gate if `annotated` is `False` or as an annotated operation if `annotated` is `True`. @@ -3779,7 +3787,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### repeat - + Repeat this circuit `reps` times. **Parameters** @@ -3798,7 +3806,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### reverse\_ops - + Reverse the circuit by reversing the order of instructions. This is done by recursively reversing all instructions. It does not invert (adjoint) any gate. @@ -3846,7 +3854,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### draw - + Draw the quantum circuit. Use the output parameter to choose the drawing format: **text**: ASCII art TextDrawing that can be printed in the console. @@ -3946,7 +3954,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### decompose - + Call a decomposition pass on this circuit, to decompose one level (shallow decompose). **Parameters** @@ -3965,7 +3973,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### reverse\_bits - + Return a circuit with the opposite order of wires. The circuit is “vertically” flipped. If a circuit is defined over multiple registers, the resulting circuit will have the same registers but with their order flipped. @@ -4021,7 +4029,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cast - + Best effort to cast value to type. Otherwise, returns the value. @@ -4035,7 +4043,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cbit\_argument\_conversion - + Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -4057,7 +4065,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_instances - + Return the current number of instances of this class, useful for auto naming. @@ -4071,7 +4079,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### cls\_prefix - + Return the prefix to use for auto naming. @@ -4085,7 +4093,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### qbit\_argument\_conversion - + Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. diff --git a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx index fc05809442e..5c3ac3002d8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx @@ -73,6 +73,10 @@ python_api_name: qiskit.circuit.SwitchCaseOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -117,6 +121,10 @@ python_api_name: qiskit.circuit.SwitchCaseOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -129,7 +137,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### assemble - + Assemble a QasmQobjInstruction @@ -139,7 +147,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -198,7 +206,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### copy - + Copy of the instruction. **Parameters** @@ -216,7 +224,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -256,7 +264,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -315,7 +323,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx index f236bfd075a..95155f41e9f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.WhileLoopOp.mdx @@ -76,6 +76,10 @@ python_api_name: qiskit.circuit.WhileLoopOp Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -118,6 +122,10 @@ python_api_name: qiskit.circuit.WhileLoopOp Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -130,7 +138,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### assemble - + Assemble a QasmQobjInstruction @@ -140,7 +148,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### broadcast\_arguments - + Validation of the arguments. **Parameters** @@ -169,7 +177,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### copy - + Copy of the instruction. **Parameters** @@ -187,7 +195,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -227,7 +235,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -282,7 +290,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 024650d3b1b..c6732e4e2cd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -70,6 +70,10 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -114,6 +118,10 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -126,7 +134,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### assemble - + Assemble a QasmQobjInstruction @@ -189,7 +197,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -222,7 +230,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### copy - + Copy of the instruction. **Parameters** @@ -258,7 +266,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -309,7 +317,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -333,7 +341,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx index 8bd1f2d0886..9c055816968 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.mdx @@ -83,6 +83,10 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -165,6 +169,10 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods @@ -177,7 +185,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### assemble - + Assemble a QasmQobjInstruction @@ -240,7 +248,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### c\_if - + Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -279,7 +287,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### copy - + Copy of the instruction. **Parameters** @@ -297,7 +305,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### inverse - + Invert this instruction. If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition. @@ -348,7 +356,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### repeat - + Creates an instruction with `self` repeated :math\`n\` times. If this operation has a conditional, the output instruction will have the same conditional and the inner repeated operations will be unconditional; instructions within a compound definition cannot be conditioned on registers within Qiskit’s data model. This means that it is not valid to apply a repeated instruction to a clbit that it both writes to and reads from in its condition. @@ -372,7 +380,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction ### reverse\_ops - + For a composite instruction, reverse the order of sub-instructions. This is done by recursively reversing all sub-instructions. It does not invert any gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx index 3ac8ff99729..765755f8aed 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx @@ -67,6 +67,16 @@ python_api_name: qiskit.circuit.library.AND QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.AND.unit "qiskit.circuit.library.AND.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -75,7 +85,7 @@ python_api_name: qiskit.circuit.library.AND ### instances - + ### layout @@ -235,6 +245,16 @@ python_api_name: qiskit.circuit.library.AND A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.AND.duration "qiskit.circuit.library.AND.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -252,17 +272,5 @@ python_api_name: qiskit.circuit.library.AND A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.AND.unit "qiskit.circuit.library.AND.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.AND.duration "qiskit.circuit.library.AND.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx index 90bb316cc79..b2051a632e0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx @@ -83,6 +83,10 @@ python_api_name: qiskit.circuit.library.C3SXGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -157,6 +161,10 @@ python_api_name: qiskit.circuit.library.C3SXGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx index 94a5ad57c72..3e9563fc1fd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx @@ -74,6 +74,10 @@ python_api_name: qiskit.circuit.library.C3XGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -148,6 +152,10 @@ python_api_name: qiskit.circuit.library.C3XGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx index 9e36fecbebd..6dbb485f687 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx @@ -79,6 +79,10 @@ python_api_name: qiskit.circuit.library.C4XGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -153,6 +157,10 @@ python_api_name: qiskit.circuit.library.C4XGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx index ac2c5993673..8b1dc89e1c5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx @@ -130,6 +130,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -204,6 +208,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx index fb8b614ffe3..0a068b36cde 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.mdx @@ -105,6 +105,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -179,6 +183,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 5bfbf2b6c22..5934d41c559 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -113,6 +113,16 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.CDKMRippleCarryAdder.unit "qiskit.circuit.library.CDKMRippleCarryAdder.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -121,7 +131,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### instances - + ### layout @@ -291,6 +301,16 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.CDKMRippleCarryAdder.duration "qiskit.circuit.library.CDKMRippleCarryAdder.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -308,17 +328,5 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.CDKMRippleCarryAdder.unit "qiskit.circuit.library.CDKMRippleCarryAdder.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.CDKMRippleCarryAdder.duration "qiskit.circuit.library.CDKMRippleCarryAdder.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx index 4b43571e294..3696c81a38a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx @@ -120,6 +120,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -194,6 +198,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx index 9317be40829..899795fc5b3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx @@ -101,6 +101,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -175,6 +179,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx index f38c26fa152..9db053dde61 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx @@ -122,6 +122,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -196,6 +200,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx index 7b74d2340b8..e5758ccbdf2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx @@ -122,6 +122,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -196,6 +200,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx index e1d72521b24..932618d0df4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx @@ -124,6 +124,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -198,6 +202,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx index d01aafa5227..03668a2e87e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.mdx @@ -96,6 +96,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -170,6 +174,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx index ae396e5209e..23f9dad295d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx @@ -118,6 +118,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -192,6 +196,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx index 4fb3174a2ee..c3c0cf31057 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.mdx @@ -96,6 +96,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -170,6 +174,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx index fff0552cf16..203b69b7179 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.mdx @@ -139,6 +139,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -213,6 +217,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx index 5afb3915991..baf5be6aafe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx @@ -8,13 +8,26 @@ python_api_name: qiskit.circuit.library.CU1Gate # CU1Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U1 gate. This is a diagonal and symmetric gate that induces a phase on the state of the target qubit, depending on the control state. + + This gate is deprecated. Instead, the [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate") should be used + +$$ +CU1(\lambda) = CP(\lambda) +$$ + + ```python + circuit = QuantumCircuit(2) + circuit.cp(lambda, 0, 1) + ``` + + **Circuit symbol:** ```python @@ -99,6 +112,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -173,13 +190,17 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods ### control - + Controlled version of this gate. **Parameters** @@ -200,7 +221,7 @@ $$ ### inverse - + Return inverted CU1 gate ($CU1(\lambda)^{\dagger} = CU1(-\lambda))$ **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx index 86e4546bb90..f2df6ad91fe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx @@ -8,13 +8,27 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). This is a controlled version of the U3 gate (generic single qubit rotation). It is restricted to 3 parameters, and so cannot cover generic two-qubit controlled gates). + + This gate is deprecated. Instead, the [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate") should be used + +$$ +CU3(\theta, \phi, \lambda) = CU(\theta, \phi, \lambda, 0) +$$ + + ```python + circuit = QuantumCircuit(2) + gamma = 0 + circuit.cu(theta, phi, lambda, gamma, 0, 1) + ``` + + **Circuit symbol:** ```python @@ -124,6 +138,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -198,13 +216,17 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods ### inverse - + Return inverted CU3 gate. $CU3(\theta,\phi,\lambda)^{\dagger} =CU3(-\theta,-\phi,-\lambda))$ diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx index 38ac88fd905..8e820237960 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx @@ -128,6 +128,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -188,6 +192,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx index 087bbbd45a3..feebd3a7669 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx @@ -126,6 +126,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -200,6 +204,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx index ea64c53ebf5..31d6666a8eb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx @@ -118,6 +118,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -192,6 +196,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx index 4fe61194b8d..0300e70b21a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.mdx @@ -99,6 +99,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -173,6 +177,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx index aa789cdfa80..63f41dd8076 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx @@ -90,6 +90,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -134,6 +138,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx index 66340f285ad..f8d47fe2d16 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx @@ -95,6 +95,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.Diagonal.unit "qiskit.circuit.library.Diagonal.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -263,6 +273,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.Diagonal.duration "qiskit.circuit.library.Diagonal.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -280,17 +300,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.Diagonal.unit "qiskit.circuit.library.Diagonal.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.Diagonal.duration "qiskit.circuit.library.Diagonal.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx index 8b5f6208f09..1ab65a61b33 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx @@ -68,6 +68,10 @@ python_api_name: qiskit.circuit.library.DiagonalGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -112,6 +116,10 @@ python_api_name: qiskit.circuit.library.DiagonalGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx index 52337a5dcba..b324140b8a5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx @@ -84,6 +84,16 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.DraperQFTAdder.unit "qiskit.circuit.library.DraperQFTAdder.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -262,6 +272,16 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.DraperQFTAdder.duration "qiskit.circuit.library.DraperQFTAdder.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -279,17 +299,5 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.DraperQFTAdder.unit "qiskit.circuit.library.DraperQFTAdder.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.DraperQFTAdder.duration "qiskit.circuit.library.DraperQFTAdder.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx index 78a81d490a9..c9857ba6594 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.mdx @@ -114,6 +114,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -158,6 +162,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx index e71c1c535cf..41482705864 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx @@ -98,7 +98,27 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.EfficientSU2.unit "qiskit.circuit.library.EfficientSU2.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -222,7 +242,9 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -312,7 +334,61 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -360,6 +436,16 @@ python_api_name: qiskit.circuit.library.EfficientSU2 The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.EfficientSU2.duration "qiskit.circuit.library.EfficientSU2.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -371,17 +457,5 @@ python_api_name: qiskit.circuit.library.EfficientSU2 A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.EfficientSU2.unit "qiskit.circuit.library.EfficientSU2.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.EfficientSU2.duration "qiskit.circuit.library.EfficientSU2.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 61ac88d8be3..710ae0b07b5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -48,7 +48,27 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.EvolvedOperatorAnsatz.unit "qiskit.circuit.library.EvolvedOperatorAnsatz.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -186,7 +206,9 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -290,7 +312,61 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -334,6 +410,16 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.EvolvedOperatorAnsatz.duration "qiskit.circuit.library.EvolvedOperatorAnsatz.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -345,17 +431,5 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.EvolvedOperatorAnsatz.unit "qiskit.circuit.library.EvolvedOperatorAnsatz.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.EvolvedOperatorAnsatz.duration "qiskit.circuit.library.EvolvedOperatorAnsatz.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx index f6fe9bc01da..1940dfba248 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx @@ -64,6 +64,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ExactReciprocal.unit "qiskit.circuit.library.ExactReciprocal.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -232,6 +242,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.ExactReciprocal.duration "qiskit.circuit.library.ExactReciprocal.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -249,17 +269,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ExactReciprocal.unit "qiskit.circuit.library.ExactReciprocal.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.ExactReciprocal.duration "qiskit.circuit.library.ExactReciprocal.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx index 725a9d5f94d..f63be5cd007 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx @@ -117,7 +117,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ExcitationPreserving.unit "qiskit.circuit.library.ExcitationPreserving.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -241,7 +261,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -331,7 +353,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -379,6 +455,16 @@ $$ The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.ExcitationPreserving.duration "qiskit.circuit.library.ExcitationPreserving.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -390,17 +476,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ExcitationPreserving.unit "qiskit.circuit.library.ExcitationPreserving.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.ExcitationPreserving.duration "qiskit.circuit.library.ExcitationPreserving.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx index 5d23a7645f3..6e637bc014d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx @@ -78,6 +78,16 @@ python_api_name: qiskit.circuit.library.FourierChecking QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.FourierChecking.unit "qiskit.circuit.library.FourierChecking.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -246,6 +256,16 @@ python_api_name: qiskit.circuit.library.FourierChecking A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.FourierChecking.duration "qiskit.circuit.library.FourierChecking.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -263,17 +283,5 @@ python_api_name: qiskit.circuit.library.FourierChecking A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.FourierChecking.unit "qiskit.circuit.library.FourierChecking.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.FourierChecking.duration "qiskit.circuit.library.FourierChecking.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx index aa1c54019b6..d02dd4a3aa1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -57,7 +57,27 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.FunctionalPauliRotations.unit "qiskit.circuit.library.FunctionalPauliRotations.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### global\_phase @@ -135,7 +155,9 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -179,7 +201,61 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -197,6 +273,16 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.FunctionalPauliRotations.duration "qiskit.circuit.library.FunctionalPauliRotations.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -208,17 +294,5 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.FunctionalPauliRotations.unit "qiskit.circuit.library.FunctionalPauliRotations.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.FunctionalPauliRotations.duration "qiskit.circuit.library.FunctionalPauliRotations.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx index 2005963ef7d..c1d563c9a7a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx @@ -87,6 +87,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GMS.unit "qiskit.circuit.library.GMS.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -255,6 +265,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GMS.duration "qiskit.circuit.library.GMS.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -272,17 +292,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GMS.unit "qiskit.circuit.library.GMS.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GMS.duration "qiskit.circuit.library.GMS.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx index 2251fc07651..0c73de74e65 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx @@ -81,6 +81,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GR.unit "qiskit.circuit.library.GR.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -249,6 +259,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GR.duration "qiskit.circuit.library.GR.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -266,17 +286,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GR.unit "qiskit.circuit.library.GR.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GR.duration "qiskit.circuit.library.GR.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx index fbe69951961..e152c199f7e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx @@ -80,6 +80,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GRX.unit "qiskit.circuit.library.GRX.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -248,6 +258,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GRX.duration "qiskit.circuit.library.GRX.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -265,17 +285,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GRX.unit "qiskit.circuit.library.GRX.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GRX.duration "qiskit.circuit.library.GRX.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx index 148da6bec96..6942cf91a2b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx @@ -80,6 +80,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GRY.unit "qiskit.circuit.library.GRY.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -248,6 +258,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GRY.duration "qiskit.circuit.library.GRY.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -265,17 +285,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GRY.unit "qiskit.circuit.library.GRY.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GRY.duration "qiskit.circuit.library.GRY.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx index a1a7dfa6a45..0f8cabf4b13 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx @@ -80,6 +80,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GRZ.unit "qiskit.circuit.library.GRZ.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -248,6 +258,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GRZ.duration "qiskit.circuit.library.GRZ.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -265,17 +285,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GRZ.unit "qiskit.circuit.library.GRZ.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GRZ.duration "qiskit.circuit.library.GRZ.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx index 8536ad2b3f3..82ee6fdddd9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -82,6 +82,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -126,6 +130,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx index 017f83cf60d..f82bcadea18 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx @@ -85,6 +85,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GraphState.unit "qiskit.circuit.library.GraphState.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -253,6 +263,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GraphState.duration "qiskit.circuit.library.GraphState.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -270,17 +290,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GraphState.unit "qiskit.circuit.library.GraphState.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GraphState.duration "qiskit.circuit.library.GraphState.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx index a056ff72bd9..9c25e6d83e7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx @@ -196,6 +196,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GroverOperator.unit "qiskit.circuit.library.GroverOperator.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -382,6 +392,16 @@ $$ The subcircuit implementing the A operator or Hadamards. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.GroverOperator.duration "qiskit.circuit.library.GroverOperator.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### zero\_reflection @@ -405,17 +425,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.GroverOperator.unit "qiskit.circuit.library.GroverOperator.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.GroverOperator.duration "qiskit.circuit.library.GroverOperator.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx index 66aecb33595..9036400a52d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.mdx @@ -88,6 +88,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -132,6 +136,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 58c818f630b..641a11340e4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -97,6 +97,16 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.HRSCumulativeMultiplier.unit "qiskit.circuit.library.HRSCumulativeMultiplier.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -285,6 +295,16 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.HRSCumulativeMultiplier.duration "qiskit.circuit.library.HRSCumulativeMultiplier.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -302,17 +322,5 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.HRSCumulativeMultiplier.unit "qiskit.circuit.library.HRSCumulativeMultiplier.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.HRSCumulativeMultiplier.duration "qiskit.circuit.library.HRSCumulativeMultiplier.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx index 3337e4129cf..fbc6cc03f9e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx @@ -76,6 +76,10 @@ python_api_name: qiskit.circuit.library.HamiltonianGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -120,6 +124,10 @@ python_api_name: qiskit.circuit.library.HamiltonianGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx index 3c42b602890..42f52ff9e3e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -87,6 +87,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.HiddenLinearFunction.unit "qiskit.circuit.library.HiddenLinearFunction.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -255,6 +265,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.HiddenLinearFunction.duration "qiskit.circuit.library.HiddenLinearFunction.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -272,17 +292,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.HiddenLinearFunction.unit "qiskit.circuit.library.HiddenLinearFunction.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.HiddenLinearFunction.duration "qiskit.circuit.library.HiddenLinearFunction.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx index bab896d86cc..ce8c7d035d8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx @@ -87,6 +87,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -131,6 +135,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx index 4d9f8cc9983..53a4b3da80f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx @@ -75,6 +75,16 @@ python_api_name: qiskit.circuit.library.IQP QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.IQP.unit "qiskit.circuit.library.IQP.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -243,6 +253,16 @@ python_api_name: qiskit.circuit.library.IQP A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.IQP.duration "qiskit.circuit.library.IQP.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -260,17 +280,5 @@ python_api_name: qiskit.circuit.library.IQP A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.IQP.unit "qiskit.circuit.library.IQP.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.IQP.duration "qiskit.circuit.library.IQP.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx index 9417c4a1401..071a376a0b8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Initialize.mdx @@ -86,6 +86,10 @@ python_api_name: qiskit.circuit.library.Initialize Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -130,6 +134,10 @@ python_api_name: qiskit.circuit.library.Initialize Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx index 7338c3e6ead..a9082410ae3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx @@ -86,6 +86,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.InnerProduct.unit "qiskit.circuit.library.InnerProduct.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -254,6 +264,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.InnerProduct.duration "qiskit.circuit.library.InnerProduct.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -271,17 +291,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.InnerProduct.unit "qiskit.circuit.library.InnerProduct.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.InnerProduct.duration "qiskit.circuit.library.InnerProduct.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx index ba0f299be71..0d1026d8f92 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx @@ -54,7 +54,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.IntegerComparator.unit "qiskit.circuit.library.IntegerComparator.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### geq @@ -132,7 +152,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -176,7 +198,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -194,6 +270,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.IntegerComparator.duration "qiskit.circuit.library.IntegerComparator.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### value @@ -215,17 +301,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.IntegerComparator.unit "qiskit.circuit.library.IntegerComparator.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.IntegerComparator.duration "qiskit.circuit.library.IntegerComparator.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx index 53752cd3212..560e274651f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Isometry.mdx @@ -79,6 +79,10 @@ python_api_name: qiskit.circuit.library.Isometry Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -123,6 +127,10 @@ python_api_name: qiskit.circuit.library.Isometry Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 31954927c3c..ed95c4a6a5b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -101,6 +101,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.LinearAmplitudeFunction.unit "qiskit.circuit.library.LinearAmplitudeFunction.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -269,6 +279,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.LinearAmplitudeFunction.duration "qiskit.circuit.library.LinearAmplitudeFunction.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -287,18 +307,6 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.LinearAmplitudeFunction.unit "qiskit.circuit.library.LinearAmplitudeFunction.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.LinearAmplitudeFunction.duration "qiskit.circuit.library.LinearAmplitudeFunction.duration") is specified in. - - ## Methods ### post\_processing diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx index 43a8ec7e958..fee338e2f0a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearFunction.mdx @@ -105,6 +105,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -161,6 +165,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx index ef406b78742..423ea8eca99 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx @@ -80,7 +80,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.LinearPauliRotations.unit "qiskit.circuit.library.LinearPauliRotations.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### global\_phase @@ -158,7 +178,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -214,7 +236,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -244,6 +320,16 @@ $$ The rotation angle common in all controlled rotations. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.LinearPauliRotations.duration "qiskit.circuit.library.LinearPauliRotations.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -255,17 +341,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.LinearPauliRotations.unit "qiskit.circuit.library.LinearPauliRotations.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.LinearPauliRotations.duration "qiskit.circuit.library.LinearPauliRotations.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx index cb179c28842..d17c7c323a6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx @@ -79,6 +79,16 @@ python_api_name: qiskit.circuit.library.MCMT QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.MCMT.unit "qiskit.circuit.library.MCMT.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -253,6 +263,16 @@ python_api_name: qiskit.circuit.library.MCMT A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.MCMT.duration "qiskit.circuit.library.MCMT.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -271,18 +291,6 @@ python_api_name: qiskit.circuit.library.MCMT A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.MCMT.unit "qiskit.circuit.library.MCMT.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.MCMT.duration "qiskit.circuit.library.MCMT.duration") is specified in. - - ## Methods ### control diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx index 72a3d9b775e..279766d027e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx @@ -103,6 +103,16 @@ python_api_name: qiskit.circuit.library.MCMTVChain QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.MCMTVChain.unit "qiskit.circuit.library.MCMTVChain.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -277,6 +287,16 @@ python_api_name: qiskit.circuit.library.MCMTVChain A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.MCMTVChain.duration "qiskit.circuit.library.MCMTVChain.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -295,18 +315,6 @@ python_api_name: qiskit.circuit.library.MCMTVChain A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.MCMTVChain.unit "qiskit.circuit.library.MCMTVChain.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.MCMTVChain.duration "qiskit.circuit.library.MCMTVChain.duration") is specified in. - - ## Methods ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx index 247689c50c4..ce39c788680 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx @@ -93,6 +93,10 @@ python_api_name: qiskit.circuit.library.MCPhaseGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -167,6 +171,10 @@ python_api_name: qiskit.circuit.library.MCPhaseGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx index 125e3f2349c..b70d0d95c78 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx @@ -74,6 +74,10 @@ python_api_name: qiskit.circuit.library.MCXGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -154,6 +158,10 @@ python_api_name: qiskit.circuit.library.MCXGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx index 5a6e998bc5f..f84dd3336fe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx @@ -76,6 +76,10 @@ python_api_name: qiskit.circuit.library.MCXGrayCode Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -156,6 +160,10 @@ python_api_name: qiskit.circuit.library.MCXGrayCode Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx index 393b2e07d02..4d2b07993ca 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx @@ -83,6 +83,10 @@ python_api_name: qiskit.circuit.library.MCXRecursive Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -163,6 +167,10 @@ python_api_name: qiskit.circuit.library.MCXRecursive Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx index 8d85ba212ef..f74eaa125bf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx @@ -80,6 +80,10 @@ python_api_name: qiskit.circuit.library.MCXVChain Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -160,6 +164,10 @@ python_api_name: qiskit.circuit.library.MCXVChain Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx index 40226fab056..b326ca82208 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MSGate.mdx @@ -72,6 +72,10 @@ python_api_name: qiskit.circuit.library.MSGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -116,6 +120,10 @@ python_api_name: qiskit.circuit.library.MSGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx index 311d1327e0e..be21978ab29 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx @@ -84,7 +84,27 @@ python_api_name: qiskit.circuit.library.NLocal ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.NLocal.unit "qiskit.circuit.library.NLocal.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -208,7 +228,9 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -298,7 +320,61 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -346,6 +422,16 @@ python_api_name: qiskit.circuit.library.NLocal The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.NLocal.duration "qiskit.circuit.library.NLocal.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -358,18 +444,6 @@ python_api_name: qiskit.circuit.library.NLocal A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.NLocal.unit "qiskit.circuit.library.NLocal.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.NLocal.duration "qiskit.circuit.library.NLocal.duration") is specified in. - - ## Methods ### add\_layer diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx index c38366acfca..d40cbbaf287 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx @@ -67,6 +67,16 @@ python_api_name: qiskit.circuit.library.OR QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.OR.unit "qiskit.circuit.library.OR.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -235,6 +245,16 @@ python_api_name: qiskit.circuit.library.OR A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.OR.duration "qiskit.circuit.library.OR.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -252,17 +272,5 @@ python_api_name: qiskit.circuit.library.OR A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.OR.unit "qiskit.circuit.library.OR.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.OR.duration "qiskit.circuit.library.OR.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx index 0283cd0fc8b..0de7328004d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -120,6 +120,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -174,6 +178,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx index 80050fef8b5..9764bb636a3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap # PauliFeatureMap - + Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") The Pauli Expansion circuit. @@ -147,7 +147,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PauliFeatureMap.unit "qiskit.circuit.library.PauliFeatureMap.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -161,7 +181,13 @@ $$ ### entanglement\_blocks - + + The blocks in the entanglement layers. + + **Returns** + + The blocks in the entanglement layers. + ### feature\_dimension @@ -275,7 +301,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -355,7 +383,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### paulis @@ -413,6 +495,16 @@ $$ The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PauliFeatureMap.duration "qiskit.circuit.library.PauliFeatureMap.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -425,23 +517,11 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PauliFeatureMap.unit "qiskit.circuit.library.PauliFeatureMap.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PauliFeatureMap.duration "qiskit.circuit.library.PauliFeatureMap.duration") is specified in. - - ## Methods ### get\_entangler\_map - + Get the entangler map for in the repetition `rep_num` and the block `block_num`. The entangler map for the current block is derived from the value of `self.entanglement`. Below the different cases are listed, where `i` and `j` denote the repetition number and the block number, respectively, and `n` the number of qubits in the block. @@ -482,13 +562,13 @@ $$ ### pauli\_block - + Get the Pauli block for the feature map circuit. ### pauli\_evolution - + Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx index 80de308b007..a3078f6712c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx @@ -79,6 +79,10 @@ python_api_name: qiskit.circuit.library.PauliGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -123,6 +127,10 @@ python_api_name: qiskit.circuit.library.PauliGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx index 0e25b751bd8..c908674b677 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx @@ -82,7 +82,27 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PauliTwoDesign.unit "qiskit.circuit.library.PauliTwoDesign.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -206,7 +226,9 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -290,7 +312,61 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -338,6 +414,16 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PauliTwoDesign.duration "qiskit.circuit.library.PauliTwoDesign.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -349,17 +435,5 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PauliTwoDesign.unit "qiskit.circuit.library.PauliTwoDesign.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PauliTwoDesign.duration "qiskit.circuit.library.PauliTwoDesign.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx index 7e89d74525d..975d9741c4d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx @@ -69,6 +69,16 @@ python_api_name: qiskit.circuit.library.Permutation QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.Permutation.unit "qiskit.circuit.library.Permutation.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -237,6 +247,16 @@ python_api_name: qiskit.circuit.library.Permutation A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.Permutation.duration "qiskit.circuit.library.Permutation.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -254,17 +274,5 @@ python_api_name: qiskit.circuit.library.Permutation A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.Permutation.unit "qiskit.circuit.library.Permutation.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.Permutation.duration "qiskit.circuit.library.Permutation.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx index 5c10104829f..22c456d1488 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx @@ -82,6 +82,10 @@ python_api_name: qiskit.circuit.library.PermutationGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -132,6 +136,10 @@ python_api_name: qiskit.circuit.library.PermutationGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx index 50bba47b4ea..e27216fa888 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx @@ -86,6 +86,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PhaseEstimation.unit "qiskit.circuit.library.PhaseEstimation.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -94,7 +104,7 @@ $$ ### instances - + ### layout @@ -254,6 +264,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PhaseEstimation.duration "qiskit.circuit.library.PhaseEstimation.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -271,17 +291,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PhaseEstimation.unit "qiskit.circuit.library.PhaseEstimation.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PhaseEstimation.duration "qiskit.circuit.library.PhaseEstimation.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx index 5417f9812e2..a7d97bf65a2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx @@ -112,6 +112,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -156,6 +160,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx index dae745d88d8..28fa000bfd1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx @@ -63,6 +63,16 @@ python_api_name: qiskit.circuit.library.PhaseOracle QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PhaseOracle.unit "qiskit.circuit.library.PhaseOracle.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -71,7 +81,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### instances - + ### layout @@ -231,6 +241,16 @@ python_api_name: qiskit.circuit.library.PhaseOracle A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PhaseOracle.duration "qiskit.circuit.library.PhaseOracle.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -249,18 +269,6 @@ python_api_name: qiskit.circuit.library.PhaseOracle A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PhaseOracle.unit "qiskit.circuit.library.PhaseOracle.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PhaseOracle.duration "qiskit.circuit.library.PhaseOracle.duration") is specified in. - - ## Methods ### evaluate\_bitstring diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx index 8e42a6ae33d..a5ab0c2d7b1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -86,7 +86,17 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + ### degree @@ -98,6 +108,16 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev The degree of the polynomials. + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewiseChebyshev.unit "qiskit.circuit.library.PiecewiseChebyshev.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### f\_x @@ -116,7 +136,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### instances - + ### layout @@ -174,7 +194,9 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -218,7 +240,61 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### polynomials @@ -250,6 +326,16 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PiecewiseChebyshev.duration "qiskit.circuit.library.PiecewiseChebyshev.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -261,17 +347,5 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewiseChebyshev.unit "qiskit.circuit.library.PiecewiseChebyshev.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PiecewiseChebyshev.duration "qiskit.circuit.library.PiecewiseChebyshev.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 7bfd819131b..a6a60784bc4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -89,7 +89,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewiseLinearPauliRotations.unit "qiskit.circuit.library.PiecewiseLinearPauliRotations.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### global\_phase @@ -99,7 +119,7 @@ $$ ### instances - + ### layout @@ -187,7 +207,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -239,7 +261,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -265,6 +341,16 @@ $$ The function is linear in the intervals `[point_i, point_{i+1}]` where the last point implicitly is `2**(num_state_qubits + 1)`. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PiecewiseLinearPauliRotations.duration "qiskit.circuit.library.PiecewiseLinearPauliRotations.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -277,18 +363,6 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewiseLinearPauliRotations.unit "qiskit.circuit.library.PiecewiseLinearPauliRotations.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PiecewiseLinearPauliRotations.duration "qiskit.circuit.library.PiecewiseLinearPauliRotations.duration") is specified in. - - ## Methods ### evaluate diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 56f7b77b8e7..06978189230 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -147,7 +147,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.unit "qiskit.circuit.library.PiecewisePolynomialPauliRotations.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### global\_phase @@ -157,7 +177,7 @@ $$ ### instances - + ### layout @@ -235,7 +255,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -279,7 +301,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -297,6 +373,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.duration "qiskit.circuit.library.PiecewisePolynomialPauliRotations.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -309,18 +395,6 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.unit "qiskit.circuit.library.PiecewisePolynomialPauliRotations.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PiecewisePolynomialPauliRotations.duration "qiskit.circuit.library.PiecewisePolynomialPauliRotations.duration") is specified in. - - ## Methods ### evaluate diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx index c503263f3ea..10346d3b823 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -97,7 +97,17 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + ### degree @@ -109,6 +119,16 @@ $$ The degree of the polynomial. If the coefficients have not been set, return 0. + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PolynomialPauliRotations.unit "qiskit.circuit.library.PolynomialPauliRotations.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -117,7 +137,7 @@ $$ ### instances - + ### layout @@ -185,7 +205,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -229,7 +251,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -247,6 +323,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.PolynomialPauliRotations.duration "qiskit.circuit.library.PolynomialPauliRotations.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -258,17 +344,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.PolynomialPauliRotations.unit "qiskit.circuit.library.PolynomialPauliRotations.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.PolynomialPauliRotations.duration "qiskit.circuit.library.PolynomialPauliRotations.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx index 07810aaad89..8b885733b9a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx @@ -66,7 +66,27 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QAOAAnsatz.unit "qiskit.circuit.library.QAOAAnsatz.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -132,7 +152,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### instances - + ### layout @@ -214,7 +234,9 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -314,7 +336,61 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -354,6 +430,16 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.QAOAAnsatz.duration "qiskit.circuit.library.QAOAAnsatz.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -365,17 +451,5 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QAOAAnsatz.unit "qiskit.circuit.library.QAOAAnsatz.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.QAOAAnsatz.duration "qiskit.circuit.library.QAOAAnsatz.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx index ef874d50666..f4cc2cb63c5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx @@ -80,7 +80,17 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + ### do\_swaps @@ -92,6 +102,16 @@ $$ True, if the final swaps are applied, False if not. + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QFT.unit "qiskit.circuit.library.QFT.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -168,7 +188,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -206,7 +228,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -224,6 +300,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.QFT.duration "qiskit.circuit.library.QFT.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -236,18 +322,6 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QFT.unit "qiskit.circuit.library.QFT.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.QFT.duration "qiskit.circuit.library.QFT.duration") is specified in. - - ## Methods ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QFTGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QFTGate.mdx index 3985d0ec1cb..5f41c868fdd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QFTGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QFTGate.mdx @@ -74,6 +74,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -118,6 +122,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx index 012e94b6ee0..6c47b8fb275 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx @@ -88,6 +88,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QuadraticForm.unit "qiskit.circuit.library.QuadraticForm.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -96,7 +106,7 @@ $$ ### instances - + ### layout @@ -256,6 +266,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.QuadraticForm.duration "qiskit.circuit.library.QuadraticForm.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -274,18 +294,6 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QuadraticForm.unit "qiskit.circuit.library.QuadraticForm.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.QuadraticForm.duration "qiskit.circuit.library.QuadraticForm.duration") is specified in. - - ## Methods ### required\_result\_qubits diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx index 52723cf7137..4d48f306cb5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx @@ -75,6 +75,16 @@ python_api_name: qiskit.circuit.library.QuantumVolume QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QuantumVolume.unit "qiskit.circuit.library.QuantumVolume.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -83,7 +93,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### instances - + ### layout @@ -243,6 +253,16 @@ python_api_name: qiskit.circuit.library.QuantumVolume A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.QuantumVolume.duration "qiskit.circuit.library.QuantumVolume.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -260,17 +280,5 @@ python_api_name: qiskit.circuit.library.QuantumVolume A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.QuantumVolume.unit "qiskit.circuit.library.QuantumVolume.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.QuantumVolume.duration "qiskit.circuit.library.QuantumVolume.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx index f8ee8d8cd50..8611a2bb4e6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx @@ -72,6 +72,10 @@ python_api_name: qiskit.circuit.library.RC3XGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -116,6 +120,10 @@ python_api_name: qiskit.circuit.library.RC3XGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx index eb61952152c..dfab3a96b88 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx @@ -72,6 +72,10 @@ python_api_name: qiskit.circuit.library.RCCXGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -116,6 +120,10 @@ python_api_name: qiskit.circuit.library.RCCXGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx index db2c0824701..6e199b9bfdd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -76,6 +76,16 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.RGQFTMultiplier.unit "qiskit.circuit.library.RGQFTMultiplier.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -264,6 +274,16 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.RGQFTMultiplier.duration "qiskit.circuit.library.RGQFTMultiplier.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -281,17 +301,5 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.RGQFTMultiplier.unit "qiskit.circuit.library.RGQFTMultiplier.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.RGQFTMultiplier.duration "qiskit.circuit.library.RGQFTMultiplier.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx index 594ea1d5015..c7c479498aa 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx @@ -88,6 +88,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -132,6 +136,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx index d0bb1d6a072..95e1136a5ad 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx @@ -100,6 +100,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -144,6 +148,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx index dfcdbab4182..9cd64d5bb5f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx @@ -88,6 +88,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -132,6 +136,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx index ea01ff16517..ee8330a5965 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx @@ -48,7 +48,7 @@ $$ > $$ > > $$ - > R_{XX}(\theta = \pi) = i X \otimes X + > R_{XX}(\theta = \pi) = -i X \otimes X > $$ > > $$ @@ -114,6 +114,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -158,6 +162,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx index 20ff28d5627..c327dfd5b5f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx @@ -88,6 +88,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -132,6 +136,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx index f2e59461e49..2d95bcd8e31 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx @@ -48,7 +48,7 @@ $$ > $$ > > $$ - > R_{YY}(\theta = \pi) = i Y \otimes Y + > R_{YY}(\theta = \pi) = -i Y \otimes Y > $$ > > $$ @@ -114,6 +114,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -158,6 +162,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx index 085a73f7f57..50e7f1629ae 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx @@ -98,6 +98,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -142,6 +146,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx index 6c27542ea59..28232987b53 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx @@ -80,19 +80,19 @@ $$ **Examples:** > $$ - > R_{ZX}(\theta = 0) = I + > R_{ZX}(\theta = 0)\ q_0, q_1 = I > $$ > > $$ - > R_{ZX}(\theta = 2\pi) = -I + > R_{ZX}(\theta = 2\pi)\ q_0, q_1 = -I > $$ > > $$ - > R_{ZX}(\theta = \pi) = -i Z \otimes X + > R_{ZX}(\theta = \pi)\ q_0, q_1 = -i X \otimes Z > $$ > > $$ - > RZX(\theta = \frac{\pi}{2}) = \frac{1}{\sqrt{2}} + > R_{ZX}(\theta = \frac{\pi}{2})\ q_0, q_1 = \frac{1}{\sqrt{2}} > \begin{pmatrix} > 1 & 0 & -i & 0 \\ > 0 & 1 & 0 & i \\ @@ -154,6 +154,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -198,6 +202,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx index 6de8330ec58..d53301d65a8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx @@ -126,6 +126,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -170,6 +174,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx index a72e7d83ac7..abe51eac9e1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx @@ -136,7 +136,27 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.RealAmplitudes.unit "qiskit.circuit.library.RealAmplitudes.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -260,7 +280,9 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -350,7 +372,61 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -398,6 +474,16 @@ python_api_name: qiskit.circuit.library.RealAmplitudes The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.RealAmplitudes.duration "qiskit.circuit.library.RealAmplitudes.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -409,17 +495,5 @@ python_api_name: qiskit.circuit.library.RealAmplitudes A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.RealAmplitudes.unit "qiskit.circuit.library.RealAmplitudes.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.RealAmplitudes.duration "qiskit.circuit.library.RealAmplitudes.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx index 6d7e29f776b..398a75e063d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx @@ -91,6 +91,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -135,6 +139,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx index 21fb0f1132d..8707555f3d5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.mdx @@ -97,6 +97,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -141,6 +145,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx index f2af99ef1fc..7111bad1a22 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.mdx @@ -87,6 +87,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -131,6 +135,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx index e30c3f958e7..fbd6466b1e1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx @@ -91,6 +91,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -135,6 +139,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx index 5368b4f801d..3b52c3bbccd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx @@ -93,6 +93,10 @@ python_api_name: qiskit.circuit.library.StatePreparation Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -137,6 +141,10 @@ python_api_name: qiskit.circuit.library.StatePreparation Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx index 3bc47083fb2..0951f4b95b8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.mdx @@ -96,6 +96,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -140,6 +144,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx index f7b23f4e637..24f2ea15085 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.mdx @@ -91,6 +91,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -135,6 +139,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx index 82c98e03216..9ca688e128c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.mdx @@ -91,6 +91,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -135,6 +139,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx index 4b87c1c49bc..9007f9c9b5c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx @@ -148,7 +148,27 @@ python_api_name: qiskit.circuit.library.TwoLocal ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.TwoLocal.unit "qiskit.circuit.library.TwoLocal.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -272,7 +292,9 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -362,7 +384,61 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### preferred\_init\_points @@ -410,6 +486,16 @@ python_api_name: qiskit.circuit.library.TwoLocal The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.TwoLocal.duration "qiskit.circuit.library.TwoLocal.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -422,18 +508,6 @@ python_api_name: qiskit.circuit.library.TwoLocal A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.TwoLocal.unit "qiskit.circuit.library.TwoLocal.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.TwoLocal.duration "qiskit.circuit.library.TwoLocal.duration") is specified in. - - ## Methods ### get\_entangler\_map diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx index b0291061e1f..bcf606d1ff0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx @@ -24,7 +24,7 @@ $$ ```python circuit = QuantumCircuit(1) - circuit.p(lambda, 0) # or circuit.u(0, 0, lambda) + circuit.p(lambda, 0) # or circuit.u(0, 0, lambda, 0) ``` @@ -125,6 +125,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -169,6 +173,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx index 3d3347993d4..f37b4aa7df8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx @@ -124,6 +124,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -168,6 +172,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx index f2ebc7147c0..ab3cef2e148 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx @@ -119,6 +119,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -163,6 +167,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx index 81a9553a3d0..0e57a8b3466 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx @@ -94,6 +94,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -138,6 +142,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx index 066c16edfe7..0ca577a5069 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCPauliRotGate.mdx @@ -71,6 +71,10 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -115,6 +119,10 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx index 436ac2fe8f7..0bd0e986198 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRXGate.mdx @@ -70,6 +70,10 @@ python_api_name: qiskit.circuit.library.UCRXGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -114,6 +118,10 @@ python_api_name: qiskit.circuit.library.UCRXGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx index ad6be5fc2ae..4be17d0daf1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRYGate.mdx @@ -70,6 +70,10 @@ python_api_name: qiskit.circuit.library.UCRYGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -114,6 +118,10 @@ python_api_name: qiskit.circuit.library.UCRYGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx index 88126d83281..6cbca1e9476 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCRZGate.mdx @@ -70,6 +70,10 @@ python_api_name: qiskit.circuit.library.UCRZGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -114,6 +118,10 @@ python_api_name: qiskit.circuit.library.UCRZGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx index 4467798634e..b7c7ac17dc5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx @@ -102,6 +102,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -146,6 +150,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx index 8f9fc92f071..8377b0af3dc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx @@ -95,6 +95,10 @@ python_api_name: qiskit.circuit.library.UnitaryGate Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -139,6 +143,10 @@ python_api_name: qiskit.circuit.library.UnitaryGate Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx index ce468ed5a2b..be7181e2223 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx @@ -95,6 +95,16 @@ $$ QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.UnitaryOverlap.unit "qiskit.circuit.library.UnitaryOverlap.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -263,6 +273,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.UnitaryOverlap.duration "qiskit.circuit.library.UnitaryOverlap.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -280,17 +300,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.UnitaryOverlap.unit "qiskit.circuit.library.UnitaryOverlap.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.UnitaryOverlap.duration "qiskit.circuit.library.UnitaryOverlap.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx index 13faafa9bf6..feaba30bc84 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -85,6 +85,16 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.VBERippleCarryAdder.unit "qiskit.circuit.library.VBERippleCarryAdder.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -263,6 +273,16 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.VBERippleCarryAdder.duration "qiskit.circuit.library.VBERippleCarryAdder.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -280,17 +300,5 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.VBERippleCarryAdder.unit "qiskit.circuit.library.VBERippleCarryAdder.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.VBERippleCarryAdder.duration "qiskit.circuit.library.VBERippleCarryAdder.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx index ccaea819708..3e0b04758dd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx @@ -86,7 +86,27 @@ $$ ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.WeightedAdder.unit "qiskit.circuit.library.WeightedAdder.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### global\_phase @@ -178,7 +198,9 @@ $$ ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_qubits @@ -232,7 +254,61 @@ $$ ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### prefix @@ -250,6 +326,16 @@ $$ A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.WeightedAdder.duration "qiskit.circuit.library.WeightedAdder.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### weights @@ -271,17 +357,5 @@ $$ A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.WeightedAdder.unit "qiskit.circuit.library.WeightedAdder.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.WeightedAdder.duration "qiskit.circuit.library.WeightedAdder.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx index 7bb54579999..b5d78586d64 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx @@ -106,6 +106,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -150,6 +154,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx index c6439558142..8fc91523456 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx @@ -69,6 +69,16 @@ python_api_name: qiskit.circuit.library.XOR QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.XOR.unit "qiskit.circuit.library.XOR.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -237,6 +247,16 @@ python_api_name: qiskit.circuit.library.XOR A list of `Qubit`s in the order that they were added. You should not mutate this. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.XOR.duration "qiskit.circuit.library.XOR.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -254,17 +274,5 @@ python_api_name: qiskit.circuit.library.XOR A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.XOR.unit "qiskit.circuit.library.XOR.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.XOR.duration "qiskit.circuit.library.XOR.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx index 9db92675c5c..5c5cd34004f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.mdx @@ -124,6 +124,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -168,6 +172,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx index 45ea63ea8e5..b54c93f026a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.mdx @@ -126,6 +126,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -170,6 +174,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx index 5087ae7adbb..51bdeb24bd7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.mdx @@ -106,6 +106,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -150,6 +154,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx index de8afc551e4..da795fcdb84 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx @@ -116,7 +116,27 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ZFeatureMap.unit "qiskit.circuit.library.ZFeatureMap.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -130,7 +150,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement\_blocks - + + The blocks in the entanglement layers. + + **Returns** + + The blocks in the entanglement layers. + ### feature\_dimension @@ -244,7 +270,9 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -324,7 +352,61 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### paulis @@ -382,6 +464,16 @@ python_api_name: qiskit.circuit.library.ZFeatureMap The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.ZFeatureMap.duration "qiskit.circuit.library.ZFeatureMap.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -393,17 +485,5 @@ python_api_name: qiskit.circuit.library.ZFeatureMap A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ZFeatureMap.unit "qiskit.circuit.library.ZFeatureMap.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.ZFeatureMap.duration "qiskit.circuit.library.ZFeatureMap.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx index beb39c9bd3d..8f4072d310a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.mdx @@ -106,6 +106,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -150,6 +154,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx index 1d2425d331a..398e9226ac8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. @@ -27,12 +27,15 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap where $\varphi$ is a classical non-linear function, which defaults to $\varphi(x) = x$ if and $\varphi(x,y) = (\pi - x)(\pi - y)$. - **Examples** + Examples: + + ```python + from qiskit.circuit.library import ZZFeatureMap + prep = ZZFeatureMap(2, reps=1) + print(prep.decompose()) + ``` ```python - >>> from qiskit.circuit.library import ZZFeatureMap - >>> prep = ZZFeatureMap(2, reps=1) - >>> print(prep.decompose()) ┌───┐┌─────────────┐ q_0: ┤ H ├┤ P(2.0*x[0]) ├──■──────────────────────────────────────■── ├───┤├─────────────┤┌─┴─┐┌────────────────────────────────┐┌─┴─┐ @@ -41,11 +44,20 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ``` ```python - >>> from qiskit.circuit.library import EfficientSU2 - >>> classifier = ZZFeatureMap(3) + EfficientSU2(3) - >>> classifier.num_parameters - 15 - >>> classifier.parameters # 'x' for the data preparation, 'θ' for the SU2 parameters + from qiskit.circuit.library import EfficientSU2 + classifier = ZZFeatureMap(3).compose(EfficientSU2(3)) + classifier.num_parameters + ``` + + ```python + 27 + ``` + + ```python + classifier.parameters # 'x' for the data preparation, 'θ' for the SU2 parameters + ``` + + ```python ParameterView([ ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), ParameterVectorElement(x[2]), ParameterVectorElement(θ[0]), @@ -62,7 +74,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ParameterVectorElement(θ[21]), ParameterVectorElement(θ[22]), ParameterVectorElement(θ[23]) ]) - >>> classifier.count_ops() + ``` + + ```python + classifier.count_ops() + ``` + + ```python OrderedDict([('ZZFeatureMap', 1), ('EfficientSU2', 1)]) ``` @@ -119,7 +137,27 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### data - + + The circuit data (instructions and context). + + **Returns** + + a list-like object containing the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s for each instruction. + + **Return type** + + QuantumCircuitData + + + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ZZFeatureMap.unit "qiskit.circuit.library.ZZFeatureMap.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + ### entanglement @@ -133,7 +171,13 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement\_blocks - + + The blocks in the entanglement layers. + + **Returns** + + The blocks in the entanglement layers. + ### feature\_dimension @@ -247,7 +291,9 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_parameters - + + The number of parameter objects in the circuit. + ### num\_parameters\_settable @@ -327,7 +373,61 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + + The parameters defined in the circuit. + + This attribute returns the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. + + **Examples** + + The snippet below shows that insertion order of parameters does not matter. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant") + >>> circuit = QuantumCircuit(1) + >>> circuit.rx(b, 0) + >>> circuit.rz(elephant, 0) + >>> circuit.ry(a, 0) + >>> circuit.parameters # sorted alphabetically! + ParameterView([Parameter(a), Parameter(b), Parameter(elephant)]) + ``` + + Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter + >>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")] + >>> circuit = QuantumCircuit(1) + >>> circuit.u(*angles, 0) + >>> circuit.draw() + ┌─────────────────────────────┐ + q: ┤ U(angle_1,angle_2,angle_10) ├ + └─────────────────────────────┘ + >>> circuit.parameters + ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)]) + ``` + + To respect numerical sorting, a [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. + + ```python + >>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector + >>> x = ParameterVector("x", 12) + >>> circuit = QuantumCircuit(1) + >>> for x_i in x: + ... circuit.rx(x_i, 0) + >>> circuit.parameters + ParameterView([ + ParameterVectorElement(x[0]), ParameterVectorElement(x[1]), + ParameterVectorElement(x[2]), ParameterVectorElement(x[3]), + ..., ParameterVectorElement(x[11]) + ]) + ``` + + **Returns** + + The sorted [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. + ### paulis @@ -385,6 +485,16 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap The blocks in the rotation layers. + ### unit + + + The unit that [`duration`](#qiskit.circuit.library.ZZFeatureMap.duration "qiskit.circuit.library.ZZFeatureMap.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -396,17 +506,5 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.circuit.library.ZZFeatureMap.unit "qiskit.circuit.library.ZZFeatureMap.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.circuit.library.ZZFeatureMap.duration "qiskit.circuit.library.ZZFeatureMap.duration") is specified in. - diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx index c6243c7bf68..41dacb3a6cf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate.mdx @@ -119,6 +119,10 @@ $$ Get the duration. + + + The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ### label @@ -163,6 +167,10 @@ $$ Get the time unit of duration. + + + The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 645ef915180..e4f877d8a32 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -54,6 +54,16 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.synthesis.unitary.aqc.ApproximateCircuit.unit "qiskit.synthesis.unitary.aqc.ApproximateCircuit.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -232,6 +242,16 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit a vector of parameters of this circuit. + ### unit + + + The unit that [`duration`](#qiskit.synthesis.unitary.aqc.ApproximateCircuit.duration "qiskit.synthesis.unitary.aqc.ApproximateCircuit.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -250,18 +270,6 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.synthesis.unitary.aqc.ApproximateCircuit.unit "qiskit.synthesis.unitary.aqc.ApproximateCircuit.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.synthesis.unitary.aqc.ApproximateCircuit.duration "qiskit.synthesis.unitary.aqc.ApproximateCircuit.duration") is specified in. - - ## Methods ### build diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index a3a9b3aebe7..22f4813fbb3 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -60,6 +60,16 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit QuantumCircuitData + ### duration + + + The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.unit "qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.unit"). + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### global\_phase @@ -238,6 +248,16 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit Parameters of the rotation gates in this circuit. + ### unit + + + The unit that [`duration`](#qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.duration "qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.duration") is specified in. + + + The property `qiskit.circuit.quantumcircuit.QuantumCircuit.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. + + + ### name @@ -256,18 +276,6 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit A list of the `ClassicalRegister`s in this circuit. You should not mutate this. - ### duration - - - The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by [`unit`](#qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.unit "qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.unit"). - - - ### unit - - - The unit that [`duration`](#qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.duration "qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.duration") is specified in. - - ## Methods ### build diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 8462d593311..2af42af34ac 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements # BarrierBeforeFinalMeasurements - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Add a barrier before final measurements. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements ### run - + Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx index 9e5cf72ab04..5517ea37bf8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator # BasisTranslator - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. @@ -120,7 +120,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator ### run - + Translate an input DAGCircuit to the target basis. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx index 7bddd093317..5c5e7ee1bf0 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: [`CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. @@ -22,6 +22,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – specifies the minimum number of gates in the block for the block to be collected. * **split\_layers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – specifies if blocks should be collected started from the end of the circuit. + * **matrix\_based** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – specifies whether to collect unitary gates which are Clifford gates only for certain parameters (based on their unitary matrix). ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx index b6f0ec43a74..c5d2c18e147 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis # GatesInBasis - + Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if all gates in a DAG are in a given set of gates @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis ### run - + Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/dev/qpy.mdx b/docs/api/qiskit/dev/qpy.mdx index f3bf83de929..abf6108f517 100644 --- a/docs/api/qiskit/dev/qpy.mdx +++ b/docs/api/qiskit/dev/qpy.mdx @@ -55,7 +55,7 @@ and then loading that file will return a list with all the circuits ### load - + Load a QPY binary file This function is used to load a serialized QPY Qiskit program file and create [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") objects from its contents. For example: @@ -100,7 +100,7 @@ and then loading that file will return a list with all the circuits ### dump - + Write QPY binary data to a file This function is used to save a circuit to a file for later use or transfer between machines. The QPY format is backwards compatible and can be loaded with future versions of Qiskit. @@ -153,6 +153,10 @@ and then loading that file will return a list with all the circuits If specified with an older version of QPY the limitations and potential bugs stemming from the QPY format at that version will persist. This should only be used if compatibility with loading the payload with an older version of Qiskit is necessary. + + If serializing a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") that contain [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects with `version` set low with the intent to load the payload using a historical release of Qiskit, it is safest to set the `use_symengine` flag to `False`. Versions of Qiskit prior to 1.2.3 cannot load QPY files containing `symengine`-serialized [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects unless the version of `symengine` used between the loading and generating environments matches. + + **Raises** * [**QpyError**](#qiskit.qpy.QpyError "qiskit.qpy.QpyError") – When multiple data format is mixed in the output. @@ -218,6 +222,15 @@ If a feature being loaded is deprecated in the corresponding qiskit release, QPY Visible deprecation warning for QPY loading functions without a stable point in the call stack. + + With versions of Qiskit before 1.2.3, the `use_symengine=True` argument to [`qpy.dump()`](#qiskit.qpy.dump "qiskit.qpy.dump") could cause problems with backwards compatibility if there were [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects to serialize. In particular: + + * When the loading version of Qiskit is 1.2.3 or greater, QPY files generated with any version of Qiskit >= 0.46.0 can be loaded. If a version of Qiskit between 0.45.0 and 0.45.3 was used to generate the files, and the non-default argument `use_symengine=True` was given to [`qpy.dump()`](#qiskit.qpy.dump "qiskit.qpy.dump"), the file can only be read if the version of `symengine` used in the generating environment was in the 0.11 or 0.13 series, but if the environment was created during the support window of Qiskit 0.45, it is likely that `symengine==0.9.2` was used. + * When the loading version of Qiskit is between 0.46.0 and 1.2.2 inclusive, the file can only be read if the installed version of `symengine` in the loading environment matches the version used in the generating environment. + + To recover a QPY file that fails with `symengine` version-related errors during a call to [`qpy.load()`](#qiskit.qpy.load "qiskit.qpy.load"), first attempt to use Qiskit >= 1.2.3 to load the file. If this still fails, it is likely because Qiskit 0.45.x was used to generate the file with `use_symengine=True`. In this case, use Qiskit 0.45.3 with `symengine==0.9.2` to load the file, and then re-export it to QPY setting `use_symengine=False`. The resulting file can then be loaded by any later version of Qiskit. + + ### QPY format version history If you’re planning to load a QPY file between different Qiskit versions knowing which versions were available in a given release are useful. As the QPY is backwards compatible but not forwards compatible you need to ensure a given QPY format version was released in the release you’re calling [`load()`](#qiskit.qpy.load "qiskit.qpy.load") with. The following table lists the QPY versions that were supported in every Qiskit (and qiskit-terra prior to Qiskit 1.0.0) release going back to the introduction of QPY in qiskit-terra 0.18.0. @@ -1260,6 +1273,8 @@ struct { this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +## References + \[[1](#id2)] diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index a9ef558a49f..2da91bea724 100644 Binary files a/public/api/qiskit-ibm-runtime/dev/objects.inv and b/public/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png index 960cfe03b38..33c5b213574 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/dev/circuit-2.png b/public/images/api/qiskit/dev/circuit-2.png index e0ccdb51fa2..1c7beb5b7ca 100644 Binary files a/public/images/api/qiskit/dev/circuit-2.png and b/public/images/api/qiskit/dev/circuit-2.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_01.png b/public/images/api/qiskit/dev/providers_fake_provider-1_01.png index 3fccd209b6b..b24791ce38b 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_01.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_01.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_02.png b/public/images/api/qiskit/dev/providers_fake_provider-1_02.png index ac3800f7248..898245aa494 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_02.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/dev/pulse-2.png b/public/images/api/qiskit/dev/pulse-2.png index 7c5eedcc3d9..d3af32941ab 100644 Binary files a/public/images/api/qiskit/dev/pulse-2.png and b/public/images/api/qiskit/dev/pulse-2.png differ diff --git a/public/images/api/qiskit/dev/pulse-3.png b/public/images/api/qiskit/dev/pulse-3.png index d29e4652ce6..4da2b9c89ae 100644 Binary files a/public/images/api/qiskit/dev/pulse-3.png and b/public/images/api/qiskit/dev/pulse-3.png differ diff --git a/public/images/api/qiskit/dev/pulse-4.png b/public/images/api/qiskit/dev/pulse-4.png index 310fd6b8acf..f6710b7d490 100644 Binary files a/public/images/api/qiskit/dev/pulse-4.png and b/public/images/api/qiskit/dev/pulse-4.png differ diff --git a/public/images/api/qiskit/dev/pulse-5.png b/public/images/api/qiskit/dev/pulse-5.png index 5f1b7238213..b2267067883 100644 Binary files a/public/images/api/qiskit/dev/pulse-5.png and b/public/images/api/qiskit/dev/pulse-5.png differ diff --git a/public/images/api/qiskit/dev/pulse-6.png b/public/images/api/qiskit/dev/pulse-6.png index 05b37978555..ce22fb9ebaf 100644 Binary files a/public/images/api/qiskit/dev/pulse-6.png and b/public/images/api/qiskit/dev/pulse-6.png differ diff --git a/public/images/api/qiskit/dev/pulse-7.png b/public/images/api/qiskit/dev/pulse-7.png index 527ccc407ac..a17f6ad19aa 100644 Binary files a/public/images/api/qiskit/dev/pulse-7.png and b/public/images/api/qiskit/dev/pulse-7.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png index 6cf134713cd..00b2fdce621 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png index e3f7da0433a..270d51b1b90 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png index c63fcdd6d06..e82564f8634 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png index b36590ac3b3..8b00bed94c2 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png index c18f18b6e23..d7ea45d8bd2 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png index 70ff5411417..c7b445a9fe7 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png index 27d6f55be7a..cf313b0144c 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png index c42b4186373..fbc94b583be 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png differ diff --git a/public/images/api/qiskit/dev/release_notes-1.png b/public/images/api/qiskit/dev/release_notes-1.png index e217514598b..2f3e67eb4b0 100644 Binary files a/public/images/api/qiskit/dev/release_notes-1.png and b/public/images/api/qiskit/dev/release_notes-1.png differ diff --git a/public/images/api/qiskit/dev/transpiler-16.png b/public/images/api/qiskit/dev/transpiler-16.png index 327d9338577..3367a4ad4cb 100644 Binary files a/public/images/api/qiskit/dev/transpiler-16.png and b/public/images/api/qiskit/dev/transpiler-16.png differ diff --git a/public/images/api/qiskit/dev/transpiler-17.png b/public/images/api/qiskit/dev/transpiler-17.png index 5fd2ca0fc16..8e856abc1d7 100644 Binary files a/public/images/api/qiskit/dev/transpiler-17.png and b/public/images/api/qiskit/dev/transpiler-17.png differ diff --git a/public/images/api/qiskit/dev/transpiler-5.png b/public/images/api/qiskit/dev/transpiler-5.png index 6f2ff672cd7..be17af718a8 100644 Binary files a/public/images/api/qiskit/dev/transpiler-5.png and b/public/images/api/qiskit/dev/transpiler-5.png differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index 171fb3ab662..13b46f59bab 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -1,6 +1,6 @@ { "qiskit": { - "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/1960276224/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/2006015052/zip", "1.2": "https://ibm.box.com/shared/static/nnao3s3gy1y5hyea506htupby9khrve1.zip", "1.1": "https://ibm.box.com/shared/static/bplxij6mapevjapr8ij7rluiayls982k.zip", "1.0": "https://ibm.box.com/shared/static/9mgo99x54z3rpo8irs23olqsov3uo1ly.zip", @@ -29,7 +29,7 @@ "0.19": "https://ibm.box.com/shared/static/wjoea4x5tnxd0l4lgo2v3kxnx6btxvvl.zip" }, "qiskit-ibm-runtime": { - "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/1971681836/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/2002442921/zip", "0.30": "https://ibm.box.com/shared/static/f950vkx3uq13o8g017bazpm4o9bcei2i.zip", "0.29": "https://ibm.box.com/shared/static/9n6xf8gkh24xpft2e7zrwgme7jzkh6nu.zip", "0.28": "https://ibm.box.com/shared/static/5wiif80csx3zl1tux89brx4we8w4kxhj.zip",