added snowflake steps for configuring zingg - #1365
Merged
Padam Prakash (padam-prakash) merged 5 commits intoAug 13, 2026
Merged
Conversation
Comment on lines
+489
to
+606
| Set the blocking strategy directly after `setLabelDataSampleSize`. If not set, the model follows `DEFAULT`. | ||
|
|
||
| #### JSON | ||
|
|
||
| ```json | ||
| { | ||
| "modelId": "100", | ||
| "zinggDir": "/tmp/models", | ||
| "numPartitions": 4, | ||
| "labelDataSampleSize": 0.5 | ||
| } | ||
| ``` | ||
|
|
||
| ### Step 2: Define fields with `EFieldDefinition` | ||
|
|
||
| #### JSON | ||
|
|
||
| ```json | ||
| "fieldDefinition":[ | ||
| { | ||
| "fieldName" : "recid", | ||
| "matchType" : "dont_use", | ||
| "fields" : "recid", | ||
| "dataType": "string" , | ||
| "primaryKey": "true" | ||
| }, | ||
| { | ||
| "fieldName" : "givenname", | ||
| "matchType" : "fuzzy", | ||
| "fields" : "givenname", | ||
| "dataType": "string" | ||
| }, | ||
| { | ||
| "fieldName" : "surname", | ||
| "matchType": "exact", | ||
| "fields" : "surname", | ||
| "dataType": "string" | ||
| }, | ||
| { | ||
| "fieldName" : "suburb", | ||
| "matchType": "fuzzy", | ||
| "fields" : "suburb", | ||
| "dataType": "string" | ||
| }, | ||
| { | ||
| "fieldName" : "postcode", | ||
| "matchType": "exact", | ||
| "fields" : "postcode", | ||
| "dataType": "string" | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| {% hint style="info" icon="right-long" %} | ||
| Enterprise requires a primary key field for `runIncremental`. Mark the primary key field by adding `"primaryKey": "true"` if you plan to use incremental matching. | ||
| {% endhint %} | ||
|
|
||
| ### Step 3: Configure input and output pipes | ||
|
|
||
| #### JSON | ||
|
|
||
| ```json | ||
| "output" : [{ | ||
| "name":"output_Febrl_5M", | ||
| "format":"snowflake", | ||
| "props": { | ||
| "table": "OUTPUT_Febrl_5M" | ||
| } | ||
| }], | ||
| "data" : [{ | ||
| "name":"FEBRL5M", | ||
| "format":"snowflake", | ||
| "props": { | ||
| "table": "Febrl_5M" | ||
| } | ||
| }], | ||
| ``` | ||
|
|
||
| ### Step 4: Deterministic matching (optional) | ||
|
|
||
| {% hint style="info" icon="right-long" %} | ||
| Deterministic matching - **Enterprise** only. | ||
|
|
||
| Skip this step if you only need probabilistic matching. | ||
| {% endhint %} | ||
|
|
||
| #### JSON | ||
|
|
||
| ```json | ||
| { | ||
| "deterministicMatching": [ | ||
| {"matchCondition": [ | ||
| {"fieldName": "fname"}, | ||
| {"fieldName": "stNo"}, | ||
| {"fieldName": "add1"} | ||
| ]}, | ||
| {"matchCondition": [ | ||
| {"fieldName": "fname"}, | ||
| {"fieldName": "dob"}, | ||
| {"fieldName": "ssn"} | ||
| ]}, | ||
| {"matchCondition": [ | ||
| {"fieldName": "fname"}, | ||
| {"fieldName": "email"} | ||
| ]} | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ### Step 5: Output stats (optional) | ||
|
|
||
| {% hint style="info" icon="right-long" %} | ||
| Output stats - **Enterprise** only. | ||
|
|
||
| Skip this step if you do not need run statistics. | ||
| {% endhint %} | ||
|
|
||
| Configures where Zingg writes statistics for the `match` and `incrementalRun` phases. The `$ZINGG_DYNAMIC_STAT_NAME` placeholder is substituted at runtime with `SUMMARY`, `CLUSTER`, or `RECORD`, so each run writes the three statistics tables separately. If `outputStats` is not configured, Zingg skips stats writing and the run proceeds normally. |
Collaborator
There was a problem hiding this comment.
keep all this info very short and concise here. they should be in detail at their own pages
Contributor
Author
There was a problem hiding this comment.
Pls re-confirm if you want me to trim, as this was written by someone else before me.
| }, | ||
| ``` | ||
|
|
||
| **Read more:** For the fields in each statistics table → [Output Statistics](../interpreting-results/output-statistics.md). |
Collaborator
There was a problem hiding this comment.
remove this
Contributor
Author
There was a problem hiding this comment.
I don't think we should
Comment on lines
+620
to
+626
| **Read more:** For the fields in each statistics table → [Output Statistics](../interpreting-results/output-statistics.md). | ||
|
|
||
| ### Step 6: Pass Through (optional) | ||
|
|
||
| {% hint style="info" icon="right-long" %} | ||
| Pass Through - **Enterprise** only. | ||
|
|
Collaborator
There was a problem hiding this comment.
keep this info very short
Contributor
Author
There was a problem hiding this comment.
It is exact same as it is present in enterprise tab
Contributor
Author
There was a problem hiding this comment.
Pls re-confirm if you want me to trim in both the tabs.
| ``` | ||
|
|
||
| Enterprise adds blocking model configuration via `args.setBlockingModel()`. Set this in Configure Zingg before running `train`. | ||
|
|
Collaborator
There was a problem hiding this comment.
why this info here ?
Contributor
Author
There was a problem hiding this comment.
I'll add json version of this
Aditya Pareek (LOGANBLUE1)
requested a review
from Padam Prakash (padam-prakash)
August 13, 2026 05:53
|
|
||
| Enterprise Snowflake also provides the `findAndLabel` combined phase, which runs `findTrainingData` and `label` together in a single call. Use this for smaller datasets where `findTrainingData` completes quickly: | ||
| <!-- | ||
| #### JSON |
Collaborator
There was a problem hiding this comment.
remove any unnecessary comments
|
|
||
| {% tab title="Enterprise Snowflake" %} | ||
| **CHECK WITH SONAL ABOUT THIS TOPIC - NEEDS ENTIRELY DIFFERENT SET OF CONTENT TO BE DISCUSSED LATER.** | ||
| ### Set label data sample size |
Collaborator
There was a problem hiding this comment.
do we need this ??
|
|
||
| ```bash | ||
| ./scripts/zingg.sh --phase generateDocs --conf <location to conf.json> \ | ||
| --showConcise=true --properties-file <location to snowflake.properties> |
Collaborator
There was a problem hiding this comment.
showConcise is optional. check older version
|
|
||
| #### CLI | ||
|
|
||
| ```json |
Collaborator
There was a problem hiding this comment.
json or bash?
| ``` | ||
|
|
||
| {% hint style="info" icon="right-long" %} | ||
| The `--originalZinggId` flag takes the path to your original production config file. Despite the flag name, you are passing the **configuration file** that defined the original model - Zingg uses that config to locate the original output containing the Zingg IDs to be preserved. |
Collaborator
There was a problem hiding this comment.
remove this info
|
|
||
| ```json | ||
| { | ||
| "config" : "configSnow.json", |
Collaborator
There was a problem hiding this comment.
configSnow.json-> add some info about this that it is the config of prev executed match
| ./scripts/zingg.sh --phase verifyBlocking --conf config.json \ | ||
| --properties-file <location to snowflake.properties> | ||
| ``` | ||
| {% endtab %} |
Collaborator
There was a problem hiding this comment.
https://www.zingg.ai/docs/home/0.7.0/stepbystep/verifyblocking#the-verifyblocking-phase-is-run-as-follows
It has some more info regarding SF
Padam Prakash (padam-prakash)
requested changes
Aug 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.