Skip to content
This repository was archived by the owner on Aug 21, 2023. It is now read-only.
This repository was archived by the owner on Aug 21, 2023. It is now read-only.

Update Gradient Framework tutorial to use primitives #1390

@ElePT

Description

@ElePT

The current gradient framework tutorial has not been updated to show the implementation using primitives. Aside from the refactoring, new gradients (classically efficient) have been added, and the whole framework has been moved from qiskit.opflow to qiskit.algorithms. I believe that the TO-DO list here is:

  • Move gradient tutorial location from qiskit-tutorials/tutorials/operators to qiskit-tutorials/tutorials/algorithms
  • Update tutorial to show new gradient framework structure (similar to the existing diagram in the outdated tutorial), add an explanation of the different gradient methods implemented (here, some information from the former tutorial could be re-purposed), and show examples of how to use the new gradient classes.
  • Optionally, we could also add a new tutorial for classical efficient gradients.

You can explore the new gradient classes by navigating the API reference in:

As well as getting an introduction to the module in the gradients section of the opflow migration guide: https://qiskit.org/documentation/migration_guides/opflow_migration.html#gradients


Style guidelines:

Here are some references of the style of tutorial we are looking for

Make sure to follow the Qiskit documentation tutorial guidelines: https://qiskit.github.io/qiskit_sphinx_theme/tutorials/tutorials_guidelines.html

More examples for further reference: https://qiskit.github.io/qiskit_sphinx_theme/tutorials/tutorials_examples.html

Metadata

Metadata

Assignees

Labels

documentationSomething is not clear or error in description

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions