Subscribe

UiPath Document Understanding

UiPath Document Understanding

ML Packages Offline Installation

All ML Packages are provided as a .zip file which is uploaded directly as a Custom Package in AI Center. To download the models, contact your Account Manager, CSM, or Support to receive a download link per package.
ML packages with v2022.10.0 or higher and that also have an AI Center v2022.10.0 or higher, can be deployed in an offline environment by using only the associated bundle and its metadata.
All Out-of-the-box Pre-trained ML Packages share the same bundle (dusemistructured2210-2022.10.0.tar.gz).

Getting Started

Here's what you need for running a successfully offline installation of an ML Package in AI Center.

  • Download the needed du bundle. Here are the links for all the available du bundles. The du bundle contains information about all models included into a specific version. For example, the dusemistructured2210-2022.10.0.tar.gz contains information about all out-of-the-box pre-trained ML Packages included in the 2022.10.0 version.
  • Download the needed out-of-the-box model package (eg.: Invoices, Receipts, PurchaseOrders, etc.). Link needs to be provided by your Account Manager, CSM, or Support.

Install the offline bundle

Offline installations are requiring that the downloaded du bundle to be renamed in the command line into du-ondemand.tar.gz. For instance, if you downloaded the du bundle named dusemistructured2210-2022.10.0.tar.gz, at installation time you need to rename it as du-ondemand.tar.gz.

  1. For Windows machines, directly download through the bundle link and rename the file to du-ondemand.tar.gz
  2. For Linux machines, from the machine having access to the internet, download the needed bundle following the below command:
wget -O ~/<bundle-name.tar.gz> 'bundle-link'

Here's an example of how to download the needed bundle for Linux:

wget -O ~/du-ondemand.tar.gz 'https://download.uipath.com/automation-suite/2022.10.0/dusemistructured2210-2022.10.0.tar.gz'
  1. Copy the following bundle to the /uipath/tmp folder on the main machine of the cluster (where the install took place):
scp ~/<bundle-name.tar.gz> <username>@<node dns>:/uipath/tmp/
  1. Connect to this main machine and load the bundle:
./configureUiPathAS.sh registry upload --optional-offline-bundle "/uipath/tmp/du.tar.gz" --offline-tmp-folder "/uipath/tmp"

Upload the model to AI Center

After downloading and installing the models, follow the steps described here to upload them to AI Center.

Offline bundles

Each offline bundle contains base images used by multiple ML Packages. To make sure which bundle to download for a certain model version, check their compatibility.

Offline bundle for UiPathDocumentOCR dudococr2210-2022.10.0.tar.gz

The UiPathDocumentOCR offline bundle needs to be installed for the ML Packages in the table below.

ML PackagesModel versionMetadata
UiPathDocumentOCR22.10.0Here

Offline bundle for UiPathDocumentOCR_CPU dudococrcpu2210-2022.10.0.tar.gz

The UiPathDocumentOCR_CPU offline bundle needs to be installed for the ML Packages in the table below.

ML PackagesModel versionMetadata
UiPathDocumentOCR_CPU22.10.0 (latest version)Here

Offline bundle for OCR for Chinese, Japanese, Korean ducjkocr-2022.10.0.tar.gz

The CJKOCR offline bundle needs to be installed for the ML Packages in the table below. This bundle can be used only on a CPU VM.

If you want to enable Chinese, Japanese, Korean OCR in an offline environment, you also need to follow these steps.

ML PackagesModel versionMetadata
OCR for Chinese, Japanese, Korean22.10.0 (latest version)N/A

Offline bundle for Document Classifier duclassifier2210-2022.10.0.tar.gz

The Document Classifier offline bundle needs to be installed for the ML Packages in the table below.

ML PackagesModel versionMetadata
DocumentClassifier22.10.0Here

v2022.10.0 Offline bundle for Out-of-the-box Pre-trained ML Packages dusemistructured2210-2022.10.0.tar.gz

The Out-of-the-box Pre-trained ML Packages offline bundle needs to be installed for the ML Packages in the table below.

ML PackagesModel versionMetadata
DocumentUnderstanding22.10.0 Here
Invoices22.10.0 Here
InvoicesAustralia22.10.0 Here
InvoicesIndia22.10.0 Here
InvoicesJapan22.10.0 Preview Here
InvocesChina22.10.0 Preview Here
Receipts22.10.0 Here
PurchaseOrders22.10.0 Here
UtilityBills22.10.0 Here
IDCards22.10.0 Here
Passports22.10.0 Here
RemittanceAdvices22.10.0 Here
BillsOfLading22.10.0 Here
W222.10.0 Here
W922.10.0 Here
ACORD12522.10.0 Here
I922.10.0 Here
99022.10.0 Preview Here
4506T22.10.0 Here
FM100322.10.0 Preview Here
ACORD2522.10.0 Here
ACORD131 22.10.0 Here
ACORD126 22.10.0 Here
ACORD140 22.10.0 Here
1040 22.10.0 Here
Checks 22.10.0 Here
Bank Statements 22.10.0 Here
Financial statements 22.10.0 Here
Packing Lists 22.10.0 Here
Vehicle Titles 22.10.0 Here

v2022.10.2 Offline bundle for Out-of-the-box Pre-trained ML Packages dusemistructured2210-2022.10.2.tar.gz

The Out-of-the-box Pre-trained ML Packages offline bundle needs to be installed for the ML Packages in the table below.

ML PackagesModel versionMetadata
DocumentUnderstanding22.10.2 Here
Invoices22.10.2 Here
InvoicesAustralia22.10.2 Here
InvoicesIndia22.10.2 Here
InvoicesJapan22.10.2 Preview Here
InvocesChina22.10.2 Preview Here
Receipts22.10.2 Here
PurchaseOrders22.10.0 Here
UtilityBills22.10.2 Here
IDCards22.10.2 Here
Passports22.10.2 Here
RemittanceAdvices22.10.2 Here
BillsOfLading22.10.2 Here
W222.10.2 Here
W922.10.2 Here
ACORD12522.10.2 Here
I922.10.2 Here
99022.10.2 Preview Here
4506T22.10.2 Here
FM100322.10.2 Preview Here
ACORD2522.10.2 Here
ACORD131 22.10.2 Here
ACORD126 22.10.2 Here
ACORD140 22.10.2 Here
1040 22.10.2 Here
Checks 22.10.2 Here
Bank Statements 22.10.2 Here
Financial statements 22.10.2 Here
Packing Lists 22.10.2 Here
Vehicle Titles 22.10.2 Here

Offline bundle DUHWOCR

The DUHWOCR offline bundle needs to be installed only for the HandwritingRecognitionOCR ML Package 21.4.0 and it applies only to AI Center standalone environment.

ML PackageModel versionMetadata
HandwritingRecognitionOCR
Only for DU installed in the AI Center standalone environment
21.4.0 Here

Offline bundle dulv4 (latest version)

The dulv4 offline bundle needs to be installed only if you want to use ML Packages from the 2022.4.0 enterprise release with AI Center version 2022.4.

ML Packages table
ML PackagesModel versionMetadata
UiPathDocumentOCR22.4.0 Here
UiPathDocumentOCR_CPU22.4.0 Preview Here
DocumentUnderstanding22.4.1 Here
DocumentClassifier22.4.0 Here
Invoices22.4.1 Here
InvoicesAustralia22.4.1 Here
InvoicesIndia22.4.1 Here
InvoicesJapan22.4.1 Preview Here
InvocesChina22.4.1 Preview Here
Receipts22.4.1 Here
PurchaseOrders22.4.1 Here
UtilityBills22.4.1 Here
IDCards22.4.1 Preview Here
Passports22.4.1 Here
RemittanceAdvices22.4.1 Preview Here
DeliveryNotes22.4.1 Preview Here
W222.4.1 Preview Here
W922.4.1 Here
ACORD12522.4.1 Preview Here
I922.4.1 Preview Here
99022.4.1 Preview Here
4506T22.4.1 Preview Here
FM100322.4.1 Preview Here

Offline bundle dulv3

The dulv3 offline bundle needs to be installed only if you want to use ML Packages from the 2021.10 enterprise release with AI Center version 2022.4.

ML Packages table

ML PackageModel versionMetadata
UiPathDocumentOCR_CPU22.2.4 Preview Here
DocumentUnderstanding21.10.10 Here
DocumentClassifier21.10.10 Here
Invoices21.10.10 Here
InvoicesAustralia 21.10.10 Here
InvoicesIndia 21.10.10 Here
InvoicesJapan21.10.11 Preview Here
InvocesChina 21.10.10 Preview Here
Receipts 21.10.10 Preview Here
PurchaseOrders 21.10.10 Here
UtilityBills 21.10.10 Preview Here
IDCards 21.10.10 Preview Here
Passports 21.10.10 Preview Here
RemittanceAdvices 21.10.10 Preview Here
DeliveryNotes 21.10.10 Preview Here
W2 21.10.10 Preview Here
W921.10.10 Preview Here
FormExtractor
Only for DU installed in the AI Center standalone environment
21.7.18 Here
IntelligentFormExtractor
Only for DU installed in the AI Center standalone environment
21.7.18 Here
IntelligentKeywordClassifier
Only for DU installed in the AI Center standalone environment
21.7.18 Here
HandwritingRecognitionOCR
Only for DU installed in the AI Center standalone environment
21.4.0 Here

Offline bundle dulv2

The dulv2 offline bundle needs to be installed only if you want to use ML Packages from the 2021.10 enterprise release with AI Center version 2022.4.

ML Packages table

ML PackageModel versionMetadata
UiPathDocumentOCR21.10.3 Here
DocumentUnderstanding21.5.6 Here
DocumentClassifier21.5.6 Here
Invoices21.5.6 Here
InvoicesAustralia21.5.6 Here
InvoicesIndia21.5.6 Here
InvoicesJapan21.5.6 Preview Here
Receipts21.5.6 Preview Here
PurchaseOrders21.5.6 Here
UtilityBills21.5.6 Preview Here
IDCards21.5.6 Preview Here
Passports21.5.6 Preview Here

The Handwriting Recognition OCR base image is used for the Handwriting service in Automation Suite.

Updated a day ago


ML Packages Offline Installation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.