DataDesigner/docs/notebook_source
Kirit Thadaka de7c3ab99a
docs: add deployment, performance tuning guides and streamline gettin… (#277)
* docs: add deployment, performance tuning guides and streamline getting started

- Add deployment-options.md: Library vs. Microservice decision guide
- Add inference-architecture.md: Separation of concerns with LLM servers
- Add performance-tuning.md: Concurrency and batching optimization guide
- Streamline index.md: Merge installation, add quick example, simplify
- Remove quick-start.md: Content merged into welcome page
- Remove installation.md: Content merged into welcome page
- Update model docs: Add concurrency control sections and cross-references
- Update mkdocs.yml: Add new Architecture section to navigation

* docs: add tasteful emojis to new documentation pages

* docs: consolidate redundant concurrency and troubleshooting content

- Remove duplicate max_parallel_requests tables from model-configs.md and inference-parameters.md
- Remove duplicate Concurrency Control section from model-configs.md
- Simplify Concurrency Control in inference-parameters.md to link to performance-tuning.md
- Remove Troubleshooting section from inference-architecture.md (covered in performance-tuning.md)
- performance-tuning.md is now the authoritative source for tuning guidance

* Simplified doc additions

* Switched default model to nemotron 3 nano

* Addressed feedback

* Added first blog draft
2026-02-02 21:03:58 -08: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 docs: add deployment, performance tuning guides and streamline gettin… (#277) 2026-02-02 21:03:58 -08: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