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

Commit 4979085

Browse files
davidoliverSP2mneedham
authored andcommitted
Edit new algorithm documentation (#713)
* reintroduce random walk * edit Jaccard * edit Cosine * edit euclidean * edit one hot encoding * add first formula image
1 parent 4f0a00b commit 4979085

File tree

7 files changed

+229
-226
lines changed

7 files changed

+229
-226
lines changed

doc/asciidoc/algorithms-path-finding.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The following path finding algorithms help find the shortest path or evaluate th
1919
* <<algorithm-all-pairs-shortest-path, All Pairs Shortest Path>> (`algo.allShortestPaths`)
2020
* <<algorithms-a_star, A*>> (`algo.shortestPath.astar`)
2121
* <<algorithms-yens-k-shortest-path, Yen’s K-shortest paths>> (`algo.kShortestPaths`)
22+
* <<algorithms-random-walk, Random Walk>> (`algo.randomWalk`)
2223

2324
include::minimum-weight-spanning-tree.adoc[leveloffset=2]
2425

@@ -31,3 +32,5 @@ include::all-pairs-shortest-path.adoc[leveloffset=2]
3132
include::astar.adoc[leveloffset=2]
3233

3334
include::yens-k-shortest-paths.adoc[leveloffset=2]
35+
36+
include::random-walk.adoc[leveloffset=2]

doc/asciidoc/algorithms-preprocessing.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
ifdef::env-docs[]
55
[abstract]
66
--
7-
This chapter provides explanations and examples for each of the preprocessing functions and procedures in the Neo4j Graph Algorithms library.
7+
This chapter provides an explanation and example for preprocessing functions and procedures in the Neo4j Graph Algorithms library.
88
--
99
endif::env-docs[]
1010

11-
The following features and procedures can be used as part of the data preparation process:
11+
//Edit this (and abstract above) when there is more than one sub-topic
12+
The following feature and procedure can be used as part of the data preparation process:
1213

1314
* <<algorithms-one-hot-encoding, One Hot Encoding>> (`algo.ml.oneHotEncoding`)
1415

doc/asciidoc/one-hot-encoding.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ The One Hot Encoding function is used to convert categorical data into a numeric
1313
[[algorithms-one-hot-encoding-sample]]
1414
== One Hot Encoding sample
1515

16-
A One Hot Encoding will return a list equal to the length of the `available values`.
17-
A 1 will appear in that list for each of the `selected values`, and a 0 for any unselected values.
16+
One hot encoding will return a list equal to the length of the `available values`.
17+
In the list, `selected values` are represented by `1`, and `unselected values` are represented by `0`.
1818

19-
.The following will run the algorithm on hardcoded lists
19+
.The following will run the algorithm on hardcoded lists:
2020
[source, cypher]
2121
----
2222
include::scripts/one-hot-encoding.cypher[tag=basic]
@@ -26,7 +26,7 @@ include::scripts/one-hot-encoding.cypher[tag=basic]
2626
.Results
2727
[opts="header",cols="1"]
2828
|===
29-
| Vector
29+
| `vector`
3030
| [0,0,1]
3131
|===
3232
// end::basic-result[]
@@ -37,7 +37,7 @@ include::scripts/one-hot-encoding.cypher[tag=basic]
3737
include::scripts/one-hot-encoding.cypher[tag=create-sample-graph]
3838
----
3939

40-
.The following will return a one hot encoding for each user and the types of cuisine that they like
40+
.The following will return a one hot encoding for each user and the types of cuisine that they like:
4141
[source, cypher]
4242
----
4343
include::scripts/one-hot-encoding.cypher[tag=one-hot-encoding-query]
@@ -59,13 +59,13 @@ include::scripts/one-hot-encoding.cypher[tag=one-hot-encoding-query]
5959
[opts="header",cols="1,1,1,1,4"]
6060
|===
6161
| Name | Type | Default | Optional | Description
62-
| availableValues | list | null | yes | The available values. If null, the function will return an empty list
63-
| selectedValues | list | null | yes | The selected values. If null, the function will return a list of all 0's
62+
| `availableValues` | list | null | yes | The available values. If null, the function will return an empty list.
63+
| `selectedValues` | list | null | yes | The selected values. If null, the function will return a list of all 0's.
6464
|===
6565

6666
.Results
6767
[opts="header",cols="1,6"]
6868
|===
6969
| Type | Description
70-
| list | One hot encoding of the selected values
70+
| `list` | One hot encoding of the selected values.
7171
|===

0 commit comments

Comments
 (0)