- Getting Started
- Framework Components
- ML Packages
- Pipelines
- Data Manager
- OCR Services
- Document Understanding deployed in Automation Suite
- Install and Use
- First Run Experience
- Deploy UiPathDocumentOCR
- Deploy an Out-of-the-box ML Package
- ML Packages Offline Installation
- Use Data Manager
- Use the Framework
- Document Understanding deployed in AI Center standalone
- Deep Learning
- Licensing
- References
- UiPath.Abbyy.Activities
- UiPath.AbbyyEmbedded.Activities
- UiPath.DocumentUnderstanding.ML.Activities
- UiPath.DocumentUnderstanding.OCR.LocalServer.Activities
- UiPath.IntelligentOCR.Activities
- UiPath.OCR.Activities
- UiPath.OCR.Contracts
- UiPath.DocumentProcessing.Contracts
- UiPath.OmniPage.Activities
- UiPath.PDF.Activities
ML Packages Offline Installation
.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.
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.
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
.
- 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'
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' -
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/ -
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
After downloading and installing the models, follow the steps described here to upload them to AI Center.
The dulv3 offline bundle needs to be installed for the ML Packages in the table below.
ML Package |
Version in AI Center 21.10 |
Model version |
Metadata |
---|---|---|---|
UiPathDocumentOCR_CPU |
1 |
22.2.4
Preview | |
DocumentUnderstanding |
9 |
21.10.10 | |
DocumentClassifier |
4 |
21.10.10 | |
Invoices |
9 |
21.10.10 | |
InvoicesAustralia |
8 |
21.10.10 | |
InvoicesIndia |
8 |
21.10.10 | |
InvoicesJapan |
6 |
21.10.11
Preview | |
InvocesChina |
1 |
21.10.10
Preview | |
Receipts |
9 |
21.10.10
Preview | |
PurchaseOrders |
8 |
21.10.10 | |
UtilityBills |
8 |
21.10.10
Preview | |
IDCards |
2 |
21.10.10
Preview | |
Passports |
2 |
21.10.10
Preview | |
RemittanceAdvices |
1 |
21.10.10
Preview | |
DeliveryNotes |
1 |
21.10.10
Preview | |
W2 |
1 |
21.10.10
Preview | |
W9 |
1 |
21.10.10
Preview | |
FormExtractor Only for DU installed in the AI Center standalone environment |
2 |
21.7.18 | |
IntelligentFormExtractor Only for DU installed in the AI Center standalone environment |
2 |
21.7.18 | |
IntelligentKeywordClassifier Only for DU installed in the AI Center standalone environment |
2 |
21.7.18 | |
HandwritingRecognitionOCR Only for DU installed in the AI Center standalone environment |
3 |
21.4.0 |
The dulv2 offline bundle needs to be installed for the ML Packages in the table below.
ML Package |
Version in AI Center 21.10 |
Model version |
Metadata |
---|---|---|---|
UiPathDocumentOCR |
6 |
21.10.3 | |
DocumentUnderstanding |
8 |
21.5.6 | |
DocumentClassifier |
3 |
21.5.6 | |
Invoices |
8 |
21.5.6 | |
InvoicesAustralia |
7 |
21.5.6 | |
InvoicesIndia |
7 |
21.5.6 | |
InvoicesJapan |
5 |
21.5.6
Preview | |
Receipts |
8 |
21.5.6
Preview | |
PurchaseOrders |
7 |
21.5.6 | |
UtilityBills |
7 |
21.5.6
Preview | |
IDCards |
1 |
21.5.6
Preview | |
Passports |
1 |
21.5.6
Preview |
The Handwriting Recognition OCR base image is used for the Handwriting service in Automation Suite.
Here you can find all the Document Understanding released versions and their corresponding offline bundle links.
The 2021.10.0 release version and its patches can be found here.