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
dulv4-2022.4.0.tar.gz
contains information about all dulv4 models included in the 2022.4.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.
- 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 dulv4-2022.4.1.tar.gz
, at installation time you need to rename it as du-ondemand.tar.gz
.
- For Windows machines, directly download through the bundle link and rename the file to
du-ondemand.tar.gz
- 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.4.1/dulv4-2022.4.1.tar.gz'
- 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/
- 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 dulv4
(latest version)
dulv4
(latest version)The dulv4 offline bundle needs to be installed for the ML Packages in the table below.
ML Packages | Model version | Metadata |
---|---|---|
UiPathDocumentOCR | 22.4.0 | Here |
UiPathDocumentOCR_CPU | 22.4.0 Preview | Here |
DocumentUnderstanding | 22.4.1 | Here |
DocumentClassifier | 22.4.0 | Here |
Invoices | 22.4.1 | Here |
InvoicesAustralia | 22.4.1 | Here |
InvoicesIndia | 22.4.1 | Here |
InvoicesJapan | 22.4.1 Preview | Here |
InvocesChina | 22.4.1 Preview | Here |
Receipts | 22.4.1 | Here |
PurchaseOrders | 22.4.1 | Here |
UtilityBills | 22.4.1 | Here |
IDCards | 22.4.1 Preview | Here |
Passports | 22.4.1 | Here |
RemittanceAdvices | 22.4.1 Preview | Here |
DeliveryNotes | 22.4.1 Preview | Here |
W2 | 22.4.1 Preview | Here |
W9 | 22.4.1 | Here |
ACORD125 | 22.4.1 Preview | Here |
I9 | 22.4.1 Preview | Here |
990 | 22.4.1 Preview | Here |
4506T | 22.4.1 Preview | Here |
FM1003 | 22.4.1 Preview | Here |
Offline bundle DUHWOCR
(latest version)
DUHWOCR
(latest version)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 Package | Model version | Metadata |
---|---|---|
HandwritingRecognitionOCR Only for DU installed in the AI Center standalone environment | 21.4.0 | Here |
Offline bundle dulv3
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 Package | Model version | Metadata |
---|---|---|
UiPathDocumentOCR_CPU | 22.2.4 Preview | Here |
DocumentUnderstanding | 21.10.10 | Here |
DocumentClassifier | 21.10.10 | Here |
Invoices | 21.10.10 | Here |
InvoicesAustralia | 21.10.10 | Here |
InvoicesIndia | 21.10.10 | Here |
InvoicesJapan | 21.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 |
W9 | 21.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
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 Package | Model version | Metadata |
---|---|---|
UiPathDocumentOCR | 21.10.3 | Here |
DocumentUnderstanding | 21.5.6 | Here |
DocumentClassifier | 21.5.6 | Here |
Invoices | 21.5.6 | Here |
InvoicesAustralia | 21.5.6 | Here |
InvoicesIndia | 21.5.6 | Here |
InvoicesJapan | 21.5.6 Preview | Here |
Receipts | 21.5.6 Preview | Here |
PurchaseOrders | 21.5.6 | Here |
UtilityBills | 21.5.6 Preview | Here |
IDCards | 21.5.6 Preview | Here |
Passports | 21.5.6 Preview | Here |
The Handwriting Recognition OCR base image is used for the Handwriting service in Automation Suite.
Updated about a month ago