Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ArneBinder committed Nov 2, 2023
1 parent 28d164b commit 61a962b
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions dataset_builders/pie/conll2003/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# PIE Dataset Card for "conll2003"

This is a [PyTorch-IE](https://github.com/ChristophAlt/pytorch-ie) wrapper for the
[CoNLL 2003 Huggingface dataset loading script](https://huggingface.co/datasets/conll2003).

## Data Schema

The document type for this dataset is `CoNLL2003Document` which defines the following data fields:

- `text` (str)
- `id` (str, optional)
- `metadata` (dictionary, optional)

and the following annotation layers:

- `entities` (annotation type: `LabeledSpan`, target: `text`)

See [here](https://github.com/ChristophAlt/pytorch-ie/blob/main/src/pytorch_ie/annotations.py) for the definitions of
the annotation types.

0 comments on commit 61a962b

Please sign in to comment.