diff --git a/README.md b/README.md index b17d46f..b1445f6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/microsoft/graphrag) · [上游 README](https://github.com/microsoft/graphrag/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + # GraphRAG -👉 [Microsoft Research Blog Post](https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/)
-👉 [Read the docs](https://microsoft.github.io/graphrag)
+👉 [Microsoft Research 博客文章](https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/)
+👉 [阅读文档](https://microsoft.github.io/graphrag)
👉 [GraphRAG Arxiv](https://arxiv.org/pdf/2404.16130)
@@ -19,58 +25,58 @@
-## Overview +## 概览 -The GraphRAG project is a data pipeline and transformation suite that is designed to extract meaningful, structured data from unstructured text using the power of LLMs. +GraphRAG 项目是一套数据流水线(data pipeline)与转换工具套件,旨在借助大语言模型(LLM)的能力,从非结构化文本中提取有意义、结构化的数据。 -To learn more about GraphRAG and how it can be used to enhance your LLM's ability to reason about your private data, please visit the Microsoft Research Blog Post. +要了解更多关于 GraphRAG 的信息,以及它如何用于增强 LLM 对私有数据的推理能力,请访问 Microsoft Research 博客文章。 -## Quickstart +## 快速入门 -To get started with the GraphRAG system we recommend trying the [command line quickstart](https://microsoft.github.io/graphrag/get_started/). +要开始使用 GraphRAG 系统,我们建议你尝试[命令行快速入门](https://microsoft.github.io/graphrag/get_started/). -## Repository Guidance +## 仓库指南 -This repository presents a methodology for using knowledge graph memory structures to enhance LLM outputs. Please note that the provided code serves as a demonstration and is not an officially supported Microsoft offering. +本仓库介绍了一种利用知识图谱(knowledge graph)记忆结构来增强 LLM 输出的方法。请注意,所提供的代码仅作演示用途,并非 Microsoft 官方支持的产品。 -⚠️ *Warning: GraphRAG indexing can be an expensive operation, please read all of the documentation to understand the process and costs involved, and start small.* +⚠️ *警告:GraphRAG 索引可能是一项开销较大的操作,请阅读全部文档以了解相关流程与成本,并从小规模开始。* -## Diving Deeper +## 深入了解 -- To learn about our contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md) -- To start developing _GraphRAG_, see [DEVELOPING.md](./DEVELOPING.md) -- Join the conversation and provide feedback in the [GitHub Discussions tab!](https://github.com/microsoft/graphrag/discussions) +- 要了解我们的贡献指南,请参阅 [CONTRIBUTING.md](./CONTRIBUTING.md) +- 要开始开发 _GraphRAG_,请参阅 [DEVELOPING.md](./DEVELOPING.md) +- 欢迎在 [GitHub Discussions 版块!](https://github.com/microsoft/graphrag/discussions) 加入讨论并提供反馈 -## Prompt Tuning +## 提示词调优(Prompt Tuning) -Using _GraphRAG_ with your data out of the box may not yield the best possible results. -We strongly recommend to fine-tune your prompts following the [Prompt Tuning Guide](https://microsoft.github.io/graphrag/prompt_tuning/overview/) in our documentation. +开箱即用地将 _GraphRAG_ 用于你的数据,可能无法获得最佳效果。 +我们强烈建议你按照文档中的 [提示词调优指南](https://microsoft.github.io/graphrag/prompt_tuning/overview/) 对提示词进行微调。 -## Versioning +## 版本管理 -Please see the [breaking changes](./breaking-changes.md) document for notes on our approach to versioning the project. +请参阅[破坏性变更](./breaking-changes.md)文档,了解我们对项目版本管理的做法说明。 -*Always run `graphrag init --root [path] --force` between minor version bumps to ensure you have the latest config format. Run the provided migration notebook between major version bumps if you want to avoid re-indexing prior datasets. Note that this will overwrite your configuration and prompts, so backup if necessary.* +*在次要版本(minor version)升级之间,请始终运行 `graphrag init --root [path] --force`,以确保使用最新的配置格式。若要在主要版本(major version)升级时避免重新索引先前数据集,请运行提供的迁移 notebook。注意,这将覆盖你的配置与提示词,如有需要请先备份。* -## Responsible AI FAQ +## 负责任的 AI 常见问题 -See [RAI_TRANSPARENCY.md](./RAI_TRANSPARENCY.md) +请参阅 [RAI_TRANSPARENCY.md](./RAI_TRANSPARENCY.md) -- [What is GraphRAG?](./RAI_TRANSPARENCY.md#what-is-graphrag) -- [What can GraphRAG do?](./RAI_TRANSPARENCY.md#what-can-graphrag-do) -- [What are GraphRAG’s intended use(s)?](./RAI_TRANSPARENCY.md#what-are-graphrags-intended-uses) -- [How was GraphRAG evaluated? What metrics are used to measure performance?](./RAI_TRANSPARENCY.md#how-was-graphrag-evaluated-what-metrics-are-used-to-measure-performance) -- [What are the limitations of GraphRAG? How can users minimize the impact of GraphRAG’s limitations when using the system?](./RAI_TRANSPARENCY.md#what-are-the-limitations-of-graphrag-how-can-users-minimize-the-impact-of-graphrags-limitations-when-using-the-system) -- [What operational factors and settings allow for effective and responsible use of GraphRAG?](./RAI_TRANSPARENCY.md#what-operational-factors-and-settings-allow-for-effective-and-responsible-use-of-graphrag) +- [什么是 GraphRAG?](./RAI_TRANSPARENCY.md#what-is-graphrag) +- [GraphRAG 能做什么?](./RAI_TRANSPARENCY.md#what-can-graphrag-do) +- [GraphRAG 的预期用途是什么?](./RAI_TRANSPARENCY.md#what-are-graphrags-intended-uses) +- [GraphRAG 是如何评估的?使用哪些指标来衡量性能?](./RAI_TRANSPARENCY.md#how-was-graphrag-evaluated-what-metrics-are-used-to-measure-performance) +- [GraphRAG 有哪些局限性?用户在使用系统时如何尽可能降低这些局限性的影响?](./RAI_TRANSPARENCY.md#what-are-the-limitations-of-graphrag-how-can-users-minimize-the-impact-of-graphrags-limitations-when-using-the-system) +- [哪些运营因素和设置有助于有效且负责任地使用 GraphRAG?](./RAI_TRANSPARENCY.md#what-operational-factors-and-settings-allow-for-effective-and-responsible-use-of-graphrag) -## Trademarks +## 商标 -This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft -trademarks or logos is subject to and must follow -[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). -Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. -Any use of third-party trademarks or logos are subject to those third-party's policies. +本项目可能包含项目、产品或服务的商标或标识。Microsoft +商标或标识的授权使用须遵守并遵循 +[Microsoft 商标与品牌指南](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). +在本项目的修改版本中使用 Microsoft 商标或标识,不得造成混淆或暗示 Microsoft 的赞助。 +任何第三方商标或标识的使用均须遵守相应第三方的政策。 -## Privacy +## 隐私 -[Microsoft Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement) +[Microsoft 隐私声明](https://privacy.microsoft.com/en-us/privacystatement)