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

Update Documentation #976

Merged
merged 31 commits into from
Apr 22, 2021
Merged

Update Documentation #976

merged 31 commits into from
Apr 22, 2021

Conversation

brandenchan
Copy link
Contributor

@brandenchan brandenchan commented Apr 16, 2021

Let's update our documentation so that the website better reflects the latest developments in Haystack.

The main changes are:

  • Describing Haystack as Search instead of QA
  • Replacing Finder with Pipelines
  • Summarizer
  • Translator
  • Crawler
  • Evaluation Nodes
  • Pipeline Yaml config example
  • Adding import statements to code examples

Fixes #793

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@tholor tholor left a comment

Choose a reason for hiding this comment

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

Great work and many good additions + fixes! Left a few comments. Ready to merge once those are addressed.

For the next documentation update, I see the following topics:

  • Introduce a FAQ section (probably as a subpage of "Overview")
  • Dedicated section about optimization of speed (this question comes up a lot and would be great to just help users with a single link. Besides document length, it should contain the levers model size and GPU / CPU)
  • Reformat code examples so that they don't contain |when copying/pasting them
  • Think about a concept for introducing more "code snippets / recipes" (either within API reference or Usage or a central place where you can browse + search 🤔 )
  • Usage section for KGQA
  • Usage of REST API

For the FAQ part a few questions that came up a lot in the last months:

Q: Why do I get duplicate answers in the results? A: You added your documents twice to the document store. Make sure to call doc_store.delete_all_documents() before running your indexing script a second time
Q: How can I speed up predictions? A: Splitting docs, using GPU, smaller model (we should have a better documentation page just for this topic)
3. Q: Which model to use for German / spanish / ...? A: (maybe we should update our multilingual table in the docs? )
4. Q: How to add / access metadata?

docs/_src/api/api/evaluation.md Outdated Show resolved Hide resolved
docs/_src/api/api/evaluation.md Show resolved Hide resolved
docs/_src/api/api/evaluation.md Show resolved Hide resolved
docs/_src/api/api/summarizer.md Show resolved Hide resolved
docs/_src/api/api/summarizer.md Outdated Show resolved Hide resolved
docs/_src/usage/usage/get_started.md Outdated Show resolved Hide resolved
docs/_src/usage/usage/pipelines.md Outdated Show resolved Hide resolved
docs/_src/usage/usage/pipelines.md Show resolved Hide resolved
docs/_src/usage/usage/preprocessing.md Outdated Show resolved Hide resolved
haystack/translator/transformers.py Outdated Show resolved Hide resolved
@brandenchan
Copy link
Contributor Author

Also we should fix the example for the decision nodes in the pipelines usage page

@brandenchan
Copy link
Contributor Author

The next batch of changes to be addressed by #992

@brandenchan brandenchan merged commit 9626c0d into master Apr 22, 2021
@brandenchan brandenchan deleted the update_docs branch April 22, 2021 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Haystack Documentation Backlog
2 participants