Skip to content

Commit 933df71

Browse files
committed
fix: notes - last commit for GSoC2025
1 parent 0e69ba4 commit 933df71

10 files changed

+102
-98
lines changed

doc/source/community_detection_guide/notebooks/community_detection_algorithms.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"Modularity maximization methods are a prominent class of algorithms in community detection that aim to discover partitions of a network by optimizing a specific quality function called modularity.\n",
1111
"<div style=\"background-color: #e6ffe6; padding: 0px; border-radius: 5px;\">\n",
1212
" \n",
13-
"**NOTE:** You can find a more detailed explanation of **modularity** [here](./modularityZ.ipynb).\n",
13+
"_Note:_ You can find a more detailed explanation of **modularity** [here](./modularityZ.ipynb).\n",
1414
"\n",
1515
"</div>\n",
1616
"\n",
@@ -68,7 +68,7 @@
6868
"These methods don't require you to pre-specify the number of communities. Instead, you choose the final partition by cutting the dendrogram at a particular level, which defines the number and size of the resulting communities.\n",
6969
"<div style=\"background-color: #e6ffe6; padding: 0px; border-radius: 5px;\">\n",
7070
" \n",
71-
"**NOTE:** You can find a more detailed explanation of **hierarchical clustering** [here](./hierarchical_clustering.ipynb).\n",
71+
"_Note:_ You can find a more detailed explanation of **hierarchical clustering** [here](./hierarchical_clustering.ipynb).\n",
7272
"\n",
7373
"</div>\n",
7474
"\n",
@@ -145,7 +145,7 @@
145145
"\n",
146146
"- _When Simplicity and Interpretability of the Core Mechanism are Valued:_ The underlying principle of labels propagating and consolidating within dense regions is intuitive. For applications where a straightforward, graph-driven clustering method is preferred over complex optimization functions, LPA is a strong candidate.\n",
147147
"\n",
148-
"- _When Non-Overlapping Communities are Acceptable (or Required):_ The basic LPA assigns each node to exactly one community. If your domain or problem requires distinct, mutually exclusive groups, LPA naturally provides this. (Note: Variants exist for overlapping communities, but the standard LPA does not produce them.)\n"
148+
"- _When Non-Overlapping Communities are Acceptable (or Required):_ The basic LPA assigns each node to exactly one community. If your domain or problem requires distinct, mutually exclusive groups, LPA naturally provides this. (_Note:_ Variants exist for overlapping communities, but the standard LPA does not produce them.)\n"
149149
]
150150
},
151151
{
@@ -285,7 +285,7 @@
285285
"data": {
286286
"text/html": [
287287
"<!--| quarto-html-table-processing: none -->\n",
288-
"<table id=\"itables_75c81ab6_ca9f_4959_8b2f_473b29b55ef3\"><tbody><tr>\n",
288+
"<table id=\"itables_2086ef8c_9ee2_4b2c_9427_c3e259664091\"><tbody><tr>\n",
289289
" <td style=\"vertical-align:middle; text-align:left\">\n",
290290
" <a href=https://mwouts.github.io/itables/><svg class=\"main-svg\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"\n",
291291
"width=\"64\" viewBox=\"0 0 500 400\" style=\"font-family: 'Droid Sans', sans-serif;\">\n",
@@ -383,11 +383,11 @@
383383
"<script type=\"module\">\n",
384384
" const { ITable, jQuery: $ } = await import(window._datatables_src_for_itables_2_4_4);\n",
385385
"\n",
386-
" document.querySelectorAll(\"#itables_75c81ab6_ca9f_4959_8b2f_473b29b55ef3:not(.dataTable)\").forEach(table => {\n",
386+
" document.querySelectorAll(\"#itables_2086ef8c_9ee2_4b2c_9427_c3e259664091:not(.dataTable)\").forEach(table => {\n",
387387
" if (!(table instanceof HTMLTableElement))\n",
388388
" return;\n",
389389
"\n",
390-
" let dt_args = {\"scrollY\": \"300px\", \"scrollCollapse\": true, \"fixedColumns\": true, \"pageLength\": -1, \"layout\": {\"topStart\": \"pageLength\", \"topEnd\": \"search\", \"bottomStart\": \"info\", \"bottomEnd\": \"paging\"}, \"classes\": [\"display\", \"nowrap\"], \"text_in_header_can_be_selected\": true, \"style\": {\"table-layout\": \"auto\", \"width\": \"auto\", \"margin\": \"auto\", \"caption-side\": \"bottom\"}, \"order\": [], \"table_html\": \"<table><thead>\\n <tr style=\\\"text-align: right;\\\">\\n \\n <th>Method</th>\\n <th>Function in igraph (Python)</th>\\n <th>Directed Graph Support</th>\\n <th>Weighted Graph Support</th>\\n <th>Signed Graph Support</th>\\n <th>Sparse Graph Performance</th>\\n <th>Dense Graph Performance</th>\\n <th>Deterministic</th>\\n </tr>\\n </thead></table>\", \"data_json\": \"[[\\\"Edge Betweenness\\\", \\\"`Graph.community_edge_betweenness()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c (Slow for large)\\\", \\\"\\\\u2705\\\"], [\\\"Fast-Greedy\\\", \\\"`Graph.community_fastgreedy()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705 (Very efficient)\\\", \\\"\\\\u2705 (Can handle)\\\", \\\"\\\\u274c\\\"], [\\\"Fluid Communities\\\", \\\"`Graph.community_fluid_communities()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u274c (weights ignored)\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Infomap\\\", \\\"`Graph.community_infomap()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Label Propagation\\\", \\\"`Graph.community_label_propagation()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Leading Eigenvector\\\", \\\"`Graph.community_leading_eigenvector()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\"], [\\\"Leiden\\\", \\\"`Graph.community_leiden()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Louvain (Multilevel)\\\", \\\"`Graph.community_multilevel()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Spinglass\\\", \\\"`Graph.community_spinglass()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c (Slower)\\\", \\\"\\\\u274c\\\"], [\\\"Walktrap\\\", \\\"`Graph.community_walktrap()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\"], [\\\"Optimal Modularity\\\", \\\"`Graph.community_optimal_modularity()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u274c (Small graphs only)\\\", \\\"\\\\u274c (Small graphs only)\\\", \\\"\\\\u2705\\\"], [\\\"Voronoi\\\", \\\"`Graph.community_voronoi()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\"]]\"};\n",
390+
" let dt_args = {\"scrollY\": \"300px\", \"scrollCollapse\": true, \"fixedColumns\": true, \"pageLength\": -1, \"layout\": {\"topStart\": \"pageLength\", \"topEnd\": \"search\", \"bottomStart\": \"info\", \"bottomEnd\": \"paging\"}, \"text_in_header_can_be_selected\": true, \"classes\": [\"display\", \"nowrap\"], \"style\": {\"table-layout\": \"auto\", \"width\": \"auto\", \"margin\": \"auto\", \"caption-side\": \"bottom\"}, \"order\": [], \"table_html\": \"<table><thead>\\n <tr style=\\\"text-align: right;\\\">\\n \\n <th>Method</th>\\n <th>Function in igraph (Python)</th>\\n <th>Directed Graph Support</th>\\n <th>Weighted Graph Support</th>\\n <th>Signed Graph Support</th>\\n <th>Sparse Graph Performance</th>\\n <th>Dense Graph Performance</th>\\n <th>Deterministic</th>\\n </tr>\\n </thead></table>\", \"data_json\": \"[[\\\"Edge Betweenness\\\", \\\"`Graph.community_edge_betweenness()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c (Slow for large)\\\", \\\"\\\\u2705\\\"], [\\\"Fast-Greedy\\\", \\\"`Graph.community_fastgreedy()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705 (Very efficient)\\\", \\\"\\\\u2705 (Can handle)\\\", \\\"\\\\u274c\\\"], [\\\"Fluid Communities\\\", \\\"`Graph.community_fluid_communities()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u274c (weights ignored)\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Infomap\\\", \\\"`Graph.community_infomap()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Label Propagation\\\", \\\"`Graph.community_label_propagation()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Leading Eigenvector\\\", \\\"`Graph.community_leading_eigenvector()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\"], [\\\"Leiden\\\", \\\"`Graph.community_leiden()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Louvain (Multilevel)\\\", \\\"`Graph.community_multilevel()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\"], [\\\"Spinglass\\\", \\\"`Graph.community_spinglass()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c (Slower)\\\", \\\"\\\\u274c\\\"], [\\\"Walktrap\\\", \\\"`Graph.community_walktrap()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\"], [\\\"Optimal Modularity\\\", \\\"`Graph.community_optimal_modularity()`\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u274c (Small graphs only)\\\", \\\"\\\\u274c (Small graphs only)\\\", \\\"\\\\u2705\\\"], [\\\"Voronoi\\\", \\\"`Graph.community_voronoi()`\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u274c\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\", \\\"\\\\u2705\\\"]]\"};\n",
391391
" new ITable(table, dt_args);\n",
392392
" });\n",
393393
"</script>\n"

doc/source/community_detection_guide/notebooks/functions.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"id": "75c4b640-d999-4947-bdcd-4c2dc84b7466",
2828
"metadata": {},
2929
"source": [
30-
"*Note:* igraph has two stable plotting backends at the moment: Cairo and Matplotlib. It also has experimental support for plotly. The Cairo backend is dependent on the pycairo or cairocffi libraries that provide Python bindings to the popular Cairo library. In our case we want to use the matplotlib backend to avoid additional dependencies, so it is useful to fix the plotting.backend in the config in each notebook we want to use igraph's plotting functions.\n",
30+
"_Note:_ igraph has two stable plotting backends at the moment: Cairo and Matplotlib. It also has experimental support for plotly. The Cairo backend is dependent on the pycairo or cairocffi libraries that provide Python bindings to the popular Cairo library. In our case we want to use the matplotlib backend to avoid additional dependencies, so it is useful to fix the plotting.backend in the config in each notebook we want to use igraph's plotting functions.\n",
3131
"\n",
3232
"---\n",
3333
"Temporarily set the random state, restoring it afterwards.\n",

doc/source/community_detection_guide/notebooks/generating_and_visualizing_clusters.ipynb

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

doc/source/community_detection_guide/notebooks/hierarchical_clustering.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
"metadata": {},
6868
"source": [
6969
"#### Visualizing the dendrogram\n",
70-
"_NOTE:_ The orientation can be changed (e.g., \"top-bottom\", \"left-right\")"
70+
"_Note:_ The orientation can be changed (e.g., \"top-bottom\", \"left-right\")"
7171
]
7272
},
7373
{
@@ -105,7 +105,7 @@
105105
"The `as_clustering()` method returns a `VertexClustering` object, which represents the partition with the highest modularity found by the algorithm among all available partitions.\n",
106106
"<div style=\"background-color: #e6ffe6; border-radius: 5px;\">\n",
107107
" \n",
108-
"**NOTE:** You can find more details about how to work with clusterings [here](./working_with_clusterings.ipynb).\n",
108+
"_Note:_ You can find more details about how to work with clusterings [here](./working_with_clusterings.ipynb).\n",
109109
"\n",
110110
"</div>"
111111
]

doc/source/community_detection_guide/notebooks/initial_workflow.ipynb

Lines changed: 17 additions & 17 deletions
Large diffs are not rendered by default.

doc/source/community_detection_guide/notebooks/modularity.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@
243243
"id": "f3981bc5-f6bf-4b41-a168-cae9c17ec764",
244244
"metadata": {},
245245
"source": [
246-
"*Note:* Based on our previous analysis, the \"good\" partitioning yields a significantly higher modularity score. It is important to note, however, that a high modularity score is not always a definitive indicator of a better community partitioning, as was previously demonstrated with the Grid Graph [here](test_significance_of_community.ipynb).\n",
246+
"_Note:_ Based on our previous analysis, the \"good\" partitioning yields a significantly higher modularity score. It is important to note, however, that a high modularity score is not always a definitive indicator of a better community partitioning, as was previously demonstrated with the Grid Graph [here](test_significance_of_community.ipynb).\n",
247247
"\n",
248248
"## Directed modularity\n",
249249
"\n",

doc/source/community_detection_guide/notebooks/resolution.ipynb

Lines changed: 36 additions & 37 deletions
Large diffs are not rendered by default.

doc/source/community_detection_guide/notebooks/test_significance_of_community.ipynb

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

doc/source/community_detection_guide/notebooks/working_with_clusterings.ipynb

Lines changed: 20 additions & 15 deletions
Large diffs are not rendered by default.

doc/source/community_detection_guide/notebooks/working_with_directed_networks.ipynb

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)