DataDesigner/docs/notebook_source
Andre Manoel 46358461ee
fix: repair notebook CI (dead model, missing API key, pyarrow type bug) (#348)
* fix: repair notebook CI by replacing dead vision model and adding missing API key

- Replace `meta/llama-4-scout-17b-16e-instruct` (no longer serving on
  build.nvidia.com) with `nvidia/nemotron-nano-12b-v2-vl` (project default)
  in tutorial notebook 4
- Add `OPENROUTER_API_KEY` to the `build-notebooks` workflow so notebooks
  5 and 6 (which use OpenRouter for image generation) can authenticate
- Regenerate colab notebooks to reflect the model change

* fix: handle pyarrow list types in notebook 6 display_image

When image columns are loaded from parquet with pyarrow backend,
list values are pyarrow ListScalars, not Python lists. The
isinstance(x, list) check fails, causing the whole ListScalar to be
treated as a single path string (producing filenames ending in
`png')]`). Use isinstance(x, str) instead to correctly handle any
iterable type.
2026-02-23 13:27:47 -03:00
..
1-the-basics.py feat: add image generation support with multi-modal context (#317) 2026-02-12 14:00:28 -07:00
2-structured-outputs-and-jinja-expressions.py feat: add image generation support with multi-modal context (#317) 2026-02-12 14:00:28 -07:00
3-seeding-with-a-dataset.py feat: add image generation support with multi-modal context (#317) 2026-02-12 14:00:28 -07:00
4-providing-images-as-context.py fix: repair notebook CI (dead model, missing API key, pyarrow type bug) (#348) 2026-02-23 13:27:47 -03:00
5-generating-images.py docs: add image generation documentation and image-to-image editing tutorial (#319) 2026-02-12 14:38:52 -07:00
6-editing-images-with-image-context.py fix: repair notebook CI (dead model, missing API key, pyarrow type bug) (#348) 2026-02-23 13:27:47 -03:00
_pyproject.toml chore: moving notebooks to jupytext and cleaning up workflows (#91) 2025-12-03 17:29:07 -03:00
_README.md feat: auto-detect ImageContext format for image-to-image generation (#342) 2026-02-20 15:54:42 -05: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