Skip to content

Adding doctest for question-answering pipeline. #20259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Narsil merged 2 commits into from
Nov 16, 2022
Merged

Adding doctest for question-answering pipeline. #20259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ea29d3
Adding doctest for `question-answering` pipeline.
Narsil Nov 16, 2022
c5df5e7
Remove nested simplify.
Narsil Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/transformers/pipelines/question_answering.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,18 @@ class QuestionAnsweringPipeline(ChunkPipeline):
Question Answering pipeline using any `ModelForQuestionAnswering`. See the [question answering
examples](../task_summary#question-answering) for more information.

Example:

```python
>>> from transformers import pipeline

>>> oracle = pipeline(model="deepset/roberta-base-squad2")
>>> oracle(question="Where do I live?", context="My name is Wolfgang and I live in Berlin")
{'score': 0.9191, 'start': 34, 'end': 40, 'answer': 'Berlin'}
```

[Learn more about the basics of using a pipeline in the [pipeline tutorial]](../pipeline_tutorial)

This question answering pipeline can currently be loaded from [`pipeline`] using the following task identifier:
`"question-answering"`.

Expand Down