qiskit-advocate / qamp-spring-22

Qiskit advocate mentorship program (QAMP) spring 22 cohort (Mar - Jun 2022)
13 stars 1 forks source link

Expand qiskit-neko testing #10

Open mtreinish opened 2 years ago

mtreinish commented 2 years ago

Description

The qiskit-neko project: https://github.com/mtreinish/qiskit-neko is a new effort to add a proper integration test suite to the overall qiskit project. It's designed to be run in CI to ensure that a proposed change to any qiskit project doesn't break backwards compatibility or break an interface that another qiskit project is currently using. The idea behind the project is to provide feedback before we merge a pull request if an interface is potentially broken by a change and to prevent that from being merged (so it is never released). However, this project is still in it's early stages and needs to be expanded and put into CI configurations for qiskit projects. This project is to help expand the test coverage in qiskit-neko so that we have a representative set of tests and then to potentially help get it properly running in CI for all of qiskit.

Deliverables

Pull requests to qiskit-neko and potentially to other qiskit projects to start getting qiskit-neko running in CI.

Mentors details

Number of mentees

3

Type of mentees

tgag17 commented 2 years ago

Checkpoint 1 ppt: #10 Expand qiskit-neko testing.pdf

HuangJunye commented 2 years ago

@tgag17 Can you please provide your checkpoint 2 updates? Instructions are given in the slack channel.

tgag17 commented 2 years ago

@HuangJunye Sorry for the delay. I will update the checkpoint 2 asap.

tgag17 commented 2 years ago

Update: Checkpoint 2

Qiskit-neko is being developed to incorporate CI coverage in Qiskit. These tests are used primarily for two purposes: backwards compatibility testing for Qiskit to validate the changes proposed to any Qiskit project do not break functionality from the previous releases and to validate that functionality works as expected with different providers.

Before the start of the project, a few tests were already present in qiskit-neko. These covered the domains of circuits, experiments and the qiskit-nature classes. As a part of qamp 2022, I have till now added a few tests covering the qiskit-machine learning classes.

Particularly, by taking reference from the tutorials available, the following tests have been added:

The PR for the tests is still under review: (https://github.com/mtreinish/qiskit-neko/pull/3) These tests provide an initial test coverage for the quantum-machine-learning module.

Future Work:

In the next steps, the focus will be shifted to creating Github actions for CI and integrating qiskit-neko with the qiskit repository.

Screenshot (1042)

tgag17 commented 2 years ago

Final Checkpoint ppt: #10 Expand qiskit-neko testing.pdf