Skip to content

Add executable quickstart notebook with Colab badges #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tylrcc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add executable quickstart notebook with Colab badges #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ 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)

Run the whole quickstart in your browser with the
[notebook](examples/quickstart.ipynb), or on your laptop (CPU works; it
uses the GPU if there is one):

```bash
pip install "tabctx[standalone,tabicl,client]"
Expand Down
6 changes: 5 additions & 1 deletion docs/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# 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 this whole page end to end.

## 1. Install and start a server

Expand Down
Loading