From be93aa4d9f47e7ca915229bd4a03aa1edc21e3c1 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Sat, 13 Apr 2024 18:51:21 +0800 Subject: [PATCH 1/5] fix: update doc --- .github/workflows/hugegraph-python-client.yml | 9 +++++---- README.md | 12 ++++++++---- hugegraph-llm/README.md | 12 ++++++------ hugegraph-ml/.gitkeep | 0 hugegraph-python-client/README.md | 6 +++--- 5 files changed, 22 insertions(+), 17 deletions(-) create mode 100644 hugegraph-ml/.gitkeep diff --git a/.github/workflows/hugegraph-python-client.yml b/.github/workflows/hugegraph-python-client.yml index 7754a592..9b51a696 100644 --- a/.github/workflows/hugegraph-python-client.yml +++ b/.github/workflows/hugegraph-python-client.yml @@ -10,12 +10,13 @@ jobs: build: runs-on: ubuntu-latest strategy: + fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10", "3.11"] + python-version: ["3.9", "3.10", "3.11", "3.12"] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} cache: 'pip' @@ -26,7 +27,7 @@ jobs: pip install -r ./hugegraph-python-client/requirements.txt - name: Prepare HugeGraph Server Environment run: | - docker run -d --name=graph -p 8080:8080 -e PASSWORD=admin hugegraph/hugegraph:1.2.0 + docker run -d --name=graph -p 8080:8080 -e PASSWORD=admin hugegraph/hugegraph:1.3.0 sleep 20 - name: Test example run: | diff --git a/README.md b/README.md index 3209f581..93285618 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # hugegraph-ai + [![License](https://img.shields.io/badge/license-Apache%202-0E78BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) `hugegraph-ai` aims to explore the integration of [HugeGraph](https://github.com/apache/hugegraph) with artificial @@ -7,6 +8,7 @@ in their projects. ## Modules + - [hugegraph-llm](./hugegraph-llm):The `hugegraph-llm` will house the implementation and research related to large language models. It will include runnable demos and can also be used as a third-party library, reducing the cost of using graph systems and the complexity of building knowledge graphs. Graph systems can help large models address challenges like timeliness @@ -19,24 +21,26 @@ to seamlessly connect with third-party graph-related ML frameworks. It is used to define graph structures and perform CRUD operations on graph data. Both the `hugegraph-llm` and `hugegraph-ml` modules will depend on this foundational library. + ## Contributing + - Welcome to contribute to HugeGraph, please see [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for more information. - Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process. - Code format: Please run [`./style/code_format_and_analysis.sh`](style/code_format_and_analysis.sh) to format your code before submitting a PR. - Thank you to all the people who already contributed to HugeGraph! [![contributors graph](https://contrib.rocks/image?repo=apache/incubator-hugegraph-ai)](https://github.com/apache/incubator-hugegraph-ai/graphs/contributors) + + ## License -hugegraph-ai is licensed under `Apache 2.0` License. +hugegraph-ai is licensed under [Apache 2.0 License](./LICENSE). -### Contact Us ---- +## Contact Us - [GitHub Issues](https://github.com/apache/incubator-hugegraph-ai/issues): Feedback on usage issues and functional requirements (quick response) - Feedback Email: [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only) - WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us. QR png - diff --git a/hugegraph-llm/README.md b/hugegraph-llm/README.md index 493b2e7e..244261d1 100644 --- a/hugegraph-llm/README.md +++ b/hugegraph-llm/README.md @@ -2,7 +2,7 @@ ## Summary -The hugegraph-llm is a tool for the implementation and research related to large language models. +The `hugegraph-llm` is a tool for the implementation and research related to large language models. This project includes runnable demos, it can also be used as a third-party library. As we know, graph systems can help large models address challenges like timeliness and hallucination, @@ -15,13 +15,13 @@ graph systems and large language models. 2. Use natural language to operate graph databases (gremlin) 3. Knowledge graph supplements answer context (RAG) -# Examples +## Examples -## Examples (knowledge graph construction by llm) +### Examples (knowledge graph construction by llm) -> 1. Start the HugeGraph database, you can do it via Docker. Refer to this [link](https://hub.docker.com/r/hugegraph/hugegraph) for guidance -> 2. Run example like `python hugegraph-llm/examples/build_kg_test.py` -> +1. Start the HugeGraph database, you can do it via Docker. Refer to this [link](https://hub.docker.com/r/hugegraph/hugegraph) for guidance +2. Run example like `python hugegraph-llm/examples/build_kg_test.py` + > Note: If you need a proxy to access OpenAI's API, please set your HTTP proxy in `build_kg_test.py`. The `KgBuilder` class is used to construct a knowledge graph. Here is a brief usage guide: diff --git a/hugegraph-ml/.gitkeep b/hugegraph-ml/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/hugegraph-python-client/README.md b/hugegraph-python-client/README.md index ff15a420..ba59075f 100644 --- a/hugegraph-python-client/README.md +++ b/hugegraph-python-client/README.md @@ -2,17 +2,17 @@ A Python SDK for Apache HugeGraph -# Installation +## Installation ```shell pip3 install hugegraph-python ``` -## Install from source +### Install from source release soon -# Examples +## Examples ```python from pyhugegraph.client import PyHugeClient From 4f38fbaaf40d48569131220e95d2057c019c169b Mon Sep 17 00:00:00 2001 From: liuxiao Date: Sat, 13 Apr 2024 18:58:58 +0800 Subject: [PATCH 2/5] test --- .github/workflows/hugegraph-python-client.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/hugegraph-python-client.yml b/.github/workflows/hugegraph-python-client.yml index 9b51a696..3873154b 100644 --- a/.github/workflows/hugegraph-python-client.yml +++ b/.github/workflows/hugegraph-python-client.yml @@ -27,7 +27,7 @@ jobs: pip install -r ./hugegraph-python-client/requirements.txt - name: Prepare HugeGraph Server Environment run: | - docker run -d --name=graph -p 8080:8080 -e PASSWORD=admin hugegraph/hugegraph:1.3.0 + docker run -d --name=graph -p 8080:8080 -e PASSWORD=admin hugegraph/hugegraph:1.2.0 sleep 20 - name: Test example run: | From 95e10f1ac6373db817486e70e3a7eb95b11c75c5 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Sat, 13 Apr 2024 19:04:45 +0800 Subject: [PATCH 3/5] add empty file for hugegraph-ml --- hugegraph-ml/.gitkeep | 0 hugegraph-ml/README.md | 17 +++++++++++++++++ 2 files changed, 17 insertions(+) delete mode 100644 hugegraph-ml/.gitkeep create mode 100644 hugegraph-ml/README.md diff --git a/hugegraph-ml/.gitkeep b/hugegraph-ml/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/hugegraph-ml/README.md b/hugegraph-ml/README.md new file mode 100644 index 00000000..ed79447c --- /dev/null +++ b/hugegraph-ml/README.md @@ -0,0 +1,17 @@ + + \ No newline at end of file From a6d912d4bf9a2b104f2f29b1d8158201339ff886 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Sat, 13 Apr 2024 19:48:29 +0800 Subject: [PATCH 4/5] revert changes in ci --- .github/workflows/hugegraph-python-client.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/hugegraph-python-client.yml b/.github/workflows/hugegraph-python-client.yml index 3873154b..7754a592 100644 --- a/.github/workflows/hugegraph-python-client.yml +++ b/.github/workflows/hugegraph-python-client.yml @@ -10,13 +10,12 @@ jobs: build: runs-on: ubuntu-latest strategy: - fail-fast: false matrix: - python-version: ["3.9", "3.10", "3.11", "3.12"] + python-version: ["3.8", "3.9", "3.10", "3.11"] steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} cache: 'pip' From 95634248b74e31b8297ac8e5b2525b128168e925 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 15 Apr 2024 00:47:16 +0800 Subject: [PATCH 5/5] remove header --- hugegraph-ml/README.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/hugegraph-ml/README.md b/hugegraph-ml/README.md index ed79447c..0519ecba 100644 --- a/hugegraph-ml/README.md +++ b/hugegraph-ml/README.md @@ -1,17 +1 @@ - \ No newline at end of file