DataDesigner/docs/notebook_source
Nabin Mulepati 1de2262b94
docs: add models module to code reference (#101)
* Add example notebook showing how to use image contexts

* change 101 -> tutorial

* update _README.md with info on the new tutorial

* add reference in mkdocs.yml

* simplify vlm tutorial

* update num_records on tutorials. Update .gitignore

* update readme info

* add models module to code reference

* fix links to generated ipynb

* change vlm in example tutorial to llama4-scout
2025-12-05 10:41:43 -07:00
..
1-the-basics.py docs: Add example notebook showing how to use image contexts (#97) 2025-12-04 15:39:58 -07:00
2-structured-outputs-and-jinja-expressions.py docs: Add example notebook showing how to use image contexts (#97) 2025-12-04 15:39:58 -07:00
3-seeding-with-a-dataset.py docs: Add example notebook showing how to use image contexts (#97) 2025-12-04 15:39:58 -07:00
4-providing-images-as-context.py docs: add models module to code reference (#101) 2025-12-05 10:41:43 -07:00
_pyproject.toml chore: moving notebooks to jupytext and cleaning up workflows (#91) 2025-12-03 17:29:07 -03:00
_README.md docs: Add example notebook showing how to use image contexts (#97) 2025-12-04 15:39:58 -07:00
README.md fix: small typo on text file (#95) 2025-12-03 18:31:35 -03:00

📓 Notebooks in .py Format

In this folder you can find all our tutorial notebooks in .py format. They can be converted to actual Jupyter notebooks by typing

make convert-execute-notebooks

from the root of the repository. This will not only convert but also execute all of the notebooks -- for that to work, make sure you went through our Quick Start and have API keys set. A new folder docs/notebooks will be created, including README.md and pyproject.toml files.

Alternatively, you can use Jupytext directly

uv run --group notebooks --group docs jupytext --to ipynb *.py

🔄 Converting Jupyter notebooks to .py

If you want to contribute with your own notebook, you can use the following command to generate .py files in the same format as the ones in this folder:

uv run jupytext --to py [notebook-name].ipynb -o [notebook-name].py