Skip to content

docs: make the quickstart examples run in order - #570

Merged
mkumar73 merged 1 commit into
mainfrom
docs/quickstart-runs
Oct 31, 2026
Merged

mkumar73 merged 1 commit into
mainfrom
docs/quickstart-runs

Conversation

@ChrisW09

Copy link
Copy Markdown
Collaborator

Fixes #569

Problem

Running the quickstart's python blocks in order failed twice:

  • the regression example overwrote the classification split, so the following config example fitted a MambularClassifier on continuous targets (InvalidDataError);
  • the LSS example began with X_train, X_test, y_train, y_test = ... (TypeError: cannot unpack non-iterable ellipsis object).

Change

Docs only, docs/getting_started/quickstart.md:

  • The regression example keeps its data in X_reg/y_reg and X_train_reg/X_test_reg/y_train_reg/y_test_reg.
  • The LSS example reuses that split instead of the placeholder.

The other examples are unchanged.

Verification

All quickstart code blocks now run in order in one session (1 epoch, CPU). The only exception is the illustrative inference fragments with a placeholder X_new, which this PR doesn't touch.

Checks

  • just test: 3236 passed, 46 skipped, 28 xfailed; coverage 91.29%
  • just docs: build succeeded (warnings treated as errors)
  • just check: all hooks passed (ruff, prettier, pyright)

The regression example rebound X_train/y_train, so the following config
example fitted a classifier on continuous targets, and the LSS example
started with an "X_train, ... = ..." placeholder that raises TypeError.
Keep the regression split in its own *_reg variables and reuse it in the
LSS example.

Fixes #569
@mkumar73
mkumar73 merged commit 95a9d3b into main Oct 31, 2026
35 checks passed
@mkumar73
mkumar73 deleted the docs/quickstart-runs branch October 31, 2026 23: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.

[DOCS] Quickstart examples fail when run in order (overwritten split, "..." placeholder)

2 participants