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

Commit 532a213

Browse files
authored
[WIP] Adding new sections (#699)
* [WIP] Adding preprocessing section * add similarity section * similarity section * add to index * add similarity to top * add cosine * add euclidean
1 parent 361e204 commit 532a213

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

doc/asciidoc/index.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The guide covers the following areas:
2121
* <<algorithms-centrality>> -- A detailed guide to each of the centrality algorithms, including use-cases and examples.
2222
* <<algorithms-community>> -- A detailed guide to each of the community detection algorithms, including use-cases and examples.
2323
* <<algorithms-path-finding>> -- A detailed guide to each of the path finding algorithms, including use-cases and examples.
24+
* <<algorithms-similarity>> -- A detailed guide to each of the similarity algorithms, including use-cases and examples.
2425
2526
[[introduction]]
2627
== Introduction
@@ -62,6 +63,8 @@ include::../../target/generated-documentation/documentation.csv[]
6263
include::algorithms-centrality.adoc[leveloffset=1]
6364
include::algorithms-community.adoc[leveloffset=1]
6465
include::algorithms-path-finding.adoc[leveloffset=1]
66+
include::algorithms-preprocessing.adoc[leveloffset=1]
67+
include::algorithms-similarity.adoc[leveloffset=1]
6568

6669
ifndef::env-docs[]
6770
== Implementers section

readme.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,20 @@ These algorithms help find the shortest path or evaluate the availability and qu
6262
* <<algorithms-yens-k-shortest-path, Yen’s K-shortest paths>> (`algo.kShortestPaths`)
6363
* <<algorithms-random-walk, Random Walk>> (`algo.randomWalk`)
6464

65+
=== Similarity
66+
67+
These algorithms help calculate the similarity of nodes:
68+
69+
* <<algorithms-similarity-jaccard, Jaccard Similarity>> (`algo.similarity.jaccard`)
70+
* <<algorithms-similarity-cosine, Cosine Similarity>> (`algo.similarity.cosine`)
71+
* <<algorithms-similarity-euclidean, Euclidean Distance>> (`algo.similarity.euclidean`)
72+
73+
=== Preprocessing
74+
75+
These are utility functions and procedures that transform data for use further along the data pipeline:
76+
77+
** <<algorithms-one-hot-encoding, One Hot Encoding>> (`algo.ml.oneHotEncoding`)
78+
6579
// end::algorithms[]
6680

6781
These procedures work either on the whole graph, or on a subgraph filtered by label and relationship-type.

0 commit comments

Comments
 (0)