dataflow-kg 0.9.0__tar.gz

dataflow_kg-0.9.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dataflow_kg-0.9.0/MANIFEST.in

@@ -0,0 +1,21 @@
+# 明确指定源码文件
+recursive-include dataflow *.py
+recursive-include dataflow *.json
+recursive-include dataflow *.yaml
+recursive-include dataflow *.sh
+recursive-include dataflow *.txt
+
+# 包含样例文件夹下所有类型的文件
+# 样例文件夹路径为dataflow/exaple
+recursive-include dataflow/example */
+
+# 包含顶层文档文件
+include README.md
+include requirements.txt
+include LICENSE
+
+# 排除无用缓存文件
+global-exclude *.py[cod]
+global-exclude __pycache__/
+global-exclude *.so
+global-exclude *.egg-info/

dataflow_kg-0.9.0/PKG-INFO

@@ -0,0 +1,313 @@
+Metadata-Version: 2.4
+Name: dataflow-kg
+Version: 0.9.0
+Summary: Modern Data Centric AI system for Large Language Models
+Author-email: Zhengpin Li <zpli@pku.edu.cn>
+License: Apache-2.0
+Project-URL: Github, https://github.com/Open-DataFlow/DataFlow-KG
+Project-URL: Documentation, https://open-dataflow.github.io/DataFlow-Doc/
+Project-URL: Bug Reports, https://github.com/Open-DataFlow/DataFlow-KG/issues
+Keywords: Artificial Intelligence,Knowledge Graph
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: Free For Educational Use
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: <4,>=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.0.0
+Requires-Dist: datasets
+Requires-Dist: scipy
+Requires-Dist: torch
+Requires-Dist: torchvision
+Requires-Dist: torchaudio
+Requires-Dist: tqdm
+Requires-Dist: transformers<4.54.0
+Requires-Dist: accelerate
+Requires-Dist: rapidfuzz
+Requires-Dist: colorlog
+Requires-Dist: appdirs
+Requires-Dist: datasketch
+Requires-Dist: httpx[socks]
+Requires-Dist: modelscope
+Requires-Dist: addict
+Requires-Dist: pytest
+Requires-Dist: rich
+Requires-Dist: pydantic
+Requires-Dist: nltk
+Requires-Dist: colorama
+Requires-Dist: json5
+Requires-Dist: tiktoken
+Requires-Dist: sqlglot
+Requires-Dist: gradio>5
+Requires-Dist: fasttext-wheel
+Requires-Dist: openai
+Requires-Dist: sentencepiece
+Requires-Dist: datasketch
+Requires-Dist: presidio_analyzer[transformers]
+Requires-Dist: vendi-score==0.0.3
+Requires-Dist: google-api-core
+Requires-Dist: google-api-python-client
+Requires-Dist: contractions
+Requires-Dist: cookiecutter
+Requires-Dist: trafilatura
+Requires-Dist: lxml_html_clean
+Requires-Dist: pymupdf
+Requires-Dist: cloudpickle
+Requires-Dist: pandas
+Requires-Dist: google-cloud-aiplatform>=1.55
+Requires-Dist: google-cloud-bigquery
+Requires-Dist: google-genai
+Requires-Dist: gcsfs
+Requires-Dist: networkx
+Requires-Dist: pyvis
+Provides-Extra: vllm
+Requires-Dist: vllm<=0.9.2,>=0.7.0; extra == "vllm"
+Requires-Dist: numpy<2.0.0; extra == "vllm"
+Provides-Extra: vllm07
+Requires-Dist: vllm<0.8; extra == "vllm07"
+Requires-Dist: numpy<2.0.0; extra == "vllm07"
+Provides-Extra: vllm08
+Requires-Dist: vllm<0.9; extra == "vllm08"
+Provides-Extra: kbc
+Requires-Dist: vllm==0.6.3; extra == "kbc"
+Requires-Dist: mineru[pipeline]==2.0.6; extra == "kbc"
+Provides-Extra: mineru
+Requires-Dist: mineru[all]; extra == "mineru"
+Requires-Dist: numpy<2.0.0,>=1.24; extra == "mineru"
+Requires-Dist: sglang[all]>=0.4.8; extra == "mineru"
+Requires-Dist: pypdf; extra == "mineru"
+Requires-Dist: reportlab; extra == "mineru"
+Provides-Extra: myscale
+Requires-Dist: clickhouse-driver; extra == "myscale"
+Provides-Extra: sglang
+Requires-Dist: sglang[all]; extra == "sglang"
+Provides-Extra: litellm
+Requires-Dist: litellm<2.0.0,>=1.70.0; extra == "litellm"
+Provides-Extra: audio
+Requires-Dist: librosa; extra == "audio"
+Provides-Extra: vectorsql
+Requires-Dist: sqlite-vec; extra == "vectorsql"
+Requires-Dist: sqlite-lembed; extra == "vectorsql"
+Requires-Dist: sentence_transformers; extra == "vectorsql"
+Provides-Extra: pdf2model
+Requires-Dist: llamafactory[metrics,torch]>=0.9.0; extra == "pdf2model"
+Requires-Dist: vllm<0.9.2,>=0.7.0; extra == "pdf2model"
+Requires-Dist: numpy<2.0.0,>=1.24; extra == "pdf2model"
+Requires-Dist: mineru[pipeline]; extra == "pdf2model"
+Requires-Dist: mineru-vl-utils; extra == "pdf2model"
+Provides-Extra: eval
+Requires-Dist: vllm<0.9.2,>=0.7.0; extra == "eval"
+Provides-Extra: rag
+Requires-Dist: lightrag-hku; extra == "rag"
+Requires-Dist: asyncio; extra == "rag"
+Dynamic: license-file
+
+# DataFlow Knowledge Graph
+*Knowledge graph data preparation with DataFlow style operators and pipelines*
+
+<p align="center">
+  <img src="static/dataflow-KG%20framework.png" alt="DataFlow-KG framework" width="100%">
+</p>
+
+<p align="center">
+  <b>DataFlow Knowledge Graph</b>: An LLM-Driven Knowledge Graph Processing Library
+</p>
+
+<p align="center">
+  Build, enrich, reason over, and operationalize knowledge graphs with composable operators.
+</p>
+
+<p align="center">
+  <a href="https://github.com/OpenDCAI/DataFlow-KG">GitHub</a> |
+  <a href="https://zhp-li197.github.io/DataFlow-KG-Doc/zh/">Documentation</a> |
+  <a href="README.zh.md">中文 README</a>
+</p>
+
+---
+
+## 0. News
+
+## 1. 🤖 Overview
+
+**DataFlow-KG** (short for DataFlow Knowledge Graph) is an LLM-driven knowledge graph processing library built on top of the [DataFlow](https://github.com/OpenDCAI/DataFlow) ecosystem. It is designed to provide reusable, extensible, and modular operators for knowledge graph construction, reasoning, retrieval, querying, and domain-specific applications. The original [DataFlow](https://github.com/OpenDCAI/DataFlow) project provides a clean, elegant, and highly extensible foundation for building practical data-centric LLM workflows.
+
+Rather than treating KG workflows as isolated scripts, DataFlow-KG organizes graph capabilities into operator packages by graph type and application scenario. These operators can be composed into larger pipelines, including but not limited to:
+
+- knowledge graph construction
+- graph reasoning
+- graph retrieval
+- domain-specific knowledge graph applications
+
+DataFlow-KG aims to serve as a unified infrastructure layer for research and development on graph-centric LLM applications.
+
+
+## 2. ✨ Key Features
+
+### 2.1. Modular Operator Library for KG Workflows
+DataFlow-KG provides reusable operators that can be flexibly composed into pipelines for graph construction, graph enrichment, reasoning, retrieval, and task-specific graph processing. Operators are not standalone utilities. They are designed to be assembled into end-to-end workflows, enabling scalable and reproducible graph data engineering.
+
+### 2.2 Unified Support for Multiple KG Paradigms
+The library supports a broad range of graph settings in one framework, including general KG, commonsense KG, temporal KG, multimodal KG, hyper-relational KG, Graph RAG, and domain-specific KGs. As an extension of DataFlow, DataFlow-KG follows the same design philosophy of composable operators and pipeline-based processing, making it easy to integrate with broader data preparation workflows.
+
+### 2.3. Research-to-Application Coverage
+The framework is designed for both research scenarios and practical vertical applications, supporting graph processing tasks from foundational KG construction to specialized domain deployment.
+
+
+## 3. 🔍 Installation
+
+### 3.1. Create and activate a Python environment
+
+```bash
+conda create -n dfkg python=3.10
+conda activate dfkg
+````
+
+### 3.2. Install DataFlow-KG
+
+```bash
+pip install uv
+uv pip install dataflow-kg
+```
+
+If you want to enable **local GPU inference**, use:
+
+```bash
+conda create -n dfkg python=3.10
+conda activate dfkg
+
+pip install uv
+uv pip install dataflow-kg[vllm]
+```
+
+> DataFlow-KG supports Python >= 3.10.
+
+### 3.3. Verify the installation
+
+You can check whether the installation is successful with:
+
+```bash
+dfkg -v
+```
+
+If the installation is correct and DataFlow-KG is the latest release, you will see something like:
+
+```log
+open-dataflow-kg codebase version: 0.9.0
+        Checking for updates...
+        Local version:  0.9.0
+        PyPI newest version:  0.9.0
+        You are using the latest version: 0.9.0.
+```
+
+In addition, the `dfkg env` command can be used to inspect the current hardware and software environment, which is useful for bug reporting:
+
+```bash
+dfkg env
+```
+
+
+## 4. 🚀 Quickstart
+
+DataFlow-KG follows a **code generation + custom modification + script execution** workflow.  In practice, you initialize a project with the CLI, customize the generated pipeline script if needed, and then run the Python file to execute your workflow.
+
+You can get started in **three steps**.
+
+### 4.1. Initialize a project
+
+Run the following command in an empty directory:
+
+```bash
+dfkg init
+````
+
+### 4.2. Choose a pipeline type
+
+Pipelines with the same name across different folders are usually incremental variants with different dependency requirements:
+
+| Directory       | Required Resources    |
+| --------------- | --------------------- |
+| `api_pipelines` | CPU + LLM API         |
+| `gpu_pipelines` | CPU + API + local GPU |
+
+> **Tip:** If you are new to DataFlow-KG, start with `api_pipelines`.
+> Later, if you have a local GPU, you can replace `LLMServing` with a local model backend.
+
+
+### 4.3. Run your first pipeline
+
+Go into any pipeline directory, for example:
+
+```bash
+cd api_pipelines
+```
+
+Open one of the generated Python pipeline files. In most cases, you only need to check two configurations:
+
+#### 4.3.1 Input data path
+
+```python
+self.storage = FileStorage(
+    first_entry_file_name="<path_to_dataset>"
+)
+```
+
+By default, this points to the provided example dataset, so you can run it directly.
+You can also replace it with your own dataset path.
+
+#### 4.3.2 LLM serving configuration
+
+If you are using an API-based serving backend, set the API key first.
+
+**Linux / macOS**
+
+```bash
+export DF_API_KEY=sk-xxxxx
+```
+
+**Windows CMD**
+
+```bat
+set DF_API_KEY=sk-xxxxx
+```
+
+**PowerShell**
+
+```powershell
+$env:DF_API_KEY="sk-xxxxx"
+```
+
+Then run the pipeline script:
+
+```bash
+python xxx_pipeline.py
+```
+
+---
+
+
+
+## 5. 📚 Licence
+
+DataFlow-KG is released under the **Apache License 2.0**.
+
+
+
+## 6. 🎓 Citation
+If you use DataFlow-KG in your research, please cite:
+
+```bibtex
+@misc{dataflowkg2026,
+  title={DataFlow-KG: LLM-Driven Knowledge Graph Processing Library},
+  author={DataFlow-KG Team},
+  year={2026},
+  howpublished={\url{https://github.com/OpenDCAI/DataFlow-KG}}
+}
+```