Skip to content

docs: add a uv install cell to every example notebook - #389

Merged
AzulGarza merged 2 commits into
mainfrom
docs/notebook-install-cells
Oct 14, 2026
Merged

AzulGarza merged 2 commits into
mainfrom
docs/notebook-install-cells

Conversation

@AzulGarza

Copy link
Copy Markdown
Member

Summary

Adds an install cell after the title of every example notebook so they run as-is when opened from the docs' Open in Colab button. Previously 24 notebooks failed at the first import.

!UV_CONSTRAINT= UV_BUILD_CONSTRAINT= uv pip install -q timecopilot
  • Colab ships uv with UV_SYSTEM_PYTHON=true, so this installs into the notebook kernel's Python, much faster than pip.
  • Colab also sets UV_CONSTRAINT/UV_BUILD_CONSTRAINT to its own constraint files, which have broken uv pip install before (googlecolab/colabtools#5237); clearing them inline avoids that.
  • Locally, run Jupyter from a virtual environment (e.g. uv run --with jupyter jupyter lab); uv pip install needs one outside Colab.
  • Notebook-specific extras: timecopilot[distributed] for Dask/Ray/Spark, timecopilot[gift-eval] (replacing the old %pip cell), plus nest-asyncio, python-dotenv, kagglehub and sktime where imported.

Each notebook only gains the new cell (formatting preserved). Every install line was dry-run resolved in a fresh Python 3.12 environment.

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
Copilot AI balanced review requested due to automatic review settings October 14, 2026 20:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The cryptocurrency notebook places its installation cell before rather than after its title.

1 open finding
What changed in this PR

Adds Colab-compatible uv installation cells to all example notebooks, including notebook-specific dependencies and extras.

Changes:

  • Adds installation cells after notebook titles.
  • Clears Colab’s conflicting uv constraint variables.
  • Updates GIFT-Eval’s existing installation command.
File Description
agent-quickstart.ipynb Installs TimeCopilot and async support.
anomaly-detection-forecaster-quickstart.ipynb Installs TimeCopilot.
aws-bedrock.ipynb Installs async and environment dependencies.
chronos-family.ipynb Installs TimeCopilot.
cryptocurrency-quickstart.ipynb Installs TimeCopilot and KaggleHub.
custom-ensembles.ipynb Installs TimeCopilot.
dask.ipynb Installs distributed and async dependencies.
explaining-foundation-models-and-ensembles.ipynb Installs TimeCopilot and async support.
finetuning.ipynb Installs TimeCopilot.
forecaster-quickstart.ipynb Installs TimeCopilot.
gift-eval.ipynb Replaces %pip with the uv command.
google-llms.ipynb Installs async and environment dependencies.
llm-providers.ipynb Installs async and environment dependencies.
pandas_baseline.ipynb Installs TimeCopilot and async support.
patchtst-fm-family.ipynb Installs TimeCopilot.
patchtst-fm.ipynb Installs TimeCopilot and async support.
pyspark.ipynb Installs distributed and async dependencies.
ray.ipynb Installs distributed and async dependencies.
sktime.ipynb Installs sktime and async dependencies.
t0-family.ipynb Installs TimeCopilot.
tabpfn-family.ipynb Installs the environment dependency.
timesfm-family.ipynb Installs TimeCopilot.
tirex-family.ipynb Installs TimeCopilot.
toto-family.ipynb Installs TimeCopilot.
ts-foundation-models-comparison-quickstart.ipynb Installs TimeCopilot.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@@ -1,5 +1,15 @@
{
"cells": [
{

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 3f0a88d: the install cell now follows the title.

Co-authored-by: Cursor <cursoragent@cursor.com>
@AzulGarza
AzulGarza merged commit 3f08de5 into main Oct 14, 2026
10 checks passed
@AzulGarza
AzulGarza deleted the docs/notebook-install-cells branch October 14, 2026 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants