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.

Sign up for GitHub

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

Jump to bottom

Docs: typo and clarity updates #1092

Merged
merged 1 commit into from
Feb 20, 2024
Merged

Docs: typo and clarity updates #1092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/source/benchmarks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Rustworkx Comparison Benchmarks With Other Libraries
****************************************************

rustworkx is competitive against other popular graph libraries for Python. We compared rustworkx to the igraph, graph-tools and NetworkIt libraries `in a benchmark consisting of four tasks available on Github for reproducibility <https://github.com/mtreinish/retworkx-comparison-benchmarks>`__ . We report the results from a machine with an Intel(R) i9-9900K CPU at 3.60GHz with eight cores, 16 theads, and 32GB of RAM avaialble.
rustworkx is competitive against other popular graph libraries for Python. We compared rustworkx to the igraph, graph-tools and NetworkIt libraries `in a benchmark consisting of four tasks available on Github for reproducibility <https://github.com/mtreinish/retworkx-comparison-benchmarks>`__. We report the results from a machine with an Intel(R) i9-9900K CPU at 3.60GHz with eight cores, 16 theads, and 32GB of RAM avaialble.

Graph Creation
==============
Expand All @@ -28,7 +28,7 @@ The third benchmark is to calculate the distance among all nodes in a weighted g
Subgraph Isomorphism
====================

Lastly, the fourth benchamrk is about graph isomorphism. We compare the time to answer if pairs of graphs from the ARG Database are subgraph-isomorphic (De Santo et al., 2003). See :func:`~rustworkx.is_subgraph_isomorphic` for more information on the benchmarked function.
Lastly, the fourth benchmark is about graph isomorphism. We compare the time to answer if pairs of graphs from the ARG Database are subgraph-isomorphic (De Santo et al., 2003). See :func:`~rustworkx.is_subgraph_isomorphic` for more information on the benchmarked function.

.. image:: /images/subgraph_isomorphism.svg

Expand Down
10 changes: 5 additions & 5 deletions docs/source/networkx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Some Key Differences
rustworkx (as the name implies) was inspired by networkx and the goal of the
project is to provide a similar level of functionality and utility to what
networkx offers but with much faster performance. However, because of
limitations in the boundary between rust and python, different design
decisions, and other differences the libraries are not identical.
limitations in the boundary between rust and python, design
decisions and other aspects of the libraries are not identical.

The biggest difference to keep in mind is networkx is a very dynamic in how it
can be used. It allows you to treat a graph object associatively (like a python
Expand Down Expand Up @@ -411,9 +411,9 @@ networkx graph then you can use :func:`rustworkx.networkx_converter` to convert
that networkx ``Graph`` object into an equivalent rustworkx
:class:`~rustworkx.PyGraph` or :class:`~rustworkx.PyDiGraph` object. Note that
networkx is **not** a dependency for rustworkx and you are responsible for
installing networkx to use this function. Accordingly, there is not equivalent
function provided to convert the reverse direction (because doing so would add
an unwanted dependency on networkx, even an optional one) but writing such a
installing networkx to use this function. Accordingly, there isn't an equivalent
function provided to convert in the reverse direction (because doing so would add
an unwanted dependency on networkx, even if it is an optional one). However, writing such a
function is straightforward, for example::

import networkx as nx
Expand Down
Loading