UiPath Documentation
document-understanding
2021.10
false
Document Understanding User Guide

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'
    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'
    wget -O ~/du-ondemand.tar.gz 'wget -O ~/du-ondemand.tar.gz https://download.uipath.com/automation-suite/du2110.tar.gz'
    
  3. 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/
    scp ~/<bundle-name.tar.gz> <username>@<node dns>:/uipath/tmp/
    
  4. 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
    ./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 PreviewHere
DocumentUnderstanding921.10.10Here
DocumentClassifier421.10.10Here
Invoices921.10.10Here
InvoicesAustralia821.10.10Here
InvoicesIndia821.10.10Here
InvoicesJapan621.10.11 PreviewHere
InvocesChina121.10.10 PreviewHere
Receipts921.10.10 PreviewHere
PurchaseOrders821.10.10Here
UtilityBills821.10.10 PreviewHere
IDCards221.10.10 PreviewHere
Passports221.10.10 PreviewHere
RemittanceAdvices121.10.10 PreviewHere
DeliveryNotes121.10.10 PreviewHere
W2121.10.10 PreviewHere
W9121.10.10 PreviewHere
FormExtractor

Only for DU installed in the AI Center standalone environment
221.7.18Here
IntelligentFormExtractor

Only for DU installed in the AI Center standalone environment
221.7.18Here
IntelligentKeywordClassifier

Only for DU installed in the AI Center standalone environment
221.7.18Here
HandwritingRecognitionOCR

Only for DU installed in the AI Center standalone environment
321.4.0Here

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.3Here
DocumentUnderstanding821.5.6Here
DocumentClassifier321.5.6Here
Invoices821.5.6Here
InvoicesAustralia721.5.6Here
InvoicesIndia721.5.6Here
InvoicesJapan521.5.6 PreviewHere
Receipts821.5.6 PreviewHere
PurchaseOrders721.5.6Here
UtilityBills721.5.6 PreviewHere
IDCards121.5.6 PreviewHere
Passports121.5.6 PreviewHere

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

  • Getting Started​
  • Install the Offline Bundle​
  • Upload the Model to AI Center​
  • Offline Bundles​
  • Offline Bundle Dulv3​
  • Offline Bundle Dulv2​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated