lambeq icon indicating copy to clipboard operation
lambeq copied to clipboard

Add more tutorials and example notebooks in the documentation

Open dimkart opened this issue 1 year ago • 2 comments

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 avatar Jun 19 '23 13:06 dimkart