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

Feedback: Different Colab example for Tutorial3_Basic_QA_Pipeline_without_Elasticsearch #188

Closed
PhilipMay opened this issue Jul 3, 2020 · 1 comment

Comments

@PhilipMay
Copy link
Contributor

PhilipMay commented Jul 3, 2020

Hi,
@Timoeller asked me for feedback to Haystack...

Tutorial3_Basic_QA_Pipeline_without_Elasticsearch has a different colab version which is confusing.

This is linked from README:
https://colab.research.google.com/github/deepset-ai/haystack/blob/update-tutorials/tutorials/Tutorial3_Basic_QA_Pipeline_without_Elasticsearch.ipynb

It differs from the 2 versions in the tutorials directory.

This line is different for example:
write_documents_to_db(document_store=document_store, document_dir=doc_dir, clean_func=clean_wiki_text, only_empty_db=True)

My suggestion: Only add a notebook with a Colab button. No .py and no Colab.

PS: Please also check the other tutorial versions...

@PhilipMay PhilipMay changed the title Different Colab example for Tutorial3_Basic_QA_Pipeline_without_Elasticsearch Feedback: Different Colab example for Tutorial3_Basic_QA_Pipeline_without_Elasticsearch Jul 3, 2020
@tholor
Copy link
Member

tholor commented Jul 7, 2020

Thanks for spotting! The link in the readme was incorrectly pointing to an old branch instead of master.
Fixed it in #200.

We personally work more with IDEs than notebooks and therefore like the .py scripts a lot for debugging or helping some other users. Therefore we'll keep them.

Regarding the Colab button. If I am not missing anything the functionality is the same as with our link: one jupyter notebook that gets opened via Colab. So also with the current state there's no "jupyer" vs "colab" version. It's always the same notebook.

@tholor tholor closed this as completed Jul 7, 2020
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

No branches or pull requests

2 participants