Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: reformat doc #36

Merged
merged 5 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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: [[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"/>

12 changes: 6 additions & 6 deletions hugegraph-llm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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:
Expand Down
1 change: 1 addition & 0 deletions hugegraph-ml/README.md
liuxiaocs7 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

6 changes: 3 additions & 3 deletions hugegraph-python-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading