Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/code_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ on:
- .pre-commit-config.yaml
- .github/workflows/code_checks.yml
- '**.py'
- '**.ipynb'
- uv.lock
- pyproject.toml
- 'deploy/**'
Expand All @@ -23,6 +24,7 @@ on:
- .pre-commit-config.yaml
- .github/workflows/code_checks.yml
- '**.py'
- '**.ipynb'
- uv.lock
- pyproject.toml
- 'deploy/**'
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog

## [Unreleased]
### Added
- **A quickstart notebook you can run in Colab** (`examples/quickstart.ipynb`, #113): install, start a server, classify, regress with prediction quantiles checked on held-out rows, and list and delete contexts. Colab badges in the README and the docs quickstart. (From @tylrcc in #134.)
### Fixed
- The `python-multipart` floor is now 0.0.13: the server imports `python_multipart`, which older releases don't have, so an environment that already had one failed at startup.

## [0.21.0] - 2026-11-13
### Added
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,12 @@ own GPUs.

## Quickstart

Run a server on your laptop (CPU works; it uses the GPU if there is one):
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/VectorInstitute/tabctx/blob/main/examples/quickstart.ipynb)

Try the Python quickstart in your browser with the
[Colab notebook](https://colab.research.google.com/github/VectorInstitute/tabctx/blob/main/examples/quickstart.ipynb),
or run a server on your laptop (CPU works; it uses the GPU if there is
one):

```bash
pip install "tabctx[standalone,tabicl,client]"
Expand Down
7 changes: 6 additions & 1 deletion docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Quickstart

[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/VectorInstitute/tabctx/blob/main/examples/quickstart.ipynb)

Run a tabctx server on your laptop, fit a real dataset and predict
against it. A CPU is enough; the server uses a GPU if it finds one.
tabctx needs Python 3.12 or newer.
tabctx needs Python 3.12 or newer. Prefer a notebook? The
[quickstart notebook](https://github.com/VectorInstitute/tabctx/blob/main/examples/quickstart.ipynb)
runs the Python steps of this page end to end: install, server,
classification, regression with quantiles, and managing contexts.

## 1. Install and start a server

Expand Down
Loading
Loading