fix: README latest and main installation #4741
Conversation
Fixing README to explain how to install from main branch
There was a problem hiding this comment.
Looking much better than before already. 👍 I left a few minor comments with change requests but nothing too big. The installation instructions should briefly explain the different extras and maybe link to the list of extras: https://github.com/deepset-ai/haystack/blob/main/pyproject.toml#L93
One remark regarding reviewers: Once you open a PR, a reviewer from the core engineering team will be auto assigned. In case you want a different person to review the PR instead, you can unassign the other reviewer. Thereby we don't end up with two reviews unless they are both needed.
README.md
Outdated
| @@ -102,14 +102,27 @@ This command installs everything needed for basic Pipelines that use an Elastics | |||
|
|
|||
| **Full Installation** | |||
|
|
|||
| To use more advanced features, like certain DocumentStores, FileConverters, OCR, or Ray, install further dependencies. The following command installs the latest version of Haystack and all its dependencies from the main branch: | |||
| To use more advanced features, like certain DocumentStores, FileConverters, OCR, or Ray, install further dependencies. The following command installs the most recent version of Haystack and all its dependencies from the latest branch: | |||
There was a problem hiding this comment.
Let's remove from the latest branch. That's not what we are showing in the pip instal command and it contradicts most recent version. If you think it helps, you could mention latest release here and maybe even link to the release notes: https://github.com/deepset-ai/haystack/releases
There was a problem hiding this comment.
To be more consistent with the previous description of the basic version of Haystack's latest release, we could write here sth like full installation of Haystack's latest release with all its dependencies.
README.md
Outdated
|
|
||
| ``` | ||
| pip install --upgrade pip | ||
| pip install 'farm-haystack[all]' ## or 'all-gpu' for the GPU-enabled dependencies | ||
| ``` | ||
|
|
||
| **Installing the REST API** Haystack comes packaged with a REST API so that you can deploy it as a service. Run the following command from the root directory of the Haystack repo to install REST_API: | ||
| If you want to try out the newest features that are not in an official release yet, you can install Haystack from the main branch. The following commands install from `main` with all its dependencies: |
There was a problem hiding this comment.
For the pip install -e, users need to clone the git repository before so we should briefly mention that. It's for users who want to make changes to Haystack's code and maybe even contribute.
README.md
Outdated
| or | ||
|
|
||
| ``` | ||
| pip install git+https://github.com/deepset-ai/haystack.git@main#egg=farm-haystack[colab,ocr] |
There was a problem hiding this comment.
This installs Haystack from the main branch but without the need for cloning it before and it installs the colab and ocr extras. This example command needs more descriptions. It's also a good example for users who want to install from a branch other than main
|
@julian-risch I made some improvements, please review :) |
Fixing README to explain how to install from main branch
Fixing README to explain how to install from main branch
Related Issues
Proposed Changes:
mainHow did you test it?
Notes for the reviewer
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.