SyncTrainingBatches - ABBYY Documentation

Documents are typically processed in several projects or environments. At the same time, you will usually have one project or environment where images are accumulated and models are trained. To use training results elsewhere, transfer your trained models with the SyncTrainingBatches command. Only models of higher quality than those already in the target are transferred. The command can also transfer the document images used for training.

SyncTrainingBatches needs identical Document Definition versions in the source and target projects.

Where the versions differ, no documents belonging to that Document Definition are copied. Two situations cause the mismatch:

A Document Definition was updated in the source project but not in the target project.
An older Document Definition was deleted from the target project but not from the source project.

Parameters

Parameter	Type	Description
`/Source`	Required	The project from which the training batches should be copied.
`/Target`	Required	The project to which the training batches should be copied.
`/SourceTenant`	Optional	The tenant containing the source project.
`/TargetTenant`	Optional	The tenant where the project should be updated.
`/SourceU`	Optional	User name. If no user name is specified, Windows authentication is used.
`/SourceP`	Optional	Password.
`/SourceCert`	Optional	Certificate thumbprint used for mutual SSL authentication on the server of the source project. This key is used to pass an encoded certificate hash for a server with Mutual SSL installed as a string.
`/TargetU`	Optional	User name. If no user name is specified, Windows authentication is used.
`/TargetP`	Optional	Password.
`/TargetCert`	Optional	Certificate thumbprint used for mutual SSL authentication on the server of the target project. This key is used to pass an encoded certificate hash for a server with Mutual SSL installed as a string.
`/CopyTrainingBatches`	Optional	Copies the training batches. Possible values are `All`, `LayoutOnly`, `ClassifierOnly`, or `None`. By default, this parameter is set to `All`.
`/BatchIDs`	Optional	The IDs of the batches that should be synchronized. If no batch IDs are specified, all the training batches are synchronized. If some batch IDs are specified, the `/CopyTrainingBatches` parameter should be set to either `LayoutOnly` or `ClassifierOnly` to avoid duplicate batch IDs, as different collections may contain identical batch IDs. The `/BatchIDs` parameter and the `/DeleteBatchesMissedInSource` flag are mutually exclusive. If both are specified, an error message is displayed.
`/CopyTrainingSamples`	Flag	Copies the contents of a training batch. By default, if the batches are identical (that is, if they have the same GUID), the contents of the training batch are not copied. The `/ForceSync` flag overrides this. The contents of a batch are copied only if the batch itself is copied.
`/ForceSync`	Flag	Disables the training quality check and copies a training batch even if the quality of the new model is worse than that of the existing model.
`/DeleteBatchesMissedInSource`	Flag	Deletes from the target batch (that is, the batch specified in the `/Target` parameter) any batches missing in the source batch (that is, the batch specified in the `/Source` parameter). If batches are deleted, a corresponding entry is added into the log. The `/BatchIDs` parameter and the `/DeleteBatchesMissedInSource` flag are mutually exclusive. If both are specified, an error message is displayed.

Example of use

SyncTrainingBatches /Source="https://FCSRV/1/SingleEntryPoint" /Target=D:\Projects\SingleEntryPoint /SourceU=user /SourceP=password /ForceSync /CopyTrainingBatches=LayoutOnly /BatchIDs=1,2,3,4 – Copies the listed field extraction training batches to a local project, skipping the training quality check

​Parameters

​Example of use

Parameters

Example of use