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

Add more tutorials and example notebooks in the documentation #107

Open
dimkart opened this issue Jun 19, 2023 · 4 comments
Open

Add more tutorials and example notebooks in the documentation #107

dimkart opened this issue Jun 19, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers up-for-grabs Available to external contributors

Comments

@dimkart
Copy link
Contributor

dimkart commented Jun 19, 2023

Description

In an open-source project like lambeq, you can never have too many tutorials or example notebooks. This open-ended task asks for contributions on this matter. Any meaningful tutorial is welcome, but some concrete suggestions are also provided below:

  • Write a tutorial for a multi-class classification task.
  • Write a tutorial for a regression task.
  • Write a tutorial that explains basic quantum concepts such as qubits, gates, entanglement etc using lambeq circuits or string diagrams.

Notes

  • A good option for writing your training tutorials is the PennyLane model, since it's quite flexible to cover most of the important use cases.
  • lambeq documentation is generated with Sphinx, and is written in restructured text (RST) format.
  • lambeq tutorials that contain code are Jupyter notebooks, whose text cells are written in RST format so they can be integrated easily with the rest of the documentation. To mark a cell as RST in Jupyter notebook's web editor, do the following:
    1. Display the raw cell format toolbar by selecting View > Cell Toolbar > Raw cell format
    2. Select the cell and and then the option Cell > Cell type > Raw NBConvert
    3. Select from cell's "Raw NBConvert Format" menu the option "reST".

See also:

@dimkart dimkart added documentation Improvements or additions to documentation good first issue Good for newcomers up-for-grabs Available to external contributors labels Jun 19, 2023
@ACE07-Sev
Copy link
Contributor

ACE07-Sev commented Jun 29, 2023

May I first make a PR for a binary classifier, and then add the multiclass classifier as a extension of that?

It would also help me apply the feedback from that to the multiclass tutorial.

@dimkart
Copy link
Contributor Author

dimkart commented Jun 30, 2023

Hi, we really don't need another binary classification example, since all tutorials are currently like that. I would say just proceed directly to the multi-class case. The changes are not that big anyway.

@goodship1
Copy link

hi i will add a few tutorials any think in particular you would like too see ?

@dimkart
Copy link
Contributor Author

dimkart commented Nov 19, 2024

@goodship1 Hi and thanks for volunteering. Here are few ideas:

  • A multi-class classification example e.g. with PennyLane model
  • A regression example
  • An introductory tutorial on quantum computing showing basic concepts in lambeq's context, e.g. how qubits are represented as (2,) tensors, how circuits are evaluated etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers up-for-grabs Available to external contributors
Projects
None yet
Development

No branches or pull requests

3 participants