--- title: Named Entity Recognition type: templates category: Natural Language Processing cat: natural-language-processing order: 201 meta_title: Text Named Entity Recognition Data Labeling Template meta_description: Template for performing named entity recognition on text with Label Studio for your machine learning and data science projects. ---If you want to perform named entity recognition (NER) on a sample of text, use this template. This template supports overlapping text spans and very large documents. https://app.humansignal.com/b/MTk5" target="_blank" rel="noopener" aria-label="Open in Label Studio" style="all:unset;cursor:pointer;display:inline-flex;align-items:center;justify-content:center;border-radius:4px;border:1px solid rgb(109,135,241);padding:8px 12px;background:rgb(87 108 193);color:white;font-weight:500;font-family:sans-serif;gap:6px;transition:background 0.2s ease;" onmouseover="this.style.background='rgb(97 122 218)'" onmouseout="this.style.background='rgb(87 108 193)'"> Open in Label Studio ## Interactive Template Preview ## Labeling Configuration ```html
``` ## About the labeling configuration All labeling configurations must be wrapped in [View](/tags/view.html) tags. Use the Labels control tag to specify the relevant NER labels to apply to various text spans: ```xml ``` Use the `background` parameter with the Label control tag to specify a CSS color for the label. Use the Text object tag to specify the text data: ```xml ``` ## Enhance this template You can enhance this template in many ways. ### Display labels on the left If you want to modify the appearance of the labeling interface, you can use styling on the [View](/tags/view.html) tag. In this example, display the NER labels to the left of the text to be labeled. Start by setting the entire labeling interface display to flex: ```xml ``` Then use a different [View](/tags/view.html) tag to wrap the labels. Because the labels are listed before the text, they appear on the left side of the interface. ```xml ``` The styling on this tag sets a width for the section of the interface with the labels, adds a right margin between the labels and the text, adds padding around the labels, and a background color for this section of the interface. Then you can add the [Labels](/tags/labels.html) control tag like usual to display the NER labels: ```xml ``` Close the [View](/tags/view.html) tag with the Labels, and open a new one for the Text tag: ```xml ``` The [Text](/tags/text.html) object tag specifies the text to label: ```xml ``` Then you can close the two remaining View tags. ### Enforce word alignment If you want to allow annotations of only full words and enforce word alignment in labeling tasks, you can use the `granularity` parameter on the [Text](/tags/text.html) object tag to make sure that all highlighted spans in a NER task are complete words. For example, adjust your Text tag like follows: ```xml ``` ### Add context to specific NER spans If you want to add context to specific NER spans, you can set up conditional **per-region labeling** with your NER template. For example, prompt annotators to choose the relevance of every text span in the text sample is: ```xml ``` The `perRegion` parameter means that these choice options apply for each text span region. You can also combine the [View](/tags/view.html) tag and the `perRegion` parameter of the [Rating](/tags/rating.html) control tag to prompt annotators to rate their confidence in the accuracy of each individual text span region: ```xml ``` The `visibleWhen` parameter with the View tag means that when a specific region is selected, the Header appears, prompting the annotator to supply a rating that applies to that region. ### Filter a long list of labels If you want to filter a long list of labels, add the [Filter](/tags/filter.html) tag to your labeling configuration. For example, to filter the named entity recognition labels, add the following: ```xml ``` The `toName` parameter on the Filter tag references the `name` parameter for the [Labels](/tags/labels.html) tag. You can also specify a `hotkey` to use for the filter text box, and set the `minlength` parameter to specify the minimum number of characters typed into the filter before the list of labels is filtered. ## Related tags - [View](/tags/view.html) - [Labels](/tags/labels.html) - [Text](/tags/text.html)
