Unverified Commit 73c6273d authored by Nicolas Patry's avatar Nicolas Patry Committed by GitHub
Browse files

Improving the documentation for "word", within the pipeline. (#18763)

* Improving the documentation for "word", within the pipeline.

* Quality.
parent 5727dfce
...@@ -172,7 +172,8 @@ class TokenClassificationPipeline(Pipeline): ...@@ -172,7 +172,8 @@ class TokenClassificationPipeline(Pipeline):
corresponding input, or each entity if this pipeline was instantiated with an aggregation_strategy) with corresponding input, or each entity if this pipeline was instantiated with an aggregation_strategy) with
the following keys: the following keys:
- **word** (`str`) -- The token/word classified. - **word** (`str`) -- The token/word classified. This is obtained by decoding the selected tokens. If you
want to have the exact string in the original sentence, use `start` and `stop`.
- **score** (`float`) -- The corresponding probability for `entity`. - **score** (`float`) -- The corresponding probability for `entity`.
- **entity** (`str`) -- The entity predicted for that token/word (it is named *entity_group* when - **entity** (`str`) -- The entity predicted for that token/word (it is named *entity_group* when
*aggregation_strategy* is not `"none"`. *aggregation_strategy* is not `"none"`.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment