Zingg Command Line
The two CLI invocation patterns and copy-paste commands for every Zingg phase for Docker, local Spark, EMR, and CI/CD environments.
The CLI lets you invoke Zingg phases from any environment that has a terminal - Docker containers, local Spark installations, AWS EMR clusters, or CI/CD pipelines. No notebook required.
You can pass a JSON configuration file directly or point the CLI at a Python program to run. This means you can run Zingg Python programs through zingg.sh just as easily as JSON-configured jobs - the CLI is not a replacement for the Python API; it is the runtime that executes both.
The Two Invocation Patterns
Pass a JSON config file
./scripts/zingg.sh <optional --properties-file path to zingg.conf> --phase <phase> --conf <path to json>Run a Python program
./scripts/zingg.sh <optional --properties-file path to zingg.conf> --run <path to python program>Find training pairs
./scripts/zingg.sh --phase findTrainingData --conf config.jsonLabel pairs
The --showConcise=true flag shows only fields used for matching and hides DONT_USE fields.
./scripts/zingg.sh --phase label --conf config.json --showConcise=trueTrain the model
./scripts/zingg.sh --phase train --conf config.jsonRun match
match finds duplicates within a single dataset.
./scripts/zingg.sh --phase match --conf config.jsonRun link
link matches records across two separate datasets.
./scripts/zingg.sh --phase link --conf config.jsonFind training pairs
./scripts/zingg.sh --phase findTrainingData --conf config.jsonLabel pairs
./scripts/zingg.sh --phase label --conf config.json --showConcise=trueGenerate model documentation
Optional but recommended before train — lets you inspect training data quality before committing to the train phase.
./scripts/zingg.sh --phase generateDocs --conf config.jsonTrain the model
./scripts/zingg.sh --phase train --conf config.jsonRun match
./scripts/zingg.sh --phase match --conf config.jsonRun link
./scripts/zingg.sh --phase link --conf config.jsonRun incremental
Updates the identity graph with new and changed records without re-running the full match.
Last updated
Was this helpful?