Skip to content

Commit

Permalink
[Doc] Enhance the ReadMe with additional information about the GraphA…
Browse files Browse the repository at this point in the history
…r libraries (#349)
  • Loading branch information
lixueclaire authored Jan 30, 2024
1 parent 2b0395e commit 5d2ab18
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 5d2ab18

Please sign in to comment.