Update README.md
Browse files
README.md
CHANGED
@@ -9,7 +9,14 @@ CHATUtterance is a series of Bert-derivative models designed for the task of Utt
|
|
9 |
## Usage
|
10 |
The models can be used directly as a Bert-class token classification model following the [instructions from Huggingface](https://huggingface.co/docs/transformers/tasks/token_classification). Feel free to inspect [this file](https://github.com/TalkBank/batchalign/blob/73ec04761ed3ee2eba04ba0cf14dc898f88b72f7/baln/utokengine.py#L85-L94) for a sense of what the classes means. Alternatively, to get the full analysis possible with the model, it is best combined with the TalkBank Batchalign suite of analysis software, [available here](https://github.com/talkbank/batchalign), using `transcribe` mode.
|
11 |
|
|
|
12 |
|
|
|
|
|
|
|
|
|
|
|
|
|
13 |
|
14 |
|
15 |
|
|
|
9 |
## Usage
|
10 |
The models can be used directly as a Bert-class token classification model following the [instructions from Huggingface](https://huggingface.co/docs/transformers/tasks/token_classification). Feel free to inspect [this file](https://github.com/TalkBank/batchalign/blob/73ec04761ed3ee2eba04ba0cf14dc898f88b72f7/baln/utokengine.py#L85-L94) for a sense of what the classes means. Alternatively, to get the full analysis possible with the model, it is best combined with the TalkBank Batchalign suite of analysis software, [available here](https://github.com/talkbank/batchalign), using `transcribe` mode.
|
11 |
|
12 |
+
Target labels:
|
13 |
|
14 |
+
- `0`: regular form
|
15 |
+
- `1`: start of utterance/capitalized word
|
16 |
+
- `2`: end of declarative utterance (end this utterance with a `.`)
|
17 |
+
- `3`: end of interrogative utterance (end this utterance with a `?`)
|
18 |
+
- `4`: end of exclamatory utterance (end this utterance with a `!`)
|
19 |
+
- `5`: break in the utterance; depending on orthography one can insert a `,`
|
20 |
|
21 |
|
22 |
|