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

[Docs] README doesn't explain how to install from main branch #4689

Closed
julian-risch opened this issue Apr 17, 2023 · 3 comments · Fixed by #4741
Closed

[Docs] README doesn't explain how to install from main branch #4689

julian-risch opened this issue Apr 17, 2023 · 3 comments · Fixed by #4741
Assignees
Labels
type:documentation Improvements on the docs

Comments

@julian-risch
Copy link
Member

julian-risch commented Apr 17, 2023

https://github.com/deepset-ai/haystack#-installation doesn't mention how to install from main branch correctly but only from PyPI. We should adjust the text and add another installation example for the main branch (with extras), for example: pip install -e '.[all]'
or
pip install git+https://github.com/deepset-ai/haystack.git@main#egg=farm-haystack[colab,ocr]

@julian-risch julian-risch added the type:documentation Improvements on the docs label Apr 17, 2023
@anakin87
Copy link
Member

Hello!

I thought it was intentional because this option is also missing in the docs...

@julian-risch
Copy link
Member Author

julian-risch commented Apr 17, 2023

Hi Stefano :) I think we should also explain the currently missing alternative of how to install from the main branch. What's definitely wrong in the docs and the readme right now is the accompanying text saying "The following command installs the latest version of Haystack and all its dependencies from the main branch: ... pip install 'farm-haystack[all]'"

@julian-risch
Copy link
Member Author

Cc @dfokina

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 a pull request may close this issue.

3 participants