Potato: The Portable Annotation Tool

July 27, 2026 · View on GitHub

Docs & Guides Technical Reference PyPI License Paper (Potato 2.0) Paper (Potato 1.0) Live Demo Website

Potato is a free, self-hosted annotation platform for NLP, Agentic, GenAI, and qualitative research. Annotate text, audio, video, images, documents, agent traces, and more — or run a full qualitative data analysis (QDA) workflow with a living codebook, memos, and cases. Configured entirely through YAML. No coding required.

Try the live demo on HuggingFace Spaces — no installation needed. More at www.potatoannotator.com.


Quick Start

pip install potato-annotation
# The examples/ folder ships with the source repo (see "run from source" below).
# After a PyPI install, clone the repo for the examples, or point `potato start`
# at your own config (see docs/quick-start.md).
potato start examples/classification/single-choice/config.yaml -p 8000

Or run from source (recommended to get the examples/):

git clone https://github.com/davidjurgens/potato.git
cd potato && pip install -r requirements.txt
python potato/flask_server.py start examples/classification/single-choice/config.yaml -p 8000

Open http://localhost:8000 and start annotating. Browse the examples/ directory for ready-to-use templates.


What Can You Annotate?

Potato handles the full spectrum of annotation tasks — from traditional NLP labeling to evaluating the latest AI agent systems, to interpretive qualitative analysis.

The tables below are a representative sample, not a complete list. Schemes and data types compose freely, custom layouts and raw HTML let you build interfaces beyond these, and new schema types can be added. If you don't see your task here, it's likely still possible.

Data Types

ModalityCapabilities
TextClassification, span labeling, entity linking, coreference, pairwise comparison (docs)
Agent TracesStep-by-step evaluation of LLM agents, tool calls, ReAct chains, and multi-agent systems (docs)
Web AgentsScreenshot-based review with SVG click/scroll overlays, or live browsing with automatic trace recording (docs)
RAG PipelinesRetrieval relevance, answer faithfulness, citation accuracy, hallucination detection
AudioWaveform visualization, segment labeling, ELAN-style tiered annotation, and 21 transcript/subtitle formats read directly — Whisper, cloud ASR, SRT/VTT, YouTube captions, TextGrid/EAF (docs, transcripts)
VideoFrame-by-frame labeling, temporal segments, playback sync (docs)
ImagesBounding boxes, polygons, landmarks, classification (docs)
DialogueTurn-level annotation, conversation trees, interactive chat evaluation, and diarized transcripts synced to their audio (docs)
DocumentsPDF, Word, Markdown, code, and spreadsheets with coordinate mapping (docs)

Annotation Schemes

SchemeUse Case
Radio / Checkbox / LikertClassification, multi-label, rating scales
Span annotationNER, highlighting, hallucination marking
Pairwise comparisonA/B testing, best-worst scaling
Per-step ratingsEvaluate individual agent actions or dialogue turns
Free textOpen-ended responses with validation
TriageRapid accept/reject/skip curation (docs)
Conditional logicAdaptive forms that respond to prior answers (docs)

Agent & LLM Evaluation

Potato provides purpose-built tooling for evaluating AI agents at every level of granularity.

Trace Formats

Import traces from any major agent framework with the built-in converter:

python -m potato.trace_converter --input traces.json --input-format openai --output data.jsonl

Supported formats: OpenAI, Anthropic/Claude, ReAct, LangChain, LangFuse, WebArena, SWE-bench, OpenTelemetry, CrewAI/AutoGen/LangGraph, MCP, Aider, Claude Code, ATIF, SWE-Agent, and Web Agent. Auto-detection is available with --auto-detect.

Evaluation Levels

LevelWhat You AnnotateExample
TrajectoryOverall task success, efficiency, safety"Did the agent complete the task?"
StepIndividual action correctness, reasoning qualityPer-turn Likert ratings on each agent step
SpanSpecific text segments within agent outputHighlight hallucinated claims, factual errors
ComparisonSide-by-side A/B agent evaluation"Which agent performed better?"

Web Agent Viewer

An interactive viewer for GUI agent traces — navigate step-by-step through screenshots with SVG overlays showing clicks, bounding boxes, mouse paths, and scroll actions. Annotators rate each step with inline controls while a filmstrip bar provides quick navigation.

Ready-to-Use Agent Examples

ExampleWhat It Evaluates
agent-trace-evaluationText agent traces with MAST error taxonomy + hallucination spans
visual-agent-evaluationGUI agents with screenshot grounding accuracy
agent-comparisonSide-by-side A/B agent comparison
rag-evaluationRAG retrieval relevance and citation accuracy
openai-evaluationOpenAI Chat API traces with tool calls
anthropic-evaluationClaude messages with tool_use blocks
swebench-evaluationCoding agents with patch correctness ratings
multi-agent-evaluationMulti-agent coordination (CrewAI, AutoGen, LangGraph)
web-agent-reviewPre-recorded web traces with step-by-step overlay viewer
web-agent-creationLive web browsing with automatic trace recording

Qualitative Data Analysis (QDA)

Potato isn't only for label-and-aggregate tasks — it also supports interpretive qualitative research, the kind of work done in tools like NVivo, ATLAS.ti, or MAXQDA, fully self-hosted and free.

CapabilityDescription
Living codebookThe codebook is an evolving markdown document of rules, definitions, examples, and rationales — not just a label list. Edit it in a full-page document view or inline while coding, with versioning, diff, and restore; semantic edits can re-flag affected excerpts for review (docs)
In-vivo codingCreate codes directly from a highlighted passage, in the participant's own words (example)
MemosAttach analytic notes to excerpts, codes, or the whole project as your interpretation develops (docs)
CasesGroup instances into units of analysis — participants, interviews, documents, sites — for case-based comparison (docs)
SearchFull-text search across your corpus and annotations to find, revisit, and code recurring patterns (docs)
Codebook distillationTurn the human-authored codebook into an LLM prompt for AI-assisted coding

Enable it with qda_mode, which sensibly cascades these features on; see the QDA Mode guide and the runnable qda-mode-example.


AI-Powered Annotation

LLM Label Suggestions

Integrate any LLM provider to pre-annotate instances and suggest labels. Annotators review and correct — dramatically faster than labeling from scratch.

Supported backends: OpenAI, Anthropic, Ollama, vLLM, Gemini, HuggingFace, OpenRouter

Active Learning

Potato reorders your annotation queue based on model uncertainty so annotators label the most informative instances first. Supports uncertainty sampling, BADGE, BALD, diversity, and hybrid strategies (docs).

Solo Mode

A human-LLM collaborative workflow where the system learns from annotator feedback and progressively transitions to autonomous LLM labeling as agreement improves (docs).

Chat Assistant

An LLM-powered sidebar where annotators can ask questions about difficult instances. The AI provides guidance informed by your task description and annotation guidelines — helping annotators think through decisions without auto-labeling (docs).


Quality Control & Workflows

Quality Assurance

FeatureDescription
Attention checksAutomatically inserted known-answer items to verify engagement
Gold standardsTrack annotator accuracy against expert labels
Inter-annotator agreementKrippendorff's alpha (general) and Cohen's kappa (step-level agent evaluation)
Training phasePractice annotations with feedback before the real task
Behavioral trackingTiming, click patterns, and annotation change history
PsychometricsLive IRT (multiclass GLAD, Whitehill et al. 2009) fit as annotations arrive: per-item label posteriors, annotator ability with standard errors, item difficulty, and discrimination flags for codebook bugs — no gold labels, no LLM (docs)
Boundary probingCounterfactual probes map each annotator's decision boundary; paraphrase-invariance flags inconsistency (docs)
Truth SerumSurprisingly-popular scoring (Prelec et al., Nature 2017): gold-free verdicts that beat majority vote on hard items, plus annotator calibration (docs)
Paper Modepython -m potato.paper config.yaml emits a compilable LaTeX dataset report — methods paragraphs, booktabs tables, IAA, limitations — ready to cut-paste (docs)
Think-Aloud ModeSpeak while you annotate: fully-local speech-to-text, verbatim rationale streams, labels committed by voice via rule-based phrase detection — no LLM (docs)

Annotation Workflows

WorkflowDescription
Multi-annotatorMultiple annotators per item with overlap control and agreement metrics
AdjudicationExpert review of annotator disagreements to produce gold labels (docs)
Solo modeHuman-LLM collaboration with progressive automation (docs)
CrowdsourcingProlific and MTurk integration with platform-specific auth (docs)
TriageRapid accept/reject/skip for data curation (docs)
Multiplayer RoomsLive shared sessions: norming (blind vote → reveal → discuss, with blind vs. post-discussion α), huddle (walk current disagreements together), and shadow (trainees watch the host annotate) (docs)
Pocket ModeAnnotate from your phone: installable PWA with a card-stack UI, one-tap labeling, and offline annotation that syncs on reconnect (docs)

Continuous Evaluation Loop

Close the loop from production traces to graded, regression-gated evaluation:

CapabilityDescription
CaptureInstrument any agent with the @traceable tracing SDK, or POST traces to the ingestion webhook
AutomateRules (filter → sample → actions) route incoming traces to queues, datasets, evaluators, or webhooks
CurateVersioned datasets & experiments + semantic search/slices to find what to review
EvaluateProgrammatic evaluators (trajectory match, tool-use, LLM-judge, heuristics) + a side-by-side model arena
GateRun evals in pytest and fail CI on score-threshold regressions
CalibrateLLM-judge ↔ human alignment with auto-calibration from human corrections; judges categorical, span, and free-text outputs

Authentication & Deployment

Potato supports multiple authentication methods, from passwordless quick-start to enterprise SSO:

MethodUse Case
In-memoryLocal development, quick studies
Password + file persistenceTeam annotation with shared credential files (docs)
DatabaseProduction deployments with SQLite or PostgreSQL (docs)
OAuth / SSOGoogle, GitHub, or institutional OIDC login (docs)
ClerkManaged authentication via Clerk.com (docs)
PasswordlessLow-stakes tasks where ease of access matters (docs)

Passwords are hashed with per-user PBKDF2-SHA256 salts. Admins can reset passwords via CLI (potato reset-password) or REST API. Self-service token-based reset is also available.


Example Projects

Ready-to-use templates organized by type in examples/:

CategoryExamples
ClassificationRadio, checkbox, Likert, slider, pairwise comparison
SpanNER, span linking, coreference, entity linking
Agent TracesLLM agents, web agents, RAG, multi-agent, code agents
AudioWaveform annotation, classification, ELAN-style tiered
VideoFrame-level labeling, temporal segments
ImageBounding boxes, PDF/document annotation
AdvancedSolo mode, adjudication, quality control, conditional logic
QDAQualitative analysis: living codebook, in-vivo coding, memos, cases
AI-AssistedLLM suggestions, Ollama integration
Custom LayoutsContent moderation, dialogue QA, medical review

Live Demos on HuggingFace

Try Potato in your browser — no installation. A growing catalog of one-click demo Spaces covers classification, span/NER, agent-trace evaluation, multimodal, QDA, and more:

Research Showcase

The Potato Showcase contains annotation projects from published research — sentiment analysis, dialogue evaluation, summarization, and more.


Documentation

Potato has two complementary doc sites: potatoannotator.com/docs for guides, tutorials, and higher-level walkthroughs, and Read the Docs for the complete, version-matched technical reference (every config option, the full HTTP API, and internals). The links below point to the guide pages.

TopicLink
Quick Startdocs/quick-start.md
Configuration Referencedocs/configuration/configuration.md
Schema Gallerydocs/annotation-types/schemas_and_templates.md
Agent Trace Evaluationdocs/agent-evaluation/agent_traces.md
Web Agent Annotationdocs/agent-evaluation/web_agent_annotation.md
Datasets & Experimentsdocs/agent-evaluation/datasets_and_experiments.md
Programmatic Evaluatorsdocs/agent-evaluation/evaluators.md
Automation Rulesdocs/agent-evaluation/automation_rules.md
CI Evaluation (pytest gating)docs/agent-evaluation/ci_evaluation.md
Model Arenadocs/agent-evaluation/model_arena.md
Semantic Curation (Catalog)docs/agent-evaluation/semantic_curation.md
Tracing SDK (potato_trace)docs/integrations/tracing_sdk.md
AI Supportdocs/ai-intelligence/ai_support.md
Using HuggingFace Modelsdocs/ai-intelligence/huggingface_models.md
Potato on HuggingFacedocs/data-export/potato_on_huggingface.md
Active Learningdocs/ai-intelligence/active_learning_guide.md
Solo Modedocs/solo-mode/solo_mode.md
Qualitative Data Analysis (QDA)docs/advanced/qda.md
Quality Controldocs/workflow/quality_control.md
Password Managementdocs/auth-users/password_management.md
SSO & OAuthdocs/auth-users/sso_authentication.md
Admin Dashboarddocs/administration/admin_dashboard.md
Crowdsourcingdocs/deployment/crowdsourcing.md
Export Formatsdocs/data-export/export_formats.md
Full Documentation Indexdocs/index.md

For coding agents

If you point Claude Code, Codex, or Cursor at Potato, give it these generated, machine-checkable specs rather than prose — they are built from the running code, so they cannot drift from it.

ArtifactWhat it gives you
llms.txtCurated index of the docs (llms.txt standard)
llms-full.txtEvery documentation page in one file
Config JSON SchemaAll 154 config keys, 56 annotation types, 23 display types — validates a config.yaml before the server runs
OpenAPI 3.1 specAll 390 HTTP paths, with per-operation auth and config gating

Every config in examples/ carries a # yaml-language-server: $schema=… modeline, so editors validate it live. See Machine-Readable Specs for editor setup, CI validation, and jq recipes.


Development

# Run tests
pytest tests/ -v

# By category
pytest tests/unit/ -v        # Unit tests (fast)
pytest tests/server/ -v      # Integration tests
pytest tests/selenium/ -v    # Browser tests

# With coverage
pytest --cov=potato --cov-report=html

See the Testing guide for which tier to write in, the test-file security rules, the annotation-persistence testing pattern, and the drift tests that keep the generated specs honest.


Support


License

Potato is free software, licensed under the GNU General Public License v3.0 or later (GPLv3+). You are free to use, study, modify, and redistribute it — including for commercial purposes — provided that any distributed derivative works are also licensed under the GPLv3+ and made available with their source code. See the LICENSE file for the full terms.


Citation

If you use Potato in your research, please cite the Potato 2.0 paper (ACL 2026 System Demonstrations):

@inproceedings{jurgens-etal-2026-potato,
    title = "Potato 2.0: A Comprehensive Annotation Platform with {AI}-in-the-Loop Support",
    author = "Jurgens, David  and
      Chen, Michael  and
      Iyer, Lina",
    editor = "Durrett, Greg  and
      Jian, Ping",
    booktitle = "Proceedings of the 64th Annual Meeting of the Association for Computational Linguistics (Volume 3: System Demonstrations)",
    month = jul,
    year = "2026",
    address = "San Diego, California, United States",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2026.acl-demo.37/",
    pages = "374--386",
    ISBN = "979-8-89176-392-0",
}

To reference the original Potato release, cite the Potato 1.0 paper (EMNLP 2022 System Demonstrations):

@inproceedings{pei-etal-2022-potato,
    title = "{POTATO}: The Portable Text Annotation Tool",
    author = "Pei, Jiaxin  and
      Ananthasubramaniam, Aparna  and
      Wang, Xingyao  and
      Zhou, Naitian  and
      Dedeloudis, Apostolos  and
      Sargent, Jackson  and
      Jurgens, David",
    editor = "Che, Wanxiang  and
      Shutova, Ekaterina",
    booktitle = "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing: System Demonstrations",
    month = dec,
    year = "2022",
    address = "Abu Dhabi, UAE",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2022.emnlp-demos.33/",
    doi = "10.18653/v1/2022.emnlp-demos.33",
    pages = "327--337",
}