[FR] Samples for DMAC #24300

maririos · 2021-09-29T00:18:13Z

To avoid conflicts I removed all code snippets from the main Readme and I renamed some of the snippets to include V3 at the end. I want to make sure I don't use them by mistake.

This PR has async samples. After this PR I will create the sync ones and the respective .md files.

azure-sdk · 2021-09-29T00:26:41Z

API changes have been detected in this PR. You can review API changes here

kinelski

Very straightforward. LGTM.

kinelski · 2021-09-29T17:43:09Z

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample_BuildModelAsyncs.cs

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.


File name has a typo: Asyncs

Changos!!!!

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/SampleSnippets.cs

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample_CreateComposedModelAsync.cs

azure-sdk · 2021-09-29T18:39:03Z

API changes have been detected in this PR. You can review API changes here

samvaity · 2021-09-29T18:37:45Z

sdk/formrecognizer/Azure.AI.FormRecognizer/README.md

@@ -402,191 +210,23 @@ For more information and samples using prebuilt models see:
 ### Train a Model


Build a Model ?

I am not making modifications to the Readme in this PR. Will do in a future PR

samvaity · 2021-09-29T18:38:03Z

sdk/formrecognizer/Azure.AI.FormRecognizer/README.md

@@ -402,191 +210,23 @@ For more information and samples using prebuilt models see:
 ### Train a Model
 Train a machine-learned model on your own form types. The resulting model will be able to recognize values from the types of forms it was trained on.


We should be changing this line too

I am not making modifications to the Readme in this PR. Will do in a future PR

samvaity · 2021-09-29T18:38:24Z

sdk/formrecognizer/Azure.AI.FormRecognizer/README.md

-        Console.WriteLine($"      Lower left => X: {selectionMark.BoundingBox[3].X}, Y= {selectionMark.BoundingBox[3].Y}");
-    }
-}
-```
 For more information and samples see [here][recognize_content].

 ### Recognize Custom Forms


Analyze Custom Documents

I am not making modifications to the Readme in this PR. Will do in a future PR

samvaity · 2021-09-29T18:39:05Z

sdk/formrecognizer/Azure.AI.FormRecognizer/README.md

@@ -185,121 +185,11 @@ The following section provides several code snippets illustrating common pattern
 ### Recognize Content
 Recognize text, tables, and selection marks like radio buttons and check boxes data, along with their bounding box coordinates, from documents.

-```C# Snippet:FormRecognizerSampleRecognizeContentFromUri


Will you be adding samples in a later PR?

Yes. When I work on the Readme, I will add the real samples here

samvaity · 2021-09-29T18:40:12Z

sdk/formrecognizer/Azure.AI.FormRecognizer/samples/V3/Sample7_CopyCustomModel.md

@@ -20,7 +20,7 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
 ### Source client
 The source client that contains the custom model we want to copy.

-```C# Snippet:FormRecognizerSampleCreateCopySourceClient
+```C# Snippet:FormRecognizerSampleCreateCopySourceClientV3


I am not sure if V3 would be appropriate, should we use the date version for the folder name?
And would that be enough without having to append the V3 in FormRecognizerSampleCreateCopySourceClientV3 ?

in this case, V3 is reflecting the SDK version. It is following the structure we talked about of having samples in V3 folder and current samples in either a V4 folder or in the main samples folder.

Although snippet strings are internal to us, they are the way for us to know where the code for the sample lives. We have also modified the samples code and moved all "old" samples to a V3 folder
https://github.com/Azure/azure-sdk-for-net/tree/feature/formrecognizerv4/sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples

Do you think this is clear enough for future developers to know which code/snippet/sample, lives where?

Hmm... I feel v3 or v4 is awkward since we havent used these terms before. Could we use similar wording as what python did v3.1 and v3.2-beta

Do you think this would be better?

I like it! I will change it to v3.1 everywhere to make it more clear. I will do it in the next PR to keep this one "small-ish"

samvaity

Do we need samples for get/list operations?

maririos · 2021-09-29T18:53:09Z

Do we need samples for get/list operations?

Great point. I will add them here

azure-sdk · 2021-09-29T19:31:19Z

API changes have been detected in this PR. You can review API changes here

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample_ManageOperationsAsync.cs

check-enforcer · 2021-09-29T20:26:30Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them. In order to bootstrap pipelines for a new service, please perform following steps:

For data-plane/track 2 SDKs Issue the following command as a pull request comment:

/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run net - [service] - ci

For track 1 management-plane SDKs

Please open a separate PR and to your service SDK path in this file. Once that PR has been merged, you can re-run the pipeline to trigger the verification.

azure-sdk · 2021-09-29T20:26:39Z

API changes have been detected in this PR. You can review API changes here

samples for DMAC

4b9d64d

maririos requested a review from kinelski September 29, 2021 00:18

maririos requested a review from annelo-msft as a code owner September 29, 2021 00:18

ghost added the Cognitive - Form Recognizer label Sep 29, 2021

maririos requested review from samvaity, catalinaperalta, kristapratico, witemple-msft and bojunehsu September 29, 2021 00:18

kinelski approved these changes Sep 29, 2021

View reviewed changes

oops

489e97a

samvaity reviewed Sep 29, 2021

View reviewed changes

add model operations async sample

f6d415b

maririos requested a review from samvaity September 29, 2021 19:27

samvaity approved these changes Sep 29, 2021

View reviewed changes

sdk/formrecognizer/Azure.AI.FormRecognizer/tests/samples/Sample_ManageOperationsAsync.cs Outdated Show resolved Hide resolved

modify name of operations samples

86aa36e

maririos merged commit b2677e6 into Azure:feature/formrecognizerv4 Sep 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FR] Samples for DMAC #24300

[FR] Samples for DMAC #24300

maririos commented Sep 29, 2021

azure-sdk commented Sep 29, 2021

kinelski left a comment

kinelski Sep 29, 2021

maririos Sep 29, 2021

azure-sdk commented Sep 29, 2021

samvaity Sep 29, 2021

maririos Sep 29, 2021

samvaity Sep 29, 2021

maririos Sep 29, 2021

samvaity Sep 29, 2021

maririos Sep 29, 2021

samvaity Sep 29, 2021

maririos Sep 29, 2021

samvaity Sep 29, 2021

maririos Sep 29, 2021

samvaity Sep 29, 2021

maririos Sep 29, 2021

samvaity left a comment

maririos commented Sep 29, 2021

azure-sdk commented Sep 29, 2021

check-enforcer bot commented Sep 29, 2021

azure-sdk commented Sep 29, 2021

		@@ -0,0 +1,57 @@
		// Copyright (c) Microsoft Corporation. All rights reserved.

		@@ -402,191 +210,23 @@ For more information and samples using prebuilt models see:
		### Train a Model

		@@ -402,191 +210,23 @@ For more information and samples using prebuilt models see:
		### Train a Model
		Train a machine-learned model on your own form types. The resulting model will be able to recognize values from the types of forms it was trained on.

[FR] Samples for DMAC #24300

[FR] Samples for DMAC #24300

Conversation

maririos commented Sep 29, 2021

azure-sdk commented Sep 29, 2021

kinelski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azure-sdk commented Sep 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samvaity left a comment

Choose a reason for hiding this comment

maririos commented Sep 29, 2021

azure-sdk commented Sep 29, 2021

check-enforcer bot commented Sep 29, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

For data-plane/track 2 SDKs Issue the following command as a pull request comment:

For track 1 management-plane SDKs

azure-sdk commented Sep 29, 2021