This is an automated email from the ASF dual-hosted git repository.
ming pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-ai.git
The following commit(s) were added to refs/heads/main by this push:
new f9fb45f chore: reformat doc (#36)
f9fb45f is described below
commit f9fb45f2033622860484939f36accc86ad314860
Author: Liu Xiao <[email protected]>
AuthorDate: Mon Apr 15 12:38:55 2024 +0800
chore: reformat doc (#36)
* fix: update doc
* test
* add empty file for hugegraph-ml
* revert changes in ci
* remove header
---
README.md | 12 ++++++++----
hugegraph-llm/README.md | 12 ++++++------
hugegraph-ml/README.md | 1 +
hugegraph-python-client/README.md | 6 +++---
4 files changed, 18 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 3209f58..9328561 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# hugegraph-ai
+
[](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!
[](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:
[[email protected]](mailto:[email protected])
([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/)
only)
- WeChat public account: Apache HugeGraph, welcome to scan this QR code to
follow us.
<img
src="https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png";
alt="QR png" width="350"/>
-
diff --git a/hugegraph-llm/README.md b/hugegraph-llm/README.md
index 493b2e7..244261d 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/README.md b/hugegraph-ml/README.md
new file mode 100644
index 0000000..0519ecb
--- /dev/null
+++ b/hugegraph-ml/README.md
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/hugegraph-python-client/README.md
b/hugegraph-python-client/README.md
index ff15a42..ba59075 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
![https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png"](https://raw.githubusercontent.com/apache/incubator-hugegraph-doc/master/assets/images/wechat.png"){kind=link}