Skip to content

Commit 8f49415

Browse files
authored
Merge pull request #234589 from aahill/ta4h-article-fixes-2
adding ta4h references + commented blocks
2 parents 7a50e62 + f2fbdb8 commit 8f49415

File tree

19 files changed

+74
-68
lines changed

19 files changed

+74
-68
lines changed

articles/cognitive-services/language-service/custom-text-analytics-for-health/concepts/data-formats.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Your Labels file should be in the `json` format below to be used when importing
147147
| `prebuilts` | `MedicationName` | The name of the prebuilt component populating the prebuilt entity. [Prebuilt entities](../../text-analytics-for-health/concepts/health-entity-categories.md) are automatically loaded into your project by default but you can extend them with list components in your labels file. | `MedicationName` |
148148
| `documents` | | Array containing all the documents in your project and list of the entities labeled within each document. | [] |
149149
| `location` | `{DOCUMENT-NAME}` | The location of the documents in the storage container. Since all the documents are in the root of the container this should be the document name.|`doc1.txt`|
150-
| `dataset` | `{DATASET}` | The test set to which this file goes to when split before training. <!--Learn more about data splitting [here](../how-to/train-model.md#data-splitting).--> Possible values for this field are `Train` and `Test`. |`Train`|
150+
| `dataset` | `{DATASET}` | The test set to which this file goes to when split before training. Learn more about data splitting [here](../how-to/train-model.md#data-splitting). Possible values for this field are `Train` and `Test`. |`Train`|
151151
| `regionOffset` | | The inclusive character position of the start of the text. |`0`|
152152
| `regionLength` | | The length of the bounding box in terms of UTF16 characters. Training only considers the data in this region. |`500`|
153153
| `category` | | The type of entity associated with the span of text specified. | `Entity1`|
@@ -166,4 +166,4 @@ Your Labels file should be in the `json` format below to be used when importing
166166
## Next steps
167167
* You can import your labeled data into your project directly. Learn how to [import project](../how-to/create-project.md#import-project)
168168
* See the [how-to article](../how-to/label-data.md) more information about labeling your data.
169-
<!--* When you're done labeling your data, you can [train your model](../how-to/train-model.md).-->
169+
* When you're done labeling your data, you can [train your model](../how-to/train-model.md).

articles/cognitive-services/language-service/custom-text-analytics-for-health/concepts/evaluation-metrics.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.custom: language-service-custom-ta4h
1515

1616
# Evaluation metrics for custom Text Analytics for health models
1717

18-
<!--Your [dataset is split](../how-to/train-model.md#data-splitting) into two parts: a set for training, and a set for testing. The training set is used to train the model, while the testing set is used as a test for model after training to calculate the model performance and evaluation. The testing set is not introduced to the model through the training process, to make sure that the model is tested on new data.-->
18+
Your [dataset is split](../how-to/train-model.md#data-splitting) into two parts: a set for training, and a set for testing. The training set is used to train the model, while the testing set is used as a test for model after training to calculate the model performance and evaluation. The testing set is not introduced to the model through the training process, to make sure that the model is tested on new data.
1919

2020
Model evaluation is triggered automatically after training is completed successfully. The evaluation process starts by using the trained model to predict user defined entities for documents in the test set, and compares them with the provided data labels (which establishes a baseline of truth). The results are returned so you can review the model’s performance. User defined entities are **included** in the evaluation factoring in Learned and List components; Text Analytics for health prebuilt entities are **not** factored in the model evaluation. For evaluation, custom Text Analytics for health uses the following metrics:
2121

@@ -149,7 +149,5 @@ Similarly,
149149
## Next steps
150150

151151
* [Custom text analytics for health overview](../overview.md)
152-
<!--
153152
* [View a model's performance in Language Studio](../how-to/view-model-evaluation.md)
154-
* [Train a model](../how-to/train-model.md)
155-
-->
153+
* [Train a model](../how-to/train-model.md)

articles/cognitive-services/language-service/custom-text-analytics-for-health/how-to/label-data.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Data labeling is a crucial step in development lifecycle. In this step, you lab
2222
Before you can label your data, you need:
2323

2424
* A successfully [created project](create-project.md) with a configured Azure blob storage account
25-
<!--* Text data that [has been uploaded](design-schema.md#data-preparation) to your storage account.-->
25+
* Text data that [has been uploaded](design-schema.md#data-preparation) to your storage account.
2626

2727
See the [project development lifecycle](../overview.md#project-development-lifecycle) for more information.
2828

@@ -34,7 +34,7 @@ As you label your data, keep in mind:
3434

3535
* You can't add labels for Text Analytics for health entities as they're pretrained prebuilt entities. You can only add labels to new entity categories that you defined during schema definition.
3636

37-
<!--If you want to improve the recall for a prebuilt entity, you can extend it by adding a list component while you are [defining your schema](design-schema.md).-->
37+
If you want to improve the recall for a prebuilt entity, you can extend it by adding a list component while you are [defining your schema](design-schema.md).
3838

3939
* In general, more labeled data leads to better results, provided the data is labeled accurately.
4040

@@ -83,7 +83,7 @@ Use the following steps to label your data:
8383

8484
6. In the right side pane under the **Labels** pivot you can find all the entity types in your project and the count of labeled instances per each. The prebuilt entities will be shown for reference but you will not be able to label for these prebuilt entities as they are pretrained.
8585

86-
7. In the bottom section of the right side pane you can add the current document you are viewing to the training set or the testing set. By default all the documents are added to your training set. <!--Learn more about [training and testing sets](train-model.md#data-splitting) and how they are used for model training and evaluation.-->
86+
7. In the bottom section of the right side pane you can add the current document you are viewing to the training set or the testing set. By default all the documents are added to your training set. See [training and testing sets](train-model.md#data-splitting) for information on how they are used for model training and evaluation.
8787

8888
> [!TIP]
8989
> If you are planning on using **Automatic** data splitting, use the default option of assigning all the documents into your training set.
@@ -107,6 +107,4 @@ You cannot delete any of the Text Analytics for health pretrained entities becau
107107

108108
## Next steps
109109

110-
[Custom text analytics for health overview](../overview.md)
111-
112-
<!--After you've labeled your data, you can begin [training a model](train-model.md) that will learn based on your data.-->
110+
After you've labeled your data, you can begin [training a model](train-model.md) that will learn based on your data.

articles/cognitive-services/language-service/custom-text-analytics-for-health/how-to/view-model-evaluation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Before viewing model evaluation, you need:
2828
* A successfully [created project](create-project.md) with a configured Azure blob storage account.
2929
* Text data that [has been uploaded](design-schema.md#data-preparation) to your storage account.
3030
* [Labeled data](label-data.md)
31-
<!--* A [successfully trained model](train-model.md)-->
31+
* A [successfully trained model](train-model.md)
3232

3333

3434
## Model details
@@ -72,5 +72,5 @@ There are several metrics you can use to evaluate your mode. See the [performanc
7272

7373
## Next steps
7474

75-
<!--* [Deploy your model](deploy-model.md)-->
75+
* [Deploy your model](deploy-model.md)
7676
* Learn about the [metrics used in evaluation](../concepts/evaluation-metrics.md).

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/language-studio/test-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To test your deployed models from within the [Language Studio](https://aka.ms/La
2121

2222
5. Click on **Run the test** from the top menu.
2323

24-
6. In the **Result** tab, you can see the extracted entities from your text and their types. You can also view the JSON response under the **JSON** tab. <!--[learn more](../rest-api/get-results.md#response-body) about the structure of the JSON response.-->
24+
6. In the **Result** tab, you can see the extracted entities from your text and their types. You can also view the [JSON response](../../how-to/call-api.md#get-task-results) under the **JSON** tab.
2525

2626
:::image type="content" source="../../media/test-model-results.png" alt-text="A screenshot showing the deployment testing screen in Language Studio." lightbox="../../media/test-model-results.png":::
2727

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/language-studio/train-model.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ To start training your model from within the [Language Studio](https://aka.ms/La
2020

2121
:::image type="content" source="../../media/train-model.png" alt-text="A screenshot showing the training job creation screen in Language Studio." lightbox="../../media/train-model.png":::
2222

23-
4. Select data splitting method. You can choose **Automatically splitting the testing set from training data** where the system will split your labeled data between the training and testing sets, according to the specified percentages. Or you can **Use a manual split of training and testing data**, this option is only enabled if you have added documents to your testing set.
24-
25-
<!-- see [data labeling](../../how-to/tag-data.md) and [how to train a model](../../how-to/train-model.md#data-splitting) for information about data splitting. -->
23+
4. Select data splitting method. You can choose **Automatically splitting the testing set from training data** where the system will split your labeled data between the training and testing sets, according to the specified percentages. Or you can **Use a manual split of training and testing data**, this option is only enabled if you have added documents to your testing set. See [data labeling](../../how-to/label-data.md) and [how to train a model](../../how-to/train-model.md#data-splitting) for information about data splitting.
2624

2725
5. Click on the **Train** button.
2826

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/quickstarts/language-studio.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ ms.author: aahi
1919
2020
## Create a new Azure Language resource and Azure storage account
2121

22-
Before you can use custom Text Analytics for health, you'll need to create an Azure Language resource, which will give you the credentials that you need to create a project and start training a model. You'll also need an Azure storage account, where you can upload your dataset that will be used to build your model.
22+
Before you can use custom Text Analytics for health, you need to create an Azure Language resource, which will give you the credentials that you need to create a project and start training a model. You'll also need an Azure storage account, where you can upload your dataset that is used to build your model.
2323

2424
> [!IMPORTANT]
2525
> To quickly get started, we recommend creating a new Azure Language resource using the steps provided in this article. Using the steps in this article will let you create the Language resource and storage account at the same time, which is easier than doing it later.
2626
>
27-
<!-- If you have a pre-existing resource that you'd like to use, you will need to connect it to storage account. See [guidance to using a pre-existing resource](../../how-to/create-project.md#using-a-pre-existing-language-resource) for information.
28-
-->
27+
> If you have a pre-existing resource that you'd like to use, you will need to connect it to storage account. For more information, see [guidance to using a pre-existing resource](../../how-to/create-project.md#using-a-pre-existing-language-resource).
28+
2929
[!INCLUDE [create a new resource from the Azure portal](../resource-creation-azure-portal.md)]
3030

3131
> [!div class="nextstepaction"]

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/quickstarts/rest-api.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@ Before you can use custom Text Analytics for health, you'll need to create an Az
2222

2323
> [!IMPORTANT]
2424
> To get started quickly, we recommend creating a new Azure Language resource using the steps provided in this article, which will let you create the Language resource, and create and/or connect a storage account at the same time, which is easier than doing it later.
25+
>
26+
> If you have a pre-existing resource that you'd like to use, you will need to connect it to storage account. See [create project](../../how-to/create-project.md#using-a-pre-existing-language-resource) for more information.
2527
26-
<!--
27-
> If you have a pre-existing resource that you'd like to use, you will need to connect it to storage account. See [create project](../../how-to/create-project.md#using-a-pre-existing-language-resource) for information.
28-
-->
2928
[!INCLUDE [create a new resource from the Azure portal](../resource-creation-azure-portal.md)]
3029

3130
> [!div class="nextstepaction"]

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/rest-api/create-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ Use the following JSON in your request. Replace the placeholder values below wit
5757
|Key |Placeholder|Value | Example |
5858
|---------|---------|---------|--|
5959
| projectName | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `myProject` |
60-
| language | `{LANGUAGE-CODE}` | A string specifying the language code for the documents used in your project. If your project is a multilingual project, choose the language code of the majority of the documents. <!--See [language support](../../language-support.md) to learn more about supported language codes.--> |`en-us`|
60+
| language | `{LANGUAGE-CODE}` | A string specifying the language code for the documents used in your project. If your project is a multilingual project, choose the language code of the majority of the documents. See [language support](../../language-support.md) to learn more about supported language codes. |`en-us`|
6161
| projectKind | `CustomHealthcare` | Your project kind. | `CustomHealthcare` |
62-
| multilingual | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily included in your training documents. <!--See [language support](../../language-support.md) to learn more about multilingual support.--> | `true`|
62+
| multilingual | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily ones included in your training documents). See [language support](../../language-support.md) to learn more about multilingual support. | `true`|
6363
| storageInputContainerName | `{CONTAINER-NAME` | The name of your Azure storage container where you have uploaded your documents. | `myContainer` |
6464

6565

articles/cognitive-services/language-service/custom-text-analytics-for-health/includes/rest-api/get-results.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ The response is a JSON document with the following parameters
270270
}
271271

272272
```
273-
<!--
273+
274274
|Key|Sample Value|Description|
275275
|--|--|--|
276276
|entities|[]|An array containing all the extracted entities.|
@@ -280,12 +280,11 @@ The response is a JSON document with the following parameters
280280
|text|`first entity`| The text that was extracted for a specific entity.|
281281
|category|`MedicationName`| The name of the entity type or category corresponding to the extracted text.|
282282
|confidenceScore|`0.9`| A number denoting the model's certainty level of the extracted entity ranging from 0 to 1 with higher number denoting higher certainty.|
283-
|assertion|`certainty`| [Assertions](../../../text-analytics-for-health/concepts/assertion-detection.md) associated with the extracted entity. Assertions are only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
284-
|name|`Ibuprofen`| The normalized name for the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
285-
|links| [] | An array containing all the results from the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
286-
|dataSource| `UMLS` | The reference standard resulting from the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
287-
|id| `C0020740` | The reference code resulting from the [entity linking](../../../text-analytics-for-health/includes/features.md#entity-linking) associated with the extracted entity belonging to the extracted data source. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
283+
|assertion|`certainty`| [Assertions](../../../text-analytics-for-health/concepts/assertion-detection.md) associated with the extracted entity. Assertions are only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features).|
284+
|name|`Ibuprofen`| The normalized name for the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
285+
|links| [] | An array containing all the results from the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
286+
|dataSource| `UMLS` | The reference standard resulting from the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
287+
|ID| `C0020740` | The reference code resulting from the [entity linking](../../../text-analytics-for-health/overview.md?tabs=entity-linking#text-analytics-for-health-features) associated with the extracted entity belonging to the extracted data source. Entity linking is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
288288
|relations| [] | Array containing all the extracted relationships. [Relationship extraction](../../../text-analytics-for-health/concepts/relation-extraction.md) is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
289289
|relationType| `DosageOfMedication` | The category of the extracted [relationship](../../../text-analytics-for-health/concepts/relation-extraction.md). Relationship extraction is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
290290
|entities| `"Dosage", "Medication"` | The entities associated with the extracted relationship. Relationship extraction is only supported for prebuilt [Text Analytics for health entities](../../../text-analytics-for-health/concepts/health-entity-categories.md).|
291-
-->

0 commit comments

Comments
 (0)