Skip to content

Notebooks

Each .ipynb file here is rendered as a page under /cookbooks/ in the docs site.

Cards on the cookbooks landing page are driven by cards.yaml. The MkDocs hook docs/hooks/cookbooks_cards.py loads that file and exposes it to docs/theme/notebooks.html, which renders each entry as a card via a Jinja loop.

Adding a notebook

  1. Add the .ipynb file here, named release-demo_<version>.ipynb (e.g. release-demo_1-8.ipynb).
  2. Add a new entry to docs/cookbooks/cards.yaml under the cards: list:
  - href: release-demo_X-Y/
    name: Short Title
    labels: [LABEL1, LABEL2]
    version: vX.Y.0
    author: GitHubUsername
    description: One sentence describing what the notebook demonstrates.

Available labels (reuse these to keep tags standardised): TRAINING, AUGMENTATION, EXPORT, TFLITE, PYTORCH LIGHTNING, INFERENCE, SEGMENTATION, DEPLOY. Current tag colours are assigned dynamically by the docs UI, so they may change if cards or labels are added or reordered.

Removing a notebook

  1. Delete the .ipynb file.
  2. Remove the matching entry (the - href: release-demo_X-Y/ block) from docs/cookbooks/cards.yaml.

Current notebooks

File Card title Version
release-demo_1-5.ipynb Custom Augmentations and Live Training Progress v1.5.0
release-demo_1-6.ipynb PyTorch Lightning Building Blocks v1.6.0