Skip to content

Fix branding #165

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

Jump to bottom
Merged
merged 1 commit into from
Feb 28, 2022
Merged

Fix branding #165

merged 1 commit into from
Feb 28, 2022

Conversation

rathishcholarajan
Copy link
Member

@rathishcholarajan rathishcholarajan commented Feb 25, 2022 •
edited
Loading

Summary

Qiskit Runtime

  1. For repo names we stick with the pattern (since we have already suggested this to partners):
# IBM
qiskit-ibm-runtime

# Other Partners
qiskit-dell-runtime
qiskit-ionq-runtime
qiskit-aqt-runtime
  1. For usage as title in README/Documentation:
# IBM
Qiskit Runtime IBM Quantum Client

# Other Partners
Qiskit Runtime Dell Client
Qiskit Runtime IonQ Client
Qiskit Runtime AQT Client
  1. For usage as description:
# IBM
IBM Quantum Client for Qiskit Runtime

# Other Partners
Dell Client for Qiskit Runtime
IonQ Client for Qiskit Runtime
AQT Client for Qiskit Runtime

Note: These are called Client and not Provider because they don't implement the Qiskit Provider interface.

  1. A Client uses a Service class to connect to the API. Ex: IBMRuntimeService.
from qiskit_ibm_runtime import IBMRuntimeService

Similarly we could have DellRuntimeService, IonQRuntimeService or AQTRuntimeService. (If you are thinking of adding Qiskit or Quantum to the class name it just makes it too long, since we are importing from qiskit_* we don't have to repeat that)

For other projects:

Qiskit Experiments

  1. Repo name: qiskit-ibm-experiment
  2. Usage as Title in README/Documentation: Qiskit Experiments IBM Quantum Client
  3. Usage as Description: IBM Quantum Client for Qiskit Experiments
  4. Service class name: IBMExperimentService

Providers

Any packages that implement the Qiskit Provider interface can be called as Providers (a special type of Client). These are generally legacy interfaces and they don't necessarily have to align with the new patterns as explained above.

  1. Repo name: qiskit-ibm-provider
  2. Usage as Title in README/Documentation: Qiskit IBM Quantum Provider
  3. Usage as Description: Qiskit IBM Quantum Provider
  4. Provider class name: IBMProvider

@coveralls
Copy link

coveralls commented Feb 25, 2022 •
edited
Loading

Pull Request Test Coverage Report for Build 1900582317

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 56.778%
Totals Coverage Status
Change from base Build 1897164926: 0.0%
Covered Lines: 2044
Relevant Lines: 3600
💛 - Coveralls

daka1510
daka1510 reviewed Feb 28, 2022
View reviewed changes
Copy link
Collaborator

@daka1510 daka1510 left a comment

Choose a reason for hiding this comment

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

Thanks for summming this up, @rathishcholarajan. I think it's important to get everyone aligned on the "branding" of the client libraries even if that involves some discussion cycles.

General Questions

  • Do we need to differentiate between For usage as description vs. For usage as title in README/Documentation?
  • Is IBM Client for ... (instead of IBM Quantum Client for ...) also an option to stay consistent with other names like Dell Client for ..., IonQ client for ...?
  • Can we fix this decision via a code review? If not, whom should we involve to give a green light to make sure names do not keep changing once published?

Personal Preference

  • IBM Client for Qiskit Runtime
  • IBM Client for Qiskit Experiments

@rathishcholarajan
Copy link
Member Author

Thanks for summming this up, @rathishcholarajan. I think it's important to get everyone aligned on the "branding" of the client libraries even if that involves some discussion cycles.

General Questions

  • Do we need to differentiate between For usage as description vs. For usage as title in README/Documentation?
  • Is IBM Client for ... (instead of IBM Quantum Client for ...) also an option to stay consistent with other names like Dell Client for ..., IonQ client for ...?

I think it'd be nice if the description were a little more descriptive than feel like a title. I searched to see if Dell had a Quantum branding, but couldn't find one. But the idea is to include the word Quantum if available (previously IBMQ). Other companies like IonQ and AQT are Quantum Computing companies and that's why we don't have to include the word Quantum.

  • Can we fix this decision via a code review? If not, whom should we involve to give a green light to make sure names do not keep changing once published?

Change is constant. I think we are sticking to the branding here, so don't see a reason for anyone else to review.

Personal Preference

  • IBM Client for Qiskit Runtime
  • IBM Client for Qiskit Experiments

Same reason as above, we should highlight Quantum division.

@rathishcholarajan rathishcholarajan self-assigned this Feb 28, 2022
@rathishcholarajan
Copy link
Member Author

I am going to merge this since we need to release 0.1.0 now. We can always restart conversation and change things if needed.

@rathishcholarajan rathishcholarajan merged commit f10d088 into Qiskit:main Feb 28, 2022
@rathishcholarajan rathishcholarajan deleted the fix-branding branch February 28, 2022 18:56
@daka1510 daka1510 mentioned this pull request Mar 7, 2022
Closed
blakejohnson pushed a commit to blakejohnson/qiskit-ibm-runtime that referenced this pull request May 26, 2023
@rathishcholarajan
Deprecate circuit_indices and observable_indices and add circuits and…
e58a125 
… observables (Qiskit#165)

* Adapt to base class changes Qiskit/qiskit#8065

* Adapt sampler to base class changes in terra

* Fix black

* Fix lint

* Fix parameter names

* Use Ikko's branch from terra temporarily for testing base class changes

* Fix some failing tests

* Fix couple more tests

* Fix all test failures

* Install rust

* Install rust compiler

* Fix disabling prompt when installing rust

* Run cargo

* Fix parameter name

* Fix black

* Update requirements.txt

* Apply suggestions from code review

Co-authored-by: IKKO HAMAMURA <Ikko.Hamamura1@ibm.com>

* Match _call signature with base classes and remove unnecessary casts

* Try with terra pre pre-release

* Double equals needed

* Fix lint

* qiskit-terra 0.21.0 released, so use that

no longer need to install rust since we are not installing terra from source anymore

qiskit-aer is really a dev dependency for this repo and use the main branch code for now since PR Qiskit/qiskit-aer#1521 is not released yet

* Stop inheriting QiskitTestCase so tests do not fail on deprecation warnings

Co-authored-by: IKKO HAMAMURA <Ikko.Hamamura1@ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daka1510 daka1510 daka1510 left review comments

@jyu00 jyu00 Awaiting requested review from jyu00

@kt474 kt474 Awaiting requested review from kt474

Assignees

@rathishcholarajan rathishcholarajan

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rathishcholarajan @coveralls @daka1510