Skip to content

Fix documentation issues #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rathishcholarajan merged 6 commits into from
Jan 10, 2022
Merged

Fix documentation issues #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f459bb1
Hide dashboard for initial release
rathishcholarajan Jan 8, 2022
7fbef2c
Remove hub, group and project parameters for IBMRuntimeService
rathishcholarajan Jan 8, 2022
c72e525
No need to make utils public
rathishcholarajan Jan 8, 2022
35e0d3c
Fix release note
rathishcholarajan Jan 8, 2022
2c86ab5
Fix title
rathishcholarajan Jan 8, 2022
c3d3266
Merge branch 'main' into fix-documentation-issues
rathishcholarajan Jan 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/apidocs/ibm-runtime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
*****************************************
Qiskit IBM Quantum Provider API Reference
Qiskit IBM Runtime API Reference
*****************************************

.. toctree::
:maxdepth: 1

ibm_runtime
ibm_visualization
ibm_jupyter
ibm_utils
ibm_jupyter
Comment on lines 9 to +10
Copy link
Copy Markdown
Contributor

@daka1510 daka1510 Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side-note: why do we continue to need ibm_visualization, ibm_jupyter?

Copy link
Copy Markdown
Member Author

@rathishcholarajan rathishcholarajan Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Visualizing a backend can still be useful. But we can consider if we want to remove in a separate PR.

6 changes: 0 additions & 6 deletions docs/apidocs/ibm_utils.rst
View file
Open in desktop

This file was deleted.

13 changes: 1 addition & 12 deletions qiskit_ibm_runtime/jupyter/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
from qiskit_ibm_runtime import IBMRuntimeService
import qiskit_ibm_runtime.jupyter

service = IBMRuntimeService(hub='ibm-q')
service = IBMRuntimeService()
backend = service.get_backend('ibmq_vigo')

.. jupyter-execute::
Expand All @@ -54,17 +54,6 @@

backend


IBM Quantum dashboard
======================================

.. code-block:: python

from qiskit_ibm_runtime import IBMRuntimeService
import qiskit_ibm_runtime.jupyter

%ibm_quantum_dashboard

"""
import sys

Expand Down
2 changes: 1 addition & 1 deletion qiskit_ibm_runtime/visualization/interactive/error_map.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def iplot_error_map(
from qiskit_ibm_runtime import IBMRuntimeService
from qiskit_ibm_runtime.visualization import iplot_error_map

service = IBMRuntimeService(group='open', project='main')
service = IBMRuntimeService()
backend = service.get_backend('ibmq_vigo')

iplot_error_map(backend, as_widget=True)
Expand Down
2 changes: 1 addition & 1 deletion qiskit_ibm_runtime/visualization/interactive/gate_map.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def iplot_gate_map(
from qiskit_ibm_runtime import IBMRuntimeService
from qiskit_ibm_runtime.visualization import iplot_gate_map

service = IBMRuntimeService(group='open', project='main')
service = IBMRuntimeService()
backend = service.get_backend('ibmq_vigo')

iplot_gate_map(backend, as_widget=True)
Expand Down
5 changes: 3 additions & 2 deletions releasenotes/notes/filter-jobs-by-provider-dead04faaf223840.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
features:
- |
You can now pass ``hub``, ``group``, and ``project`` parameters to
:meth:`qiskit_ibm_runtime.IBMRuntimeService.jobs` to filter jobs.
You can now pass ``instance`` parameter in the hub/group/project format to
:meth:`qiskit_ibm_runtime.IBMRuntimeService.jobs` to filter jobs. Currently
only supported for legacy authentication.