Skip to content

Add executable quickstart notebook with Colab badges - #134

Open
tylrcc wants to merge 1 commit into
VectorInstitute:mainfrom
tylrcc:fix/issue-113
Open

tylrcc wants to merge 1 commit into
VectorInstitute:mainfrom
tylrcc:fix/issue-113

Conversation

@tylrcc

@tylrcc tylrcc commented Nov 11, 2026

Copy link
Copy Markdown

Closes #113

What this adds

  • examples/quickstart.ipynb — the quickstart as a notebook, committed with its outputs kept from a full end-to-end run:
    1. pip install "tabctx[standalone,tabicl,client]"
    2. starts python -m tabctx.serve in the background (TABCTX_BACKEND=tabicl) and waits for /v1/models
    3. fits credit-g with TabctxClassifier, prints the context id, scores (0.772 in the kept run), and shows predict_proba
    4. fits TabctxRegressor on the diabetes dataset (bundled with scikit-learn, no extra download) and shows predict_quantiles as a small table (q5/q50/q95)
    5. lists the server's contexts with client.datasets(), deletes both contexts, and shows the empty list
    6. terminates the server
  • "Open in Colab" badge linking to the notebook, added to the README's Quickstart section and to docs/getting-started/quickstart.md.

Verification

The notebook was executed top to bottom locally on CPU (Python 3.12, fresh venv, weights downloaded on first server start) with zero cell errors; every output in the committed file is from that run — classification accuracy 0.772, quantile columns strictly increasing per row, both context ids listed and then deleted. The flow mirrors the README/docs quickstart exactly, so "Run all" reproduces it on a fresh Colab CPU runtime.

examples/quickstart.ipynb runs the quickstart end to end with its
outputs kept: install tabctx[standalone,tabicl,client], start
python -m tabctx.serve in the background (TABCTX_BACKEND=tabicl),
fit credit-g with TabctxClassifier and predict, fit a regressor and
show predict_quantiles, then list and delete the contexts and stop
the server.

An Open in Colab badge linking to the notebook is added to the
README Quickstart section and to docs/getting-started/quickstart.md.

This branch has not been deployed

No deployments
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.

A Colab quickstart notebook

1 participant