Skip to content

Commit

Permalink
Add information about preview module (#5643)
Browse files Browse the repository at this point in the history
* Add information about `preview` module

* Add discussion link

* Improve text
  • Loading branch information
bilgeyucel authored Aug 29, 2023
1 parent 1f7c7b7 commit ee13125
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion haystack/preview/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# Haystack - Preview features
# Haystack 2.0 - Preview Features

[![PyPI - Version](https://img.shields.io/pypi/v/haystack-ai.svg)](https://pypi.org/project/haystack-ai)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/haystack-ai.svg)](https://pypi.org/project/haystack-ai)

Since Haystack 1.15, we’ve been slowly introducing new components and features to Haystack in the background in preparation for Haystack 2.0. In this `preview` module, you can find what’s been implemented so far regarding Haystack 2.0. **Keep in mind that Haystack 2.0 is still a work in progress.** Read more about Haystack 2.0 in [Shaping Haystack 2.0](https://github.com/deepset-ai/haystack/discussions/5568).

## 💾 Installation

**Install `haystack-ai`**

There is a separate PyPI package that only ships the code in `preview` module. You can install `haystack-ai` using pip:
```sh
pip install haystack-ai
```
The `haystack-ai` package is built on the `main` branch, so it's highly unstable, but it's useful if you want to try the new features as soon as they are merged.

**Install `farm-haystack`**

As an alternative way, you can install `farm-haystack`:
```sh
pip install farm-haystack
```
The `farm-haystack` package includes all new features of Haystack 2.0. Note that updates to this package occur less frequently compared to `haystack-ai`. So, you might not get the all latest Haystack 2.0 features immediately when using `farm-haystack`.

## 💙 Stay Updated
To learn how and when components will be migrated to the new major version, have a look at the [Migrate Components to Pipeline v2](https://github.com/deepset-ai/haystack/issues/5265) roadmap item, where we keep track of issues and PRs about Haystack 2.0. When you have questions, you can always contact us using the [Shaping Haystack 2.0](https://github.com/deepset-ai/haystack/discussions/5568) discussion or [Haystack Discord server](https://discord.com/channels/993534733298450452/1141683185458094211).

0 comments on commit ee13125

Please sign in to comment.