iText2KG 项目使用与配置指南

1. 项目的目录结构及介绍

iText2KG 是一个用于增量构建一致性知识图的 Python 包。以下是项目的目录结构及其各部分的简要介绍：

• datasets/: 存储项目所需的数据集文件。
• docs/: 包含项目的文档和示例。
• examples/: 提供了使用 iText2KG 的示例代码。
• itext2kg/: 主包目录，包含了项目的核心代码。
  • entity_extractor.py: 实现实体提取功能的模块。
  • relation_extractor.py: 实现关系提取功能的模块。
  • document_distiller.py: 实现文档蒸馏功能的模块。
  • graph_integrator.py: 实现知识图整合和可视化的模块。
• tests/: 存储用于测试项目功能的测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的许可证信息。
• README.md: 项目的主页文档。
• pyproject.toml: 包含项目元数据和依赖关系的配置文件。
• requirements.txt: 项目的依赖关系列表。
• setup.cfg: 包的配置文件。

2. 项目的启动文件介绍

iText2KG 的启动通常是通过 Python 的命令行进行的。项目没有特定的启动文件，而是通过直接导入 itext2kg 包中的模块来使用。以下是一个简单的启动示例：

from itext2kg import DocumentDistiller

# 初始化文档蒸馏器
document_distiller = DocumentDistiller(llm_model=openai_llm_model)

# 处理文档
documents = ["doc1", "doc2", "doc3"]
distilled_documents = document_distiller.distill(documents)

在这个例子中，首先从 itext2kg 包中导入了 DocumentDistiller 类，然后使用指定的语言模型初始化了一个实例。之后，可以传入一组文档字符串到一个列表中，并通过调用 distill 方法来处理这些文档。

3. 项目的配置文件介绍

iText2KG 使用 pyproject.toml 和 setup.cfg 文件来配置包的元数据和依赖关系。

pyproject.toml

该文件定义了项目的元数据，例如项目名称、版本、作者、依赖项等。以下是一个简化的 pyproject.toml 文件示例：

[tool.poetry]
name = "iText2KG"
version = "0.1.0"
description = "Incremental Knowledge Graphs Construction Using Large Language Models"
authors = ["AuvaLab"]

[tool.poetry.dependencies]
python = "^3.9"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

在这个文件中，我们定义了项目的名称、版本和描述，还指定了项目依赖的 Python 版本。

setup.cfg

setup.cfg 文件用于定义包的安装参数。以下是一个简化的 setup.cfg 文件示例：

[metadata]
name = iText2KG
version = 0.1.0
author = AuvaLab
author_email = [e-mail]
description = Incremental Knowledge Graphs Construction Using Large Language Models
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/AuvaLab/itext2kg
classifiers =
    Programming Language :: Python :: 3.9
    License :: OSI Approved :: LGPL-2.1 License
    Operating System :: OS Independent

[options]
packages = find:
python_requires = >=3.9
install_requires =
    langchain
    numpy
    spacy

在这个文件中，我们提供了项目的元数据，并指定了项目的依赖项，例如 langchain 和 spacy。这些依赖项在安装包时会被自动安装。

通过这些配置文件，用户可以轻松安装和使用 iText2KG，而无需手动管理依赖关系。