Skip to content

MAINT: updated readme with conda installation guide #71

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

Merged
dschult merged 6 commits into from
Jul 27, 2024
Merged

MAINT: updated readme with conda installation guide #71

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
85f2463
updated readme
Schefflera-Arboricola Jul 17, 2024
70e4ea6
Update README.md
Schefflera-Arboricola Jul 25, 2024
c1ca395
style fix
Schefflera-Arboricola Jul 25, 2024
e60ebf7
restructuring
Schefflera-Arboricola Jul 26, 2024
875df19
mv comments to different line
Schefflera-Arboricola Jul 26, 2024
758965d
temporary fix
Schefflera-Arboricola Jul 27, 2024
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ nx-parallel is a NetworkX backend that uses joblib for parallelization. This pro
<details>
<summary>Script used to generate the above list</summary>

```py
```
import _nx_parallel as nxp
d = nxp.get_funcs_info() # temporarily add `from .update_get_info import *` to _nx_parallel/__init__.py
for func in d:
Expand Down Expand Up @@ -131,8 +131,12 @@ nxp.betweenness_centrality(H)

```py
# using `name` parameter - nx-parallel as an independent package
nxp.all_pairs_node_connectivity(H) # runs the parallel implementation in `connectivity/connectivity`
nxp.approximate_all_pairs_node_connectivity(H) # runs the parallel implementation in `approximation/connectivity`
nxp.all_pairs_node_connectivity(
H
) # runs the parallel implementation in `connectivity/connectivity`
nxp.approximate_all_pairs_node_connectivity(
H
) # runs the parallel implementation in `approximation/connectivity`
```

Also, if you are using nx-parallel as a backend then mentioning the subpackage to which the algorithm belongs is recommended to ensure that networkx dispatches to the correct implementation. For example:
Expand Down