-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Update Documentation #976
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
…into update_docs
There was a problem hiding this 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?
Also we should fix the example for the decision nodes in the pipelines usage page |
The next batch of changes to be addressed by #992 |
Let's update our documentation so that the website better reflects the latest developments in Haystack.
The main changes are:
Fixes #793