SyncTrainingBatches

Documents are typically processed in multiple different 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 in a different project or environment, you will need to transfer your trained models to that project or environment using the SyncTrainingBatches command. Only models that have a higher quality than those already present in the target  project or environment will be transferred. The SyncTrainingBatches command can also be used to transfer document images that have been used for training.

Important! If the version of a Document Definition in the source project does not match the version of the same Document Definition in the target project, no documents corresponding to the Document Definition in the source project will be copied into the target project. This may happen when a Document Definition has been updated in the source project but not in the target project, or when an older Document Definition has been deleted from the target project but not from the source project. For the correct operation of the SyncTrainingBatches command, the versions of the Document Definitions in the source and target projects must be identical.

Parameters

/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 will be 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 will be 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 will be 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.

Important! The /BatchIDs parameter and the /DeleteBatchesMissedInSource flag are mutually exclusive. If both are specified, an error message will be displayed.

/CopyTrainingSamples Flag

Copies the contents of a training batch.

By default, if the batches are identical (i.e. if the have the same GUID), the contents of the training batch will not be copied. This can be changed using the ForceSync flag (see below for more information).

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 (i.e. the batch specified in the /target parameter) any batches missing in the source batch (i.e. the batch specified in the /source parameter). If batches are deleted, a corresponding entry will be added into the log.

Important! The /BatchIDs parameter and the /DeleteBatchesMissedInSource flag are mutually exclusive. If both are specified, an error message will be 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

11/15/2022 10:12:44 AM

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.