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. You will receive a download link per package.

The ML models also need a dedicated bundle to be installed before they can be used.

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 du2110.tar.gz contains information about all dulv3 models included in the 2021.10 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.
  • Retrieve the metadata file for the previously downloaded out-of-the-box model package (eg.: Invoices, Receipts, PurchaseOrders, etc.). This metadata file defines the model's settings. Here you can find all the available metadata files.

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 du2110.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 'wget -O ~/du-ondemand.tar.gz https://download.uipath.com/automation-suite/du2110.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:
./install-uipath.sh -i ./input.json -o ./output.json --optional-offline-bundle "/uipath/du2110.tar.gz" --offline-tmp-folder "/uipath/tmp" --accept-license-agreement

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

Offline bundle dulv3

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

ML PackageVersion in AI Center 21.10Model versionMetadata
UiPathDocumentOCR_CPU122.2.4 Preview Here
DocumentUnderstanding921.10.10 Here
DocumentClassifier421.10.10 Here
Invoices921.10.10 Here
InvoicesAustralia 821.10.10 Here
InvoicesIndia 821.10.10 Here
InvoicesJapan621.10.11 Preview Here
InvocesChina 121.10.10 Preview Here
Receipts 921.10.10 Preview Here
PurchaseOrders 821.10.10 Here
UtilityBills 821.10.10 Preview Here
IDCards 221.10.10 Preview Here
Passports 221.10.10 Preview Here
RemittanceAdvices 121.10.10 Preview Here
DeliveryNotes 121.10.10 Preview Here
W2 121.10.10 Preview Here
W9121.10.10 Preview Here
FormExtractor
Only for DU installed in the AI Center standalone environment
221.7.18 Here
IntelligentFormExtractor
Only for DU installed in the AI Center standalone environment
221.7.18 Here
IntelligentKeywordClassifier
Only for DU installed in the AI Center standalone environment
221.7.18 Here
HandwritingRecognitionOCR
Only for DU installed in the AI Center standalone environment
321.4.0 Here

Offline bundle dulv2

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

ML PackageVersion in AI Center 21.10Model versionMetadata
UiPathDocumentOCR621.10.3 Here
DocumentUnderstanding821.5.6 Here
DocumentClassifier321.5.6 Here
Invoices821.5.6 Here
InvoicesAustralia721.5.6 Here
InvoicesIndia721.5.6 Here
InvoicesJapan521.5.6 Preview Here
Receipts821.5.6 Preview Here
PurchaseOrders721.5.6 Here
UtilityBills721.5.6 Preview Here
IDCards121.5.6 Preview Here
Passports121.5.6 Preview Here

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

Updated 2 months 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.