Skip to content

Commit

Permalink
Improving the documentation for "word", within the pipeline. (#18763)
Browse files Browse the repository at this point in the history
* Improving the documentation for "word", within the pipeline.

* Quality.
  • Loading branch information
Narsil authored Aug 30, 2022
1 parent 5727dfc commit 73c6273
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/transformers/pipelines/token_classification.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,8 @@ def __call__(self, inputs: Union[str, List[str]], **kwargs):
corresponding input, or each entity if this pipeline was instantiated with an aggregation_strategy) with
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`.
- **entity** (`str`) -- The entity predicted for that token/word (it is named *entity_group* when
*aggregation_strategy* is not `"none"`.
Expand Down

0 comments on commit 73c6273

Please sign in to comment.