Copilot commented on code in PR #290: URL: https://github.com/apache/incubator-hugegraph-ai/pull/290#discussion_r2228496324
########## hugegraph-llm/basic-introduction.md: ########## @@ -0,0 +1,111 @@ +# Basic Introduction + +This file provides guidance to AI coding tools and developers when working with code in this repository. + +## Project Overview + +HugeGraph-LLM is a comprehensive toolkit that bridges graph databases and large language models, part of the Apache HugeGraph AI ecosystem. It enables seamless integration between HugeGraph and LLMs for building intelligent applications with three main capabilities: Knowledge Graph Construction, Graph-Enhanced RAG, and Text2Gremlin query generation. + +## Tech Stack + +- **Language**: Python 3.10+ (UV package manager required) +- **Framework**: FastAPI + Gradio for web interfaces +- **Graph Database**: HugeGraph Server 1.3+ (recommended: 1.5+) +- **LLM Integration**: LiteLLM (supports OpenAI, Ollama, Qianfan, etc.) +- **Vector Operations**: FAISS, NumPy, Pandas +- **Key Dependencies**: hugegraph-python-client, LangChain, NLTK, Jieba + +## Essential Commands + +### Setup and Development +```bash +# Install UV package manager (if not installed) +curl -LsSf https://astral.sh/uv/install.sh | sh + Review Comment: The command pipes a downloaded script directly to shell without verification. Consider adding a note about verifying the script or checking the official UV documentation for the most secure installation method. ```suggestion # Download the installation script curl -LsSf -o install.sh https://astral.sh/uv/install.sh # (Optional) Verify the script's integrity (refer to the official UV documentation for checksum/signature) # echo "<expected-checksum> install.sh" | sha256sum --check # Execute the script sh install.sh # Note: For the most secure and up-to-date installation method, refer to the official UV documentation: # https://astral.sh/uv/docs ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
