Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[formrecognizer] Add migration guide #20960

Merged
merged 17 commits into from
Oct 1, 2021
Merged
Prev Previous commit
Next Next commit
fix links
  • Loading branch information
catalinaperalta committed Oct 1, 2021
commit 41dc88f45d767799c5ca31e99f0accb7282f7c87
12 changes: 6 additions & 6 deletions sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

This guide is intended to assist in the migration to `azure-ai-formrecognizer (3.2.x)` from versions `3.1.x` and below. It will focus on side-by-side comparisons for similar operations between versions. Please note that version `3.2.0b1` will be used for comparison with `3.1.2`.

Familiarity with `azure-ai-formrecognizer (3.1.x and below)` package is assumed. For those new to the Azure Form Recognizer client library for Python please refer to the [README](README) rather than this guide.
Familiarity with `azure-ai-formrecognizer (3.1.x and below)` package is assumed. For those new to the Azure Form Recognizer client library for Python please refer to the [README](readme) rather than this guide.

## Table of Contents
- [Migration benefits](#migration-benefits)
@@ -560,7 +560,7 @@ print("-----------------------------------")
### Training a custom model
Copy link
Member Author

@catalinaperalta catalinaperalta Sep 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI that I used training here since this guide is for users who are using the old version and moving to the new one. Within the text I do mention build, but this was on purpose.

Also, I'm aware that I used analyzing above (I felt that one was not too far a leap from recognizing), but let me know if I should unify terms to those used in a certain version


Differences between the versions:
- Files for building a new model for version `3.2.x` can be created using the labeling tool found [here](fr-labeling-tool).
- Files for building a new model for version `3.2.x` can be created using the labeling tool found [here](fr_labeling_tool).
- In version `3.1.x` the `use_training_labels` kwarg was used to indicate whether to use labeled data was when creating the custom model.
catalinaperalta marked this conversation as resolved.
Show resolved Hide resolved
- In version `3.2.x` the `use_training_labels` kwargs is not supported since training must be carried out with labeled training documents. In order to extract key-value pairs from a document, please refer to the prebuilt model "prebuilt-document" which extracts entities, key-value pairs, and layout from a document.
catalinaperalta marked this conversation as resolved.
Show resolved Hide resolved
- When using the latest service API version `2021-09-30-preview` models no longer include submodels, instead a model can analyze different document types.
catalinaperalta marked this conversation as resolved.
Show resolved Hide resolved
@@ -623,8 +623,8 @@ for name, doc_type in model.doc_types.items():

catalinaperalta marked this conversation as resolved.
Show resolved Hide resolved
## Additional samples

For additional samples please take a look at the [Form Recognizer Samples](Samples-README) for more guidance.
For additional samples please take a look at the [Form Recognizer Samples](samples_readme) for more guidance.

[README]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/README.md
[Samples-README]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/README.md
[fr-labeling-tool]: https://aka.ms/azsdk/formrecognizer/labelingtool
[readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/README.md
[samples_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/README.md
[fr_labeling_tool]: https://aka.ms/azsdk/formrecognizer/labelingtool