Skip to content
This repository was archived by the owner on Apr 22, 2020. It is now read-only.

Commit 1f27da0

Browse files
authored
refactoring intro, named graphs, projected graph model (#850)
* refactoring intro, named graphs, projected graph model * more explanation around named graphs * make the projected graph pages in their own right * explain the label + relationship type projection * explain duplicate rels * the text sounded confusing - rewording * move named graph under projected graph model and added installation instructions for Neo4j Desktop * section instead of chapter * move named graph out of intro toc * edit proj graph section * edit cypher proj page * newer image for projected graph model * formatting
1 parent 277874c commit 1f27da0

36 files changed

+534
-258
lines changed

doc/asciidoc/algorithms-centrality.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[algorithms-centrality]]
2+
// tag::header[]
23
= Centrality algorithms
4+
// end::header[]
35

46
ifdef::env-docs[]
57
[abstract]
@@ -11,6 +13,7 @@ endif::env-docs[]
1113
// todo introduction to graph algorithms, also say something about pregel & parallelization
1214
// todo sensible ordering
1315

16+
// tag::summary[]
1417
The following centrality algorithms determine the importance of distinct nodes in a network:
1518

1619
* <<algorithms-pagerank, PageRank>> (`algo.pageRank`)
@@ -20,6 +23,7 @@ The following centrality algorithms determine the importance of distinct nodes i
2023
* <<algorithms-harmonic-centrality, Harmonic Centrality>> (`algo.closeness.harmonic`)
2124
* <<algorithms-eigenvector, Eigenvector Centrality>> (`algo.eigenvector`)
2225
* <<algorithms-degree-centrality, Degree Centrality>> (`algo.degree`)
26+
// end::summary[]
2327

2428
include::pagerank.adoc[leveloffset=2]
2529

doc/asciidoc/algorithms-community.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[algorithms-community]]
2+
// tag::header[]
23
= Community detection algorithms
4+
// end::header[]
35

46
ifdef::env-docs[]
57
[abstract]
@@ -11,6 +13,7 @@ endif::env-docs[]
1113
// todo introduction to graph algorithms, also say something about pregel & parallelization
1214
// todo sensible ordering
1315

16+
// tag::summary[]
1417
The following community detection algorithms evaluate how a group is clustered or partitioned, as well as its tendency to strengthen or break apart:
1518

1619
* <<algorithms-louvain, Louvain>> (`algo.louvain`)
@@ -19,6 +22,7 @@ The following community detection algorithms evaluate how a group is clustered o
1922
* <<algorithms-strongly-connected-components, Strongly Connected Components>> (`algo.scc`)
2023
* <<algorithms-triangle-count-clustering-coefficient, Triangle Counting / Clustering Coefficient>> (`algo.triangleCount`)
2124
* <<algorithms-balanced-triads, Balanced Triads>> (`algo.balancedTriads`)
25+
// end::summary[]
2226

2327
include::louvain.adoc[leveloffset=2]
2428

doc/asciidoc/algorithms-link-prediction.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[algorithms-linkprediction]]
2+
// tag::header[]
23
= Link Prediction algorithms
4+
// end::header[]
35

46
ifdef::env-docs[]
57
[abstract]
@@ -8,6 +10,8 @@ This chapter provides explanations and examples for each of the link prediction
810
--
911
endif::env-docs[]
1012

13+
// tag::summary[]
14+
1115
These algorithms help determine the closeness of a pair of nodes.
1216
We would then use the computed scores as part of a link prediction solution:
1317

@@ -17,6 +21,8 @@ We would then use the computed scores as part of a link prediction solution:
1721
* <<algorithms-linkprediction-resource-allocation, Resource Allocation>> (`algo.linkprediction.resourceAllocation`)
1822
* <<algorithms-linkprediction-same-community, Same Community>> (`algo.linkprediction.sameCommunity`)
1923
* <<algorithms-linkprediction-total-neighbors, Total Neighbors>> (`algo.linkprediction.totalNeighbors`)
24+
// end::summary[]
25+
2026

2127
include::linkprediction-adamic-adar.adoc[leveloffset=2]
2228
include::linkprediction-common-neighbors.adoc[leveloffset=2]

doc/asciidoc/algorithms-path-finding.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[algorithms-path-finding]]
2+
// tag::header[]
23
= Path finding algorithms
4+
// end::header[]
35

46
ifdef::env-docs[]
57
[abstract]
@@ -11,6 +13,7 @@ endif::env-docs[]
1113
// todo introduction to graph algorithms, also say something about pregel & parallelization
1214
// todo sensible ordering
1315

16+
// tag::summary[]
1417
The following path finding algorithms help find the shortest path or evaluate the availability and quality of routes:
1518

1619
* <<algorithms-minimum-weight-spanning-tree, Minimum Weight Spanning Tree>> (`algo.mst`)
@@ -20,6 +23,7 @@ The following path finding algorithms help find the shortest path or evaluate th
2023
* <<algorithms-a_star, A*>> (`algo.shortestPath.astar`)
2124
* <<algorithms-yens-k-shortest-path, Yen’s K-shortest paths>> (`algo.kShortestPaths`)
2225
* <<algorithms-random-walk, Random Walk>> (`algo.randomWalk`)
26+
// end::summary[]
2327

2428
include::minimum-weight-spanning-tree.adoc[leveloffset=2]
2529

doc/asciidoc/algorithms-preprocessing.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[algorithms-preprocessing]]
2+
// tag::header[]
23
= Preprocessing functions and procedures
4+
// end::header[]
35

46
ifdef::env-docs[]
57
[abstract]
@@ -9,8 +11,11 @@ This chapter provides an explanation and example for preprocessing functions and
911
endif::env-docs[]
1012

1113
//Edit this (and abstract above) when there is more than one sub-topic
14+
15+
// tag::summary[]
1216
The following feature and procedure can be used as part of the data preparation process:
1317

1418
* <<algorithms-one-hot-encoding, One Hot Encoding>> (`algo.ml.oneHotEncoding`)
19+
// end::summary[]
1520

1621
include::one-hot-encoding.adoc[leveloffset=2]

doc/asciidoc/algorithms-similarity.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[[algorithms-similarity]]
2+
// tag::header[]
23
= Similarity algorithms
4+
// end::header[]
35

46
ifdef::env-docs[]
57
[abstract]
@@ -8,13 +10,15 @@ This chapter provides explanations and examples for each of the similarity algor
810
--
911
endif::env-docs[]
1012

13+
// tag::summary[]
1114
These algorithms help calculate the similarity of nodes:
1215

1316
* <<algorithms-similarity-jaccard, Jaccard Similarity>> (`algo.similarity.jaccard`)
1417
* <<algorithms-similarity-cosine, Cosine Similarity>> (`algo.similarity.cosine`)
1518
* <<algorithms-similarity-pearson, Pearson Similarity>> (`algo.similarity.pearson`)
1619
* <<algorithms-similarity-euclidean, Euclidean Distance>> (`algo.similarity.euclidean`)
1720
* <<algorithms-similarity-overlap, Overlap Similarity>> (`algo.similarity.overlap`)
21+
// end::summary[]
1822

1923
include::similarity-jaccard.adoc[leveloffset=2]
2024
include::similarity-cosine.adoc[leveloffset=2]

doc/asciidoc/articlerank.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ include::scripts/articlerank.cypher[tag=huge-projection]
109109
[[algorithms-articlerank-cp]]
110110
== Cypher projection
111111

112-
include::cypher-projection.adoc[tag=explanation]
112+
include::projected-graph-model/cypher-projection.adoc[tag=explanation]
113113

114114
.Set `graph:'cypher'` in the config:
115115

doc/asciidoc/astar.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ include::scripts/astar.cypher[tag=stream-sample-graph]
8282
[[algorithms-a_star-cp]]
8383
== Cypher projection
8484

85-
include::cypher-projection.adoc[tag=explanation]
85+
include::projected-graph-model/cypher-projection.adoc[tag=explanation]
8686

8787
.Set `graph:'cypher'` in the config:
8888

doc/asciidoc/betweenness-centrality.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ include::betweenness-centrality-ra-brandes.adoc[leveloffset=3]
129129
[[algorithms-betweenness-centrality-cp]]
130130
== Cypher projection
131131

132-
include::cypher-projection.adoc[tag=explanation]
132+
include::projected-graph-model/cypher-projection.adoc[tag=explanation]
133133

134134
.Set `graph:'cypher'` in the config:
135135

doc/asciidoc/closeness-centrality.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ include::scripts/closeness-centrality.cypher[tag=huge-projection]
159159
[[algorithms-closeness-centrality-cp]]
160160
== Cypher projection
161161

162-
include::cypher-projection.adoc[tag=explanation]
162+
include::projected-graph-model/cypher-projection.adoc[tag=explanation]
163163

164164
.Set `graph:'cypher'` in the config:
165165

0 commit comments

Comments
 (0)