Installation Steps

• Create virtual environment with Python 3.11.

• Activate virtual environment.

• Install the package with pip. Installing from source is recommended to get latest changes.

  • from PyPI: pip install query-package-documentation

  • from dev branch: pip install git+https://github.com/yarnabrina/query-package-documentation.git@dev

• fine-tuning optional dependency is required to run the fine-tuning notebooks, and unused otherwise.

• CLI and GUI are provided for RAG with public open source models from Hugging Face.