Skip to content

Commit

Permalink
Merge branch 'pybind11' of https://github.com/easy-graph/Easy-Graph i…
Browse files Browse the repository at this point in the history
…nto pybind11
  • Loading branch information
yizhihenpidehou committed Dec 12, 2023
2 parents 787f716 + d17d0de commit a1eec6b
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Copyright (C) <2020-2023> by DataNET Group, Fudan University

Introduction
------------
EasyGraph is an open-source graph processing library. It is mainly written in Python and supports analysis for undirected graphs and directed graphs. EasyGraph supports various formats of graph data and covers a series of important graph mining algorithms for community detection, structural hole spanner detection, graph embedding, and motif detection. Moreover, EasyGraph implements some key elements using C++ and introduces multiprocessing optimization to achieve better efficiency.
**EasyGraph** is an open-source network analysis library. It is mainly written in Python and supports analysis for undirected networks and directed networks. EasyGraph supports various formats of network data and covers a series of important network analysis algorithms for community detection, structural hole spanner detection, network embedding, and motif detection. Moreover, EasyGraph implements some key elements using C++ and introduces multiprocessing optimization to achieve better efficiency.

News
----
Expand All @@ -43,23 +43,23 @@ Install
.. In the meantime, here's a work around you can try to install the latest version of easygraph on your machine:
Prerequisites
- **Prerequisites**

`3.8 <= Python <= 3.11` is required.
``3.8 <= Python <= 3.11`` is required.

.. Installation with ``pip`` (outdated)
Installation with ``pip``
- **Installation with** ``pip``

.. code::
$ pip install --upgrade Python-EasyGraph
The conda package is no longer updated or maintained.

If you've installed `EasyGraph` this way before, please uninstall it with `conda` and install it with `pip`.
If you've installed EasyGraph this way before, please uninstall it with ``conda`` and install it with ``pip``.

If prebuilt `EasyGraph` wheels are not supported for your platform (OS / CPU arch, check `here <https://pypi.org/simple/python-easygraph/>`_), you can build it locally this way:
If prebuilt EasyGraph wheels are not supported for your platform (OS / CPU arch, check `here <https://pypi.org/simple/python-easygraph/>`_), you can build it locally this way:

.. code:: bash
Expand All @@ -68,13 +68,13 @@ If prebuilt `EasyGraph` wheels are not supported for your platform (OS / CPU arc
python3 setup.py build_ext
python3 setup.py install
Hint
- **Hint**

EasyGraph uses 1.12.1 <= `PyTorch <https://pytorch.org/get-started/locally/>`_ < 2.0 for machine
learning functions.
Note that this does not prevent your from running non-machine learning functions normally,
if there is no PyTorch in your environment.
But you will receive some warnings which remind you some unavailable modules when they depend on it.
But you will receive some warnings which remind you some unavailable modules when they depend on it.

Simple Example
--------------
Expand Down

0 comments on commit a1eec6b

Please sign in to comment.