Skip to content

Commit d71d6ed

Browse files
authored
Merge pull request #100097 from PatrickFarley/formre-updates
[cog serv] Formre updates
2 parents 263a729 + 4171fb5 commit d71d6ed

File tree

3 files changed

+26
-13
lines changed

3 files changed

+26
-13
lines changed

articles/cognitive-services/form-recognizer/quickstarts/curl-train-extract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2727
To complete this quickstart, you must have:
2828
- Access to the Form Recognizer limited-access preview. To get access to the preview, fill out and submit the [Form Recognizer access request](https://aka.ms/FormRecognizerRequestAccess) form.
2929
- [cURL](https://curl.haxx.se/windows/) installed.
30-
- A set of at least five forms of the same type. You will use this data to train the model. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) for this quickstart. Upload the training files to the root of a blob storage container in an Azure Storage account.
30+
- A set of at least five forms of the same type. You will use this data to train the model. Your forms can be of different file types but must be the same type of document. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) for this quickstart. Upload the training files to the root of a blob storage container in an Azure Storage account.
3131

3232
## Create a Form Recognizer resource
3333

articles/cognitive-services/form-recognizer/quickstarts/label-tool.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2323
To complete this quickstart, you must have:
2424
- Access to the Form Recognizer limited-access preview. To get access to the preview, fill out and submit the [Form Recognizer access request form](https://aka.ms/FormRecognizerRequestAccess). You'll receive an email with a link to create a Form Recognizer resource.
2525
- Access to the Form Recognizer sample labeling tool. To get access, fill out and submit the [Form Recognizer label tool request form](https://aka.ms/LabelToolRequestAccess). You'll receive an email with instructions on how to obtain your credentials and access the private container registry.
26-
- A set of at least six forms of the same type. You will use this data to train the model and test a form. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) for this quickstart. Upload the training files to the root of a blob storage container in an Azure Storage account.
26+
- A set of at least six forms of the same type. You'll use this data to train the model and test a form. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) for this quickstart. Upload the training files to the root of a blob storage container in an Azure Storage account.
2727

2828
## Set up the sample labeling tool
2929

3030
You'll use the Docker engine to run the sample labeling tool. Follow these steps to set up the Docker container. For a primer on Docker and container basics, see the [Docker overview](https://docs.docker.com/engine/docker-overview/).
31-
1. First, install Docker on a host computer. This can be your local computer ([Windows](https://docs.docker.com/docker-for-windows/), [MacOS](https://docs.docker.com/docker-for-mac/), or [Linux](https://docs.docker.com/install/)). Or, you can use a Docker hosting service in Azure, such as the [Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/index), [Azure Container Instances](https://docs.microsoft.com/azure/container-instances/index), or a Kubernetes cluster [deployed to an Azure Stack](https://docs.microsoft.com/azure-stack/user/azure-stack-solution-template-kubernetes-deploy?view=azs-1910). The host computer must meet the following hardware requirements:
31+
1. First, install Docker on a host computer. The host computer can be your local computer ([Windows](https://docs.docker.com/docker-for-windows/), [MacOS](https://docs.docker.com/docker-for-mac/), or [Linux](https://docs.docker.com/install/)). Or, you can use a Docker hosting service in Azure, such as the [Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/index), [Azure Container Instances](https://docs.microsoft.com/azure/container-instances/index), or a Kubernetes cluster [deployed to an Azure Stack](https://docs.microsoft.com/azure-stack/user/azure-stack-solution-template-kubernetes-deploy?view=azs-1910). The host computer must meet the following hardware requirements:
3232
| Container | Minimum | Recommended|
3333
|:--|:--|:--|
3434
|Sample labeling tool|2 core, 4-GB memory|4 core, 8-GB memory
@@ -45,14 +45,14 @@ You'll use the Docker engine to run the sample labeling tool. Follow these steps
4545
```
4646
docker run -it -p 3000:80 containerpreview.azurecr.io/microsoft/cognitive-services-form-recognizer-custom-supervised-labeltool eula=accept
4747
```
48-
This will make the sample labeling tool available through a web browser. Go to [https://localhost:3000](https://localhost:3000).
48+
This command will make the sample labeling tool available through a web browser. Go to [http://localhost:3000](http://localhost:3000).
4949
5050
> [!NOTE]
5151
> You can also label documents and train models using the Form Recognizer REST API. To train and Analyze with the REST API, see [Train with labels using the REST API and Python](./python-labeled-data.md).
5252
5353
## Set up input data
5454
55-
First, make sure all the training documents are of the same format. If you have forms in multiple formats, organize them into sub-folders based on common format. When you train, you'll need to direct the API to a sub-folder.
55+
First, make sure all the training documents are of the same format. If you have forms in multiple formats, organize them into subfolders based on common format. When you train, you'll need to direct the API to a subfolder.
5656
5757
### Configure cross-domain resource sharing (CORS)
5858
@@ -73,7 +73,7 @@ The sample labeling tool connects to a source (where your original forms are) an
7373
7474
Connections can be set up and shared across projects. They use an extensible provider model, so you can easily add new source/target providers.
7575
76-
To create a new connection, click the **New Connections** (plug) icon, in the left hand navigation bar.
76+
To create a new connection, click the **New Connections** (plug) icon, in the left navigation bar.
7777
7878
Fill in the fields with the following values:
7979
@@ -88,9 +88,9 @@ Fill in the fields with the following values:
8888
In the sample labeling tool, projects store your configurations and settings. Create a new project and fill in the fields with the following values:
8989
9090
* **Display Name** - the project display name
91-
* **Security Token** - Some project settings can include sensitive values, such as API keys or other shared secrets. Each project will generate a security token that can be used to encrypt/decrypt sensitive project settings. Security tokens can be found in Application Settings by clicking the gear icon in the lower corner of the left hand navigation bar.
92-
* **Source Connection** - The Azure Blob Storage connection you created in the previous step which you would like to use for this project.
93-
* **Folder Path** - Optional - If your source forms are located in a folder on the blob container please specify the folder name here
91+
* **Security Token** - Some project settings can include sensitive values, such as API keys or other shared secrets. Each project will generate a security token that can be used to encrypt/decrypt sensitive project settings. Security tokens can be found in Application Settings by clicking the gear icon in the lower corner of the left navigation bar.
92+
* **Source Connection** - The Azure Blob Storage connection you created in the previous step that you would like to use for this project.
93+
* **Folder Path** - Optional - If your source forms are located in a folder on the blob container, specify the folder name here
9494
* **Form Recognizer Service Uri** - Your Form Recognizer endpoint URL.
9595
* **API Key** - Your Form Recognizer subscription key.
9696
* **Description** - Optional - Project description
@@ -130,9 +130,9 @@ Follow the above steps to label five of your forms, and then move on to the next
130130
131131
## Train a custom model
132132
133-
Click the Train icon (the train car) on the left pane to open the Training page. Then click the **Train** button to begin training the model. Once the training process completes you'll see the following information:
133+
Click the Train icon (the train car) on the left pane to open the Training page. Then click the **Train** button to begin training the model. Once the training process completes, you'll see the following information:
134134
135-
* **Model ID** - The ID of the model that was just created and trained. Each training call creates a new model with its own ID. Copy this string to a secure location; you'll need it if you want to do prediction calls through the REST API.
135+
* **Model ID** - The ID of the model that was created and trained. Each training call creates a new model with its own ID. Copy this string to a secure location; you'll need it if you want to do prediction calls through the REST API.
136136
* **Average Accuracy** - The model's average accuracy. You can improve model accuracy by labeling additional forms and training again to create a new model. We recommend starting by labeling five forms and adding more forms as needed.
137137
* The list of tags, and the estimated accuracy per tag.
138138
@@ -154,7 +154,20 @@ Click on the Predict (rectangles) icon on the left to test your model. Upload a
154154
155155
Depending on the reported accuracy, you may want to do further training to improve the model. After you've done a prediction, examine the confidence values for each of the applied tags. If the average accuracy training value was high, but the confidence scores are low (or the results are inaccurate), you should add the file used for prediction into the training set, label it, and train again.
156156
157-
The reported average accuracy, confidence scores, and actual accuracy can be inconsistent when the documents being analyzed are different from those used in training. Keep in mind that some documents look similar when viewed by people but can look distinct to the AI model. For example, you might train with a form type that has two variations, where the training set consists of 20% variation A and 80% variation B. During prediction, the confidence for documents of variation A are likely to be lower.
157+
The reported average accuracy, confidence scores, and actual accuracy can be inconsistent when the documents being analyzed are different from those used in training. Keep in mind that some documents look similar when viewed by people but can look distinct to the AI model. For example, you might train with a form type that has two variations, where the training set consists of 20% variation A and 80% variation B. During prediction, the confidence scores for documents of variation A are likely to be lower.
158+
159+
## Save a project and resume later
160+
161+
To resume your project at another time or in another browser, you need to save your project's security token and reenter it later.
162+
163+
### Get project credentials
164+
Go to your project settings page (slider icon) and take note of the security token name. Then go to your application settings (gear icon), which shows all of the security tokens in your current browser instance. Find your project's security token and copy its name and key value to a secure location.
165+
166+
### Restore project credentials
167+
When you want to resume your project, you first need to create a connection to the same blob storage container. Follow the steps above to do this. Then, go to the application settings page (gear icon) and see if your project's security token is there. If it isn't, add a new security token and copy over your token name and key from the previous step. Then click Save Settings.
168+
169+
### Resume a project
170+
Finally, go to the main page (house icon) and click Open Cloud Project. Then select the blob storage connection, and select your project's *.vott* file. The application will load all of the project's settings because it has the security token.
158171
159172
## Next steps
160173

articles/cognitive-services/form-recognizer/quickstarts/python-train-extract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2727
To complete this quickstart, you must have:
2828
- Access to the Form Recognizer limited-access preview. To get access to the preview, fill out and submit the [Form Recognizer access request](https://aka.ms/FormRecognizerRequestAccess) form.
2929
- [Python](https://www.python.org/downloads/) installed (if you want to run the sample locally).
30-
- A set of at least five forms of the same type. You will use this data to train the model. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) for this quickstart. Upload the training files to the root of a blob storage container in an Azure Storage account.
30+
- A set of at least five forms of the same type. You will use this data to train the model. Your forms can be of different file types but must be the same type of document. You can use a [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) for this quickstart. Upload the training files to the root of a blob storage container in an Azure Storage account.
3131

3232
## Create a Form Recognizer resource
3333

0 commit comments

Comments
 (0)