tbga / README.md
ArneBinder's picture
from https://github.com/ArneBinder/pie-datasets/pull/140
524ffec verified
# PIE Dataset Card for "TBGA"
This is a [PyTorch-IE](https://github.com/ChristophAlt/pytorch-ie) wrapper for the
[TBGA Huggingface dataset loading script](https://huggingface.co/datasets/DFKI-SLT/tbga).
## Data Schema
The document type for this dataset is `TbgaDocument` which defines the following data fields:
- `text` (str)
and the following annotation layers:
- `entities` (annotation type: `SpanWithIdAndName`, target: `text`)
- `relations` (annotation type: `BinaryRelation`, target: `entities`)
`SpanWithIdAndName` is a custom annotation type that extends typical `Span` with the following data fields:
- `id` (str, for entity identification)
- `name` (str, entity string between span start and end)
See [here](https://github.com/ArneBinder/pie-modules/blob/main/src/pie_modules/annotations.py) and
[here](https://github.com/ChristophAlt/pytorch-ie/blob/main/src/pytorch_ie/annotations.py) for the annotation
type definitions.
## Document Converters
The dataset provides predefined document converters for the following target document types:
- `pie_modules.documents.TextDocumentWithLabeledSpansAndBinaryRelations`
See [here](https://github.com/ArneBinder/pie-modules/blob/main/src/pie_modules/documents.py) and
[here](https://github.com/ChristophAlt/pytorch-ie/blob/main/src/pytorch_ie/documents.py) for the document type
definitions.