Skip to content

Small errors in docs #364

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
merged 1 commit into from
Apr 30, 2020
Merged

Small errors in docs #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions cdqa/pipeline/cdqa_sklearn.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ class QAPipeline(BaseEstimator):
--------
>>> from cdqa.pipeline import QAPipeline
>>> qa_pipeline = QAPipeline(reader='bert_qa_squad_vCPU-sklearn.joblib')
>>> qa_pipeline.fit_retriever(X=df)
>>> prediction = qa_pipeline.predict(X='When BNP Paribas was created?')
>>> qa_pipeline.fit_retriever(df=df)
>>> prediction = qa_pipeline.predict(query='When BNP Paribas was created?')

>>> from cdqa.pipeline import QAPipeline
>>> qa_pipeline = QAPipeline()
>>> qa_pipeline.fit_reader('train-v1.1.json')
>>> qa_pipeline.fit_retriever(X=df)
>>> qa_pipeline.fit_retriever(df=df)
>>> prediction = qa_pipeline.predict(X='When BNP Paribas was created?')

"""
Expand Down Expand Up @@ -140,7 +140,7 @@ def predict(

Parameters
----------
X: str
query: str
Sample (question) to perform a prediction on

n_predictions: int or None (default: None).
Expand Down