Skip to content
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.

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

Migrate tutorials from qiskit-tutorials #14

Closed
6 tasks
ElePT opened this issue Jul 24, 2023 · 3 comments · Fixed by #44
Closed
6 tasks

Migrate tutorials from qiskit-tutorials #14

ElePT opened this issue Jul 24, 2023 · 3 comments · Fixed by #44

Comments

@ElePT
Copy link
Collaborator

ElePT commented Jul 24, 2023

What should we add?

Given Qiskit/qiskit-tutorials#1473, we should migrate algorithm-related tutorials from qiskit-tutorials to qiskit-algorithms.

To do:

  • History-preserving move from qiskit-tutorials/algorithms to qiskit_algorithms/tutorials
  • Update imports in code snippets from qiskit.algorithms to qiskit_algorithms
  • Update API-reference links and other documentation links in the tutorial body
  • Update any references to tutorials in code API docstrings - grover.py has a note that links to the textbook and the tutorial (I noticed this first and searched for others but that was the only place I saw that needed fixing)
  • Update wording around Qiskit. For instance the title of the 1st tutorial is An Introduction to Algorithms in Qiskit and perhaps we need something more like An Introduction to Algorithms for Qiskit instead given the move etc. Text in the main body should be checked over too and reworded appropriately e.g. from same tutorial Qiskit provides a number of Algorithms...
  • Update random_seed setting using algorithm_globals (an import change) - see A new algorithm_globals to replace use of qiskit.utils instance #33
@robotAstray
Copy link

Hello @ElePT I will start working on this. Thank you

@robotAstray
Copy link

@ElePT regarding "History-preserving move from qiskit-tutorials/algorithms to qiskit_algorithms/tutorials". The tutorials are usually in <name of project>/docs/tutorials, and the quantum-algorithm repo already has a docs folder. Would you like me to put the tutorials under docs instead to be consistent with other repos?

@robotAstray
Copy link

Never mind, I can see where the first tutorial is located which is indeed under docs so I know where to put the rest. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants