DataDesigner/docs/notebook_source
Johnny Greco ae0665fa16
refactor: slim package refactor into three subpackages (#240)
* remove old structure

* major shuffle

* streamline project configs

* update make commands

* updates to make commands

* remove essentials

* initialize logger in interface

* uv lock

* ignore notepad

* update workflows

* fix e2e project config

* generate colab notebooks

* resolve default model settings in interface

* fix build commands

* update perf import make command

* cleaning up some slop

* update recipes

* move conftest files to tests/

* update subpackage readmes

* streamline config_logging

* use exports

* update perf import usage pattern

* update for IDE behavior with ruff

* remove engine's fixtures file

* add note to about lazy imports

* update dependencies

* update docs

* doc fixes

* uv lock

* updates to catch up with main

* clean up makefile

* remove package gitignores

* define deps only once

* isolate tests

* add test for protetion rule

* create temp dirs for isolated tests

* catch up to main

* update headers

* re apply changes

* better result summaries for isolated tests

* move exports into top-level init

* fix client importlib version syntax

* catch up with main
2026-01-27 13:53:20 -05:00
..
1-the-basics.py refactor: slim package refactor into three subpackages (#240) 2026-01-27 13:53:20 -05:00
2-structured-outputs-and-jinja-expressions.py refactor: slim package refactor into three subpackages (#240) 2026-01-27 13:53:20 -05:00
3-seeding-with-a-dataset.py refactor: slim package refactor into three subpackages (#240) 2026-01-27 13:53:20 -05:00
4-providing-images-as-context.py refactor: slim package refactor into three subpackages (#240) 2026-01-27 13:53:20 -05:00
_pyproject.toml chore: moving notebooks to jupytext and cleaning up workflows (#91) 2025-12-03 17:29:07 -03:00
_README.md feat: add OpenRouter as one of the default providers (#161) 2026-01-06 10:22:18 -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