From f10d088bfcb06d6f70df76d348257c22e06309d9 Mon Sep 17 00:00:00 2001 From: Rathish Cholarajan Date: Mon, 28 Feb 2022 13:56:40 -0500 Subject: [PATCH] Fix branding (#165) --- .github/ISSUE_TEMPLATE.md | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- CONTRIBUTING.md | 10 +++---- README.md | 42 ++++++++++++++-------------- docs/apidocs/ibm-runtime.rst | 2 +- docs/conf.py | 4 +-- docs/index.rst | 6 ++-- qiskit_ibm_runtime/__init__.py | 6 ++-- setup.py | 3 +- test/ibm_test_case.py | 4 +-- 10 files changed, 40 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 8399da7a2..8832d080c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -21,6 +21,6 @@ assignees: '' **Additional Information** -- **Qiskit IBM Runtime version**: +- **qiskit-ibm-runtime version**: - **Python version**: - **Operating system**: diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8399da7a2..8832d080c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,6 +21,6 @@ assignees: '' **Additional Information** -- **Qiskit IBM Runtime version**: +- **qiskit-ibm-runtime version**: - **Python version**: - **Operating system**: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c37353f4..645c39850 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,11 +7,11 @@ included in the qiskit documentation: https://qiskit.org/documentation/contributing_to_qiskit.html -Contributing to Qiskit IBM Runtime ---------------------------- +Contributing to qiskit-ibm-runtime +----------------------------------- In addition to the general guidelines there are specific details for -contributing to the Qiskit IBM Runtime, these are documented below. +contributing to qiskit-ibm-runtime, these are documented below. ### Pull request checklist @@ -245,8 +245,8 @@ QISKIT_IBM_INSTANCE=crn:v1:bluemix:... # The CRN value ``` -To enable test cases against external system in your private fork, make sure to set above values as -[encrypted environment secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment). +To enable test cases against external system in your private fork, make sure to set above values as +[encrypted environment secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment). The names of the environments must match the ones that the [CI workflow](.github/workflows/ci.yml) relies upon. diff --git a/README.md b/README.md index 76e77a321..29f643e10 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Qiskit IBM Runtime +# Qiskit Runtime IBM Quantum Client [![License](https://img.shields.io/github/license/Qiskit/qiskit-ibm-runtime.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)[![CI](https://github.com/Qiskit/qiskit-ibm-runtime/actions/workflows/ci.yml/badge.svg)](https://github.com/Qiskit/qiskit-ibm-runtime/actions/workflows/ci.yml)[![](https://img.shields.io/github/release/Qiskit/qiskit-ibm-runtime.svg?style=popout-square)](https://github.com/Qiskit/qiskit-ibm-runtime/releases)[![](https://img.shields.io/pypi/dm/qiskit-ibm-runtime.svg?style=popout-square)](https://pypi.org/project/qiskit-ibm-runtime/)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![Coverage Status](https://coveralls.io/repos/github/Qiskit/qiskit-ibm-runtime/badge.svg?branch=main)](https://coveralls.io/github/Qiskit/qiskit-ibm-runtime?branch=main) @@ -7,13 +7,13 @@ **Qiskit Runtime** is a new architecture offered by IBM Quantum that streamlines quantum computations. It is designed to use classical compute resources to execute quantum circuits with more efficiency on quantum processors. -Using Qiskit Runtime, for example, a research team at IBM Quantum was able to achieve 120x speed -up in their lithium hydride simulation. For more information, see the +Using Qiskit Runtime, for example, a research team at IBM Quantum was able to achieve 120x speed +up in their lithium hydride simulation. For more information, see the [IBM Research blog](https://research.ibm.com/blog/120x-quantum-speedup). -Qiskit Runtime allows authorized users to upload quantum programs. A quantum program, also called a +Qiskit Runtime allows authorized users to upload quantum programs. A quantum program, also called a Qiskit runtime program, is a piece of Python code that takes certain inputs, performs -quantum and classical computation, and returns the processing results. The users can then +quantum and classical computation, and returns the processing results. The users can then invoke these quantum programs by simply passing in the required input parameters. This module provides the interface to access Qiskit Runtime. @@ -26,19 +26,19 @@ You can install this package using pip: pip install qiskit-ibm-runtime ``` -## Account Setup +## Account Setup ### Qiskit Runtime on IBM Cloud -Qiskit Runtime is now part of the IBM Quantum Services on IBM Cloud. To use this service, you'll -need to create an IBM Cloud account and a quantum service instance. -[This guide](https://cloud.ibm.com/docs/quantum-computing?topic=quantum-computing-gettingstarted) -contains step-by-step instructions on setting this up, including directions to find your +Qiskit Runtime is now part of the IBM Quantum Services on IBM Cloud. To use this service, you'll +need to create an IBM Cloud account and a quantum service instance. +[This guide](https://cloud.ibm.com/docs/quantum-computing?topic=quantum-computing-gettingstarted) +contains step-by-step instructions on setting this up, including directions to find your IBM Cloud API key and Cloud Resource Name (CRN), which you will need for authentication. ### Qiskit Runtime on IBM Quantum -Prior to becoming an IBM Cloud service, Qiskit Runtime was offered on IBM Quantum. If you have an +Prior to becoming an IBM Cloud service, Qiskit Runtime was offered on IBM Quantum. If you have an existing IBM Quantum account, you can continue using Qiskit Runtime on IBM Quantum, which is referred to as legacy runtime. You will need your IBM Quantum API token to authenticate with the Qiskit Runtime service: @@ -47,8 +47,8 @@ You will need your IBM Quantum API token to authenticate with the Qiskit Runtime 1. Copy (and optionally regenerate) your API token from your [IBM Quantum account page]. - -### Saving Account on Disk + +### Saving Account on Disk Once you have the account credentials, you can save them on disk, so you won't have to input them each time. The credentials are saved in the `$HOME/.qiskit/qiskit-ibm.json` file, where `$HOME` is your home directory. @@ -59,7 +59,7 @@ them each time. The credentials are saved in the `$HOME/.qiskit/qiskit-ibm.json` ```python from qiskit_ibm_runtime import IBMRuntimeService -# Save an IBM Cloud account. +# Save an IBM Cloud account. IBMRuntimeService.save_account(auth="cloud", token="MY_IBM_CLOUD_API_KEY", instance="MY_IBM_CLOUD_CRN") # Save an IBM Quantum account. @@ -89,7 +89,7 @@ service = IBMRuntimeService() ### Enabling Account for Current Session -As another alternative, you can also enable an account just for the current session by instantiating the +As another alternative, you can also enable an account just for the current session by instantiating the service with your credentials. ```python @@ -114,10 +114,10 @@ service = IBMRuntimeService() service.pprint_programs() ``` -`pprint_programs()` prints the summary metadata of the first 20 programs visible to you. A program's metadata -consists of its ID, name, description, input parameters, return values, interim results, and +`pprint_programs()` prints the summary metadata of the first 20 programs visible to you. A program's metadata +consists of its ID, name, description, input parameters, return values, interim results, and other information that helps you to know more about the program. `pprint_programs(detailed=True, limit=None)` -will print all metadata for all programs visible to you. +will print all metadata for all programs visible to you. ### Executing a Program @@ -144,8 +144,8 @@ result = job.result() A **backend** is a quantum device or simulator capable of running quantum circuits or pulse schedules. -You can query for the backends you have access to. Attributes and methods of the returned instances -provide information, such as qubit counts, error rates, and statuses, of the backends. +You can query for the backends you have access to. Attributes and methods of the returned instances +provide information, such as qubit counts, error rates, and statuses, of the backends. ```python from qiskit_ibm_runtime import IBMRuntimeService @@ -164,7 +164,7 @@ Now you're set up and ready to check out some of the [tutorials]. ## Contribution Guidelines -If you'd like to contribute to Qiskit IBM Runtime, please take a look at our +If you'd like to contribute to qiskit-ibm-runtime, please take a look at our [contribution guidelines]. This project adheres to Qiskit's [code of conduct]. By participating, you are expected to uphold to this code. diff --git a/docs/apidocs/ibm-runtime.rst b/docs/apidocs/ibm-runtime.rst index ca9d51ecf..39674e768 100644 --- a/docs/apidocs/ibm-runtime.rst +++ b/docs/apidocs/ibm-runtime.rst @@ -1,5 +1,5 @@ ***************************************** -Qiskit IBM Runtime API Reference +qiskit-ibm-runtime API Reference ***************************************** .. toctree:: diff --git a/docs/conf.py b/docs/conf.py index 85ee6c8d7..8fe111e10 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,8 +39,8 @@ os.environ['QISKIT_DOCS'] = 'TRUE' # -- Project information ----------------------------------------------------- -project = 'Qiskit IBM Runtime' -copyright = '2021, Qiskit Development Team' # pylint: disable=redefined-builtin +project = 'Qiskit Runtime IBM Quantum Client' +copyright = '2022, Qiskit Development Team' # pylint: disable=redefined-builtin author = 'Qiskit Development Team' # The short X.Y version diff --git a/docs/index.rst b/docs/index.rst index d6e175390..61f30328d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ ######################################### -Qiskit IBM Runtime documentation +Qiskit Runtime documentation ######################################### Qiskit Runtime @@ -35,8 +35,8 @@ Eventually, you will be able to call primitives from a generic program definitio primitive program interface that best suits your output needs to run circuits seamlessly and efficiently on IBM quantum systems. -Qiskit IBM Runtime -================== +Qiskit Runtime IBM Quantum Client +================================= ``qiskit-ibm-runtime`` provides the interface to interact with Qiskit Runtime. You can, for example, use it to query and execute runtime programs: diff --git a/qiskit_ibm_runtime/__init__.py b/qiskit_ibm_runtime/__init__.py index 29d086648..417186270 100644 --- a/qiskit_ibm_runtime/__init__.py +++ b/qiskit_ibm_runtime/__init__.py @@ -17,13 +17,13 @@ .. currentmodule:: qiskit_ibm_runtime -Modules related to Qiskit IBM Runtime Service. +Modules related to Qiskit Runtime IBM Quantum Client. Qiskit Runtime is a new architecture that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. -The Qiskit Runtime Service allows authorized users to upload their Qiskit quantum programs. +Qiskit Runtime IBM Quantum Client allows authorized users to upload their Qiskit quantum programs. A Qiskit quantum program, also called a runtime program, is a piece of Python code and its metadata that takes certain inputs, performs quantum and maybe classical processing, and returns the results. The same or other @@ -192,7 +192,7 @@ def result_callback(job_id, result): Logging ------- -Qiskit IBM Runtime Service uses the ``qiskit_ibm_runtime`` logger. +`qiskit-ibm-runtime` uses the ``qiskit_ibm_runtime`` logger. Two environment variables can be used to control the logging: diff --git a/setup.py b/setup.py index f5d298089..94e80f200 100644 --- a/setup.py +++ b/setup.py @@ -46,8 +46,7 @@ setuptools.setup( name="qiskit-ibm-runtime", version=VERSION, - description="Qiskit IBM Runtime service for accessing the quantum devices and " - "simulators at IBM", + description="IBM Quantum client for Qiskit Runtime.", long_description=README, long_description_content_type="text/markdown", url="https://github.com/Qiskit/qiskit-ibm-runtime", diff --git a/test/ibm_test_case.py b/test/ibm_test_case.py index 9b04238a3..d652e6389 100644 --- a/test/ibm_test_case.py +++ b/test/ibm_test_case.py @@ -29,7 +29,7 @@ class IBMTestCase(unittest.TestCase): - """Custom TestCase for use with the Qiskit IBM Runtime.""" + """Custom TestCase for use with qiskit-ibm-runtime.""" @classmethod def setUpClass(cls): @@ -64,7 +64,7 @@ def _set_logging_level(cls, logger: logging.Logger) -> None: class IBMIntegrationTestCase(IBMTestCase): - """Custom integration test case for use with the Qiskit IBM Runtime.""" + """Custom integration test case for use with qiskit-ibm-runtime.""" @classmethod @integration_test_setup()