Skip to content

Commit

Permalink
tuning community readme, found a problem in algorithm readme
Browse files Browse the repository at this point in the history
  • Loading branch information
acostadon committed Jul 12, 2022
1 parent 924ff2d commit c35c97c
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 8 deletions.
5 changes: 2 additions & 3 deletions notebooks/algorithms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@ This repository contains a collection of Jupyter Notebooks that outline how to r
| | [Betweenness](centrality/Betweenness.ipynb) | Compute both Edge and Vertex Betweenness centrality |
| | [Degree](centrality/Degree.ipynb) | Compute Degree Centraility for each vertex |
| | [Eigenvector](centrality/Eigenvector.ipynb) | Compute Eigenvector for every vertex |

<!-- | Community | | |
| Community | | |
| | [Louvain](community/Louvain.ipynb) and Leiden | Identify clusters in a graph using both the Louvain and Leiden algorithms |
| | [ECG](community/ECG.ipynb) | Identify clusters in a graph using the Ensemble Clustering for Graph |
| | [K-Truss](community/ktruss.ipynb) | Extracts the K-Truss cluster |
| | [Spectral-Clustering](community/Spectral-Clustering.ipynb) | Identify clusters in a graph using Spectral Clustering with both<br> - Balanced Cut<br> - Modularity Modularity |
| | [Subgraph Extraction](community/Subgraph-Extraction.ipynb) | Compute a subgraph of the existing graph including only the specified vertices |
| | [Triangle Counting](community/Triangle-Counting.ipynb) | Count the number of Triangle in a graph |
| Components | | |
<!--| Components | | |
| | [Connected Components](components/ConnectedComponents.ipynb) | Find weakly and strongly connected components in a graph |
| Core | | |
| | [K-Core](cores/kcore.ipynb) | Extracts the K-core cluster |
Expand Down
10 changes: 5 additions & 5 deletions notebooks/algorithms/centrality/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ But which vertices are most important? The answer depends on which measure/algor

|Algorithm |Notebooks Containing |Description |
| --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
|Degree Centrality| [Centrality](centrality/Centrality.ipynb), [Degree](centrality/Degree.ipynb) |Measure based on counting direct connections for each vertex|
|Betweenness Centrality| [Centrality](centrality/Centrality.ipynb), [Betweenness](centrality/Betweenness.ipynb) |Number of shortest paths through the vertex|
|Eigenvector Centrality|[Centrality](centrality/Centrality.ipynb), [Eigenvector](centrality/Eigenvector.ipynb)|Measure of connectivity to other important vertices (which also have high connectivity) often referred to as the influence measure of a vertex|
|Katz Centrality|[Centrality](centrality/Centrality.ipynb), [Katz](centrality/Katz.ipynb) |Similar to Eigenvector but has tweaks to measure more weakly connected graph |
|Pagerank|[Centrality](centrality/Centrality.ipynb), [Pagerank](../../link_analysis/Pagerank.ipynb) |Classified as both a link analysis and centrality measure by quantifying incoming links from central vertices. |
|Degree Centrality| [Centrality](./Centrality.ipynb), [Degree](centrality/Degree.ipynb) |Measure based on counting direct connections for each vertex|
|Betweenness Centrality| [Centrality](./Centrality.ipynb), [Betweenness](centrality/Betweenness.ipynb) |Number of shortest paths through the vertex|
|Eigenvector Centrality|[Centrality](./Centrality.ipynb), [Eigenvector](./Eigenvector.ipynb)|Measure of connectivity to other important vertices (which also have high connectivity) often referred to as the influence measure of a vertex|
|Katz Centrality|[Centrality](./Centrality.ipynb), [Katz](./Katz.ipynb) |Similar to Eigenvector but has tweaks to measure more weakly connected graph |
|Pagerank|[Centrality](./Centrality.ipynb), [Pagerank](../../link_analysis/Pagerank.ipynb) |Classified as both a link analysis and centrality measure by quantifying incoming links from central vertices. |

[System Requirements](../../README.md#requirements)

Expand Down
43 changes: 43 additions & 0 deletions notebooks/algorithms/community/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

# cuGraph Community Notebooks

<img src="../../img/zachary_graph_comm.png" width="35%"/>

cuGraph Community notebooks contain a collection of Jupyter Notebooks with algorithms that identify related groups of nodes within the graph:

* Louvain, Leiden ECG, K-Truss, and Spectral Clustering all identify clusters or tightly connected vertices.
* Subgraph Extraction pulls the new sub-graph formed given a set of vertices and returning only the edges contained between them.
* Finally Triangle counting gives an important metric for quantifying the overall graph connectivity by counting fully connected triples.

## Summary

| Algorithm | Notebook | Description |
| --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| | | |
| | [Louvain](community/Louvain.ipynb) and Leiden | Identify clusters in a graph using both the Louvain and Leiden algorithms |
| | [ECG](community/ECG.ipynb) | Identify clusters in a graph using the Ensemble Clustering for Graph |
| | [K-Truss](community/ktruss.ipynb) | Extracts the K-Truss cluster |
| | [Spectral-Clustering](community/Spectral-Clustering.ipynb) | Identify clusters in a graph using Spectral Clustering with both<br> - Balanced Cut<br> - Modularity Modularity |
| | [Subgraph Extraction](community/Subgraph-Extraction.ipynb) | Compute a subgraph of the existing graph including only the specified vertices |
| | [Triangle Counting](community/Triangle-Counting.ipynb) | Count the number of Triangle in a graph |



[System Requirements](../../README.md#requirements)

| Author Credit | Date | Update | cuGraph Version | Test Hardware |
| --------------|------------|------------------|-----------------|----------------|
| Brad Rees | 04/19/2021 | created | 0.19 | GV100, CUDA 11.0
| Don Acosta | 07/05/2022 | tested / updated | 22.08 nightly | DGX Tesla V100 CUDA 11.5

## Copyright

Copyright (c) 2019-2022, NVIDIA CORPORATION. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

![RAPIDS](../../img/rapids_logo.png)
Binary file added notebooks/img/zachary_graph_comm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c35c97c

Please sign in to comment.