mirror of
https://github.com/microsoft/graphrag.git
synced 2025-11-30 17:11:00 +00:00
7c28c70d5c
* Initial plan * Switch from Poetry to uv for package management Co-authored-by: jgbradley1 <654554+jgbradley1@users.noreply.github.com> * Clean up build artifacts and update gitignore Co-authored-by: jgbradley1 <654554+jgbradley1@users.noreply.github.com> * remove build artifacts * remove hardcoded version string * fix calls to pip in cicd * Update gh-pages.yml workflow to use uv instead of Poetry Co-authored-by: jgbradley1 <654554+jgbradley1@users.noreply.github.com> * ruff formatting fixes * update cicd workflow with latest uv action * fix command to retrieve package version * update development instructions * remove Poetry references * Replace deprecated azuright action with npm-based Azurite installation Co-authored-by: jgbradley1 <654554+jgbradley1@users.noreply.github.com> * skip api version check for azurite * add semversioner file * update more changes from switching to UV * Migrate unified-search-app from Poetry to uv package management Co-authored-by: jgbradley1 <654554+jgbradley1@users.noreply.github.com> * minor typo update * minor Dockerfile update * update cicd thresholds * update pytest thresholds * ruff fixes * ruff fixes * remove legacy npm settings that no longer apply * Update Unified Search App Readme --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jgbradley1 <654554+jgbradley1@users.noreply.github.com> Co-authored-by: Josh Bradley <joshbradley@microsoft.com> Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
3.1 KiB
3.1 KiB
Development Guide
Requirements
| Name | Installation | Purpose |
|---|---|---|
| Python 3.10-3.12 | Download | The library is Python-based. |
| uv | Instructions | uv is used for package management and virtualenv management in Python codebases |
Getting Started
Install Dependencies
# (optional) create virtual environment
uv venv --python 3.10
source .venv/bin/activate
# install python dependencies
uv sync --extra dev
Execute the Indexing Engine
uv run poe index <...args>
Executing Queries
uv run poe query <...args>
Azurite
Some unit and smoke tests use Azurite to emulate Azure resources. This can be started by running:
./scripts/start-azurite.sh
or by simply running azurite in the terminal if already installed globally. See the Azurite documentation for more information about how to install and use Azurite.
Lifecycle Scripts
Our Python package utilize uv to manage dependencies and poethepoet to manage build scripts.
Available scripts are:
uv run poe index- Run the Indexing CLIuv run poe query- Run the Query CLIuv build- This will build a wheel file and other distributable artifacts.uv run poe test- This will execute all tests.uv run poe test_unit- This will execute unit tests.uv run poe test_integration- This will execute integration tests.uv run poe test_smoke- This will execute smoke tests.uv run poe test_verbs- This will execute tests of the basic workflows.uv run poe check- This will perform a suite of static checks across the package, including:- formatting
- documentation formatting
- linting
- security patterns
- type-checking
uv run poe fix- This will apply any available auto-fixes to the package. Usually this is just formatting fixes.uv run poe fix_unsafe- This will apply any available auto-fixes to the package, including those that may be unsafe.uv run poe format- Explicitly run the formatter across the package.
Troubleshooting
"RuntimeError: llvm-config failed executing, please point LLVM_CONFIG to the path for llvm-config" when running uv install
Make sure llvm-9 and llvm-9-dev are installed:
sudo apt-get install llvm-9 llvm-9-dev
and then in your bashrc, add
export LLVM_CONFIG=/usr/bin/llvm-config-9
LLM call constantly exceeds TPM, RPM or time limits
GRAPHRAG_LLM_THREAD_COUNT and GRAPHRAG_EMBEDDING_THREAD_COUNT are both set to 50 by default. You can modify these values
to reduce concurrency. Please refer to the Configuration Documents