https://github.com/ettorecaputo/streamlit-annotator

st-annotator is a Streamlit component usefull to annotate text, expecially for NLP and Argument Mining purposes.
https://github.com/ettorecaputo/streamlit-annotator

annotator argument mining nlp streamlit streamlit-components

Last synced: 9 months ago
JSON representation

st-annotator is a Streamlit component usefull to annotate text, expecially for NLP and Argument Mining purposes.

• Host: GitHub
• URL: https://github.com/ettorecaputo/streamlit-annotator
• Owner: EttoreCaputo
• License: mit
• Created: 2025-06-26T15:01:22.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-06-26T22:06:53.000Z (9 months ago)
• Last Synced: 2025-06-26T23:17:29.725Z (9 months ago)
• Topics: annotator, argument, mining, nlp, streamlit, streamlit-components
• Language: TypeScript
• Homepage: https://pypi.org/project/st-annotator/
• Size: 4 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          

# st-annotator

[![PyPI version](https://badge.fury.io/py/st-annotator.svg)](https://badge.fury.io/py/st-annotator)

st-annotator is a Streamlit component usefull to annotate text, expecially for NLP and Argument Mining purposes.

Based on the original project [Streamlit Annotation Tools](https://github.com/streamlit/annotation-tools) of [rmarquet21](https://github.com/rmarquet21).

# Demo on Streamlit Cloud

[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://app-annotator.streamlit.app)

## New Features

- Custom colors to the labels

- Input textbox visible or hidden

## Removed Features

- Highlighter tool

## Annotator with input textbox (default)

![](docs/ann_default.gif)

## Annotator without input textbox and custom colors

![](docs/ann_without_input.gif)

## Annotator with custom colors

![](docs/ann_with_custom_colors.gif)

# Install

```

pip install st-annotator

```

# Quick Use

## Text Annotator

Create an example.py file

```python

from st_annotator import text_labeler

text = "Effects of globalization During the history of the world , every change has its own positive and negative sides . Globalization as a gradual change affecting all over the world is not an exception . Although it has undeniable effects on the economics of the world ; it has side effects which make it a controversial issue .  Some people prefer to recognize globalization as a threat to ethnic and religious values of people of their country  . They think that  the idea of globalization put their inherited culture in danger of uncontrolled change and make them vulnerable against the attack of imperialistic governments  . Those who disagree , believe that  globalization contribute effectively to the global improvement of the world in many aspects  .  Developing globalization , people can have more access to many natural resources of the world and it leads to increasing the pace of scientific and economic promotions of the entire world  . In addition ,  they admit that globalization can be considered a chance for people of each country to promote their lifestyle through the stuffs and services imported from other countries  . Moreover , the proponents of globalization idea point out  globalization results in considerable decrease in global tension  due to  convergence of benefits of people of the world which is a natural consequence of globalization  . In conclusion ,  I would rather classify myself in the proponents of globalization as a speeding factor of global progress  . I think it is more likely to solve the problems of the world rather than intensifying them ."

labels = text_annotator(text, labels, in_snake_case=False, show_label_input=True, colors={"label_input":"#ff9500", "Major Claim": "#a457d7", "Claim": "#3478f6", "Premise": "#5ac4be"})

    

```

Run:

```

streamlit run example.py

```

Output:

```python

{

    "Major Claim": [

      {"start": 1467, "end": 1572, "label": "I would rather classify myself in the proponents of globalization as a speeding factor of global progress"}

    ],

    "Claim": [

      {"start": 330, "end": 445, "label": "Some people prefer to recognize globalization as a threat to ethnic and religious values of people of their country"},

      {"start": 686, "end": 777, "label": "globalization contribute effectively to the global improvement of the world in many aspects"},

      {"start": 1256, "end": 1320, "label": "globalization results in considerable decrease in global tension"}

    ],

    "Premise": [

      {"start": 477, "end": 636, "label": "the idea of globalization put their inherited culture in danger of uncontrolled change and make them vulnerable against the attack of imperialistic governments"},

      {"start": 793, "end": 980, "label": "Developing globalization , people can have more access to many natural resources of the world and it leads to increasing the pace of scientific and economic promotions of the entire world"},

      {"start": 1010, "end": 1182, "label": "they admit that globalization can be considered a chance for people of each country to promote their lifestyle through the stuffs and services imported from other countries"},

      {"start": 1341, "end": 1435, "label": "convergence of benefits of people of the world which is a natural consequence of globalization"}

    ],

}

```

# Development

## Install

```

git clone 

cd st-annotator

pip install -e .

```

## Run

```

streamlit run example.py

```

# License

MIT

# Author

Ettore Caputo