Skip to content
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.

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

Regenerate API and Tutorial md files #1480

Merged
merged 9 commits into from
Sep 21, 2021
Merged

Conversation

brandenchan
Copy link
Contributor

@brandenchan brandenchan commented Sep 20, 2021

Adds API files for the question generator and classifier classes. Also adds API coverage for the Docs2Answers class

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@brandenchan brandenchan self-assigned this Sep 20, 2021
Copy link
Contributor

@PiffPaffM PiffPaffM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there already an open PR to add the new API markdown files to the website menu?

@@ -142,7 +142,7 @@ print(dicts[:3])
document_store.write_documents(dicts)
```

## Initalize Retriever, Reader, & Pipeline
## Initalize Retriever, Reader, & Finder
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this. I would expect here Pipeline instead of Finder.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing that out, not sure how that snuck in. It's been reverted now

@@ -241,7 +241,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Initalize Retriever, Reader, & Pipeline\n",
"## Initalize Retriever, Reader, & Finder\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above

@brandenchan
Copy link
Contributor Author

Is there already an open PR to add the new API markdown files to the website menu?

There will be a PR coming later today in haystack-website to do this

Copy link
Contributor

@PiffPaffM PiffPaffM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@brandenchan brandenchan merged commit 2c4baa7 into master Sep 21, 2021
@brandenchan brandenchan deleted the regen_api_tutorials branch September 21, 2021 12:42
@tholor tholor added topic:ui type:documentation Improvements on the docs and removed topic:ui labels Dec 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants