Skip to content
This repository was archived by the owner on Apr 29, 2026. It is now read-only.

Add Colab quickstart notebook#15

Merged
Tatarinho merged 2 commits into
mainfrom
docs/colab-quickstart-notebook
Apr 23, 2026
Merged

Add Colab quickstart notebook#15
Tatarinho merged 2 commits into
mainfrom
docs/colab-quickstart-notebook

Conversation

@Tatarinho
Copy link
Copy Markdown
Owner

Introduces notebooks/quickstart.ipynb — a 15-cell walk-through of the full anonymize -> LLM -> deanonymize round-trip on a realistic Polish customer-service email. Runs end-to-end without an API key (mocks the LLM response when OPENAI_API_KEY is unset).

README gains an "Open in Colab" badge in the header row and a link to the notebook at the top of the examples list, so first-time visitors hit an interactive demo before the static scripts.

Michal Piotrowski added 2 commits April 23, 2026 19:18
Introduces notebooks/quickstart.ipynb — a 15-cell walk-through of the
full anonymize -> LLM -> deanonymize round-trip on a realistic Polish
customer-service email. Runs end-to-end without an API key (mocks the
LLM response when OPENAI_API_KEY is unset).

README gains an "Open in Colab" badge in the header row and a link to
the notebook at the top of the examples list, so first-time visitors
hit an interactive demo before the static scripts.
Ruff RUF001 and E501 failed on notebooks/quickstart.ipynb:

- cell 5: replace en-dash with hyphen-minus in the detect audit format
  string to satisfy RUF001 (ambiguous Unicode in string literals).
- cell 9: split the 101-char "Faktura VAT / REGON / IBAN" bullet of the
  mocked LLM response into two shorter bullets so the longest source
  line stays under the 100-char limit.

Notebook behaviour is unchanged — tokens, round-trip, and deanonymized
output are identical.
@Tatarinho Tatarinho merged commit 869d262 into main Apr 23, 2026
7 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant