deepset-ai / haystack

:mag: AI orchestration framework to build customizable, production-ready LLM applications. Connect components (models, vector DBs, file converters) to pipelines or agents that can interact with your data. With advanced retrieval methods, it's best suited for building RAG, question answering, semantic search or conversational agent chatbots.
https://haystack.deepset.ai
Apache License 2.0
16.66k stars 1.83k forks source link

Outdated documentation #8171

Closed dariush-saberi closed 4 days ago

dariush-saberi commented 1 month ago

Most of the examples provided in your documentation do not seem to be functioning correctly. Even on your website’s first page, under the “Quick Start” section (https://haystack.deepset.ai/overview/quick-start), there appears to be an error regarding the “PredefinedPipeline.” The line “from haystack import Pipeline, PredefinedPipeline” results in an error indicating that “PredefinedPipeline” cannot be found. Where can I find the correct and up-to-date documentation?

anakin87 commented 1 month ago

Hello!

In general, we try to keep the documentation up to date, but there might be some errors (you can also suggest changes to the docs using the "Suggest Edits" button).

About the Quick Start, I cannot reproduce your error and I suggest you check that you have properly installed Haystack, as explained in the docs.

dariush-saberi commented 1 month ago

Screenshot 2024-08-08 172012 I hope this helps you reproduce the error. This is just one example, but I wanted to bring it to your attention as I’ve been using your API extensively. The level of outdated documentation is quite concerning.

anakin87 commented 1 month ago

If you are on a Jupyter notebook, I would try restarting the kernel.

I cannot reproduce the error on Colab:

# make conda work on Colab
!pip install -q condacolab
import condacolab
condacolab.install()

# install haystack
!conda config --add channels conda-forge/label/haystack-ai_rc
!conda install haystack-ai

# import Pipelines: works for me
from haystack import Pipeline, PredefinedPipeline
dariush-saberi commented 1 month ago

My bad. Thank you. It worked after restarting the kernel.