From 5d2ab183e854e220ff1efc2f65d9cd21b463c211 Mon Sep 17 00:00:00 2001 From: lixueclaire Date: Tue, 30 Jan 2024 14:20:05 +0800 Subject: [PATCH] [Doc] Enhance the ReadMe with additional information about the GraphAr libraries (#349) --- README.rst | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index f7f48a67d..ad0cb4760 100644 --- a/README.rst +++ b/README.rst @@ -147,19 +147,27 @@ Take the "person knows person" edges to illustrate. Suppose the vertex chunk siz Building Libraries ------------------ -Libraries are provided for reading, writing and transforming files in GraphAr, -now the C++ library and the Spark library are available. And we are going to -provide libraries for more programming languages. +GraphAr offers a collection of libraries for the purpose of reading, writing and transforming files. +Currently, the following libraries are available, and plans are in place to expand support to additional programming language. The C++ Library ^^^^^^^^^^^^^^^ See `GraphAr C++ Library`_ for details about the building of the C++ library. +The Java Library +^^^^^^^^^^^^^^^^ +The GraphAr Java library is created with bindings to the C++ library (currently at version v0.10.0), utilizing [Alibaba-FastFFI](https://github.com/alibaba/fastFFI) for implementation. +See `GraphAr Java Library`_ for details about the building of the Java library. + The Spark Library ^^^^^^^^^^^^^^^^^ - See `GraphAr Spark Library`_ for details about the Spark library. +The PySpark Library +^^^^^^^^^^^^^^^^^^^ +The GraphAr PySpark library is developed as bindings to the GraphAr Spark library. +See `GraphAr PySpark Library`_ for details about the PySpark library. + Contributing ------------- @@ -233,8 +241,12 @@ Publication .. _GraphAr Spark Library: https://github.com/alibaba/GraphAr/tree/main/spark +.. _GraphAr PySpark Library: https://github.com/alibaba/GraphAr/tree/main/pyspark + .. _GraphAr C++ Library: https://github.com/alibaba/GraphAr/tree/main/cpp +.. _GraphAr Java Library: https://github.com/alibaba/GraphAr/tree/main/java + .. _example files: https://github.com/GraphScope/gar-test/blob/main/ldbc_sample/ .. _contribution guidelines: https://github.com/alibaba/GraphAr/tree/main/CONTRIBUTING.rst