:mag: Haystack is an open source NLP framework that leverages Transformer models. It enables developers to implement production-ready neural search, question answering, semantic document search and summarization for a wide range of applications.
Haystack is an end-to-end framework that enables you to build powerful and production-ready pipelines for different search use cases. Whether you want to perform Question Answering or semantic document search, you can use the State-of-the-Art NLP models in Haystack to provide unique search experiences and allow your users to query in natural language. Haystack is built in a modular fashion so that you can combine the best technology from other open-source projects like Huggingface's Transformers, Elasticsearch, or Milvus.
| | | |-|-| | :ledger: Docs | Overview, Components, Guides, API documentation| | :floppydisk: Installation | How to install Haystack | | :mortarboard: Tutorials | See what Haystack can do with our Notebooks & Scripts | | :beginner: Quick Demo | Deploy a Haystack application with Docker Compose and a REST API | | :vulcansalute: Community | Slack, Twitter, Stack Overflow, GitHub Discussions | | :heart: Contributing | We welcome all contributions! | | :barchart: Benchmarks | Speed & Accuracy of Retriever, Readers and DocumentStores | | :telescope: Roadmap | Public roadmap of Haystack | | :newspaper: Blog | Read our articles on Medium | | :phone: Jobs | We're hiring! Have a look at our open positions |
If you're interested in learning more about Haystack and using it as part of your application, we offer several options.
1. Installing from a package
You can install Haystack by using pip.
pip3 install farm-haystack
Please check our page on PyPi for more information.
2. Installing from GitHub
You can also clone it from GitHub — in case you'd like to work with the master branch and check the latest features:
git clone https://github.com/deepset-ai/haystack.git cd haystack pip install --editable .
To update your installation, do a
git pull. The
--editableflag will update changes immediately.
3. Installing on Windows
On Windows, you might need:
pip install farm-haystack -f https://download.pytorch.org/whl/torch_stable.html
Follow our introductory tutorial to setup a question answering system using Python and start performing queries! Explore the rest of our tutorials to learn how to tweak pipelines, train models and perform evaluation.
Start up a Haystack service via Docker Compose. With this you can begin calling it directly via the REST API or even interact with it using the included Streamlit UI.
1. Update/install Docker and Docker Compose, then launch Docker
apt-get update && apt-get install docker && apt-get install docker-compose service docker start
2. Clone Haystack repository
git clone https://github.com/deepset-ai/haystack.git
3. Pull images & launch demo app
cd haystack docker-compose pull docker-compose up # Or on a GPU machine: docker-compose -f docker-compose-gpu.yml up
You should be able to see the following in your terminal window as part of the log output:
.. ui_1 | You can now view your Streamlit app in your browser. .. ui_1 | External URL: http://192.168.108.218:8501 .. haystack-api_1 | [2021-01-01 10:21:58 +0000]  [INFO] Application startup complete.
4. Open the Streamlit UI for Haystack by pointing your browser to the "External URL" from above.
You should see the following:
You can then try different queries against a pre-defined set of indexed articles related to Game of Thrones.
Note: The following containers are started as a part of this demo:
Please note that the demo will publish the container ports to the outside world. We suggest that you review the firewall settings depending on your system setup and the security guidelines.
There is a very vibrant and active community around Haystack which we are regularly interacting with! If you have a feature request or a bug report, feel free to open an issue in Github. We regularly check these and you can expect a quick response. If you'd like to discuss a topic, or get more general advice on how to make Haystack work for your project, you can start a thread in Github Discussions or our Slack channel. We also check Twitter and Stack Overflow.
We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature! You don't need to be a Haystack expert to provide meaningful improvements. To learn how to get started, check out our Contributor Guidelines first. You can also find instructions to run the tests locally there.
Thanks so much to all those who have contributed to our project!