deepset-ai / haystack

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
17.72k stars 1.92k forks source link

Instructions to create virtual environment for contributing to haystack v2.x #8191

Closed jpatra72 closed 3 months ago

jpatra72 commented 3 months ago

Is your feature request related to a problem? Please describe. The CONTRIBUTING.md for haystack v2.x doesn't seem to have any instructions on how to create a virtual environment for local development.

I was able to find a github discussion on this. The instructions mentioned in the comments helped to some extent, but packages like pytest, langdetect, transformers, huggingface_hub required manual installation in the virtual env. I also believe this discussion was in the context of v1.x

Describe the solution you'd like Proper instructions on setting up local virtual env for haystack v2.x in the CONTRIBUTING.md page for seamless contributing experience for new comers like me :)

Describe alternatives you've considered Installed following missing packages using pip install manually: pytest, langdetect, transformers, huggingface_hub

Additional context Happy to create pull request for the same if someone could point me in the right direction.