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

Commit 712719c

Browse files
tomasonjotomasonjo
committed
Change default similarityCutoff value
1 parent 0424751 commit 712719c

File tree

11 files changed

+28
-28
lines changed

11 files changed

+28
-28
lines changed

‎algo/src/main/java/org/neo4j/graphalgo/similarity/CosineProc.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
public class CosineProc extends SimilarityProc {
3232

3333
@Procedure(name = "algo.similarity.cosine.stream", mode = Mode.READ)
34-
@Description("CALL algo.similarity.cosine.stream([{item:id, weights:[weights]}], {similarityCutoff:-1,degreeCutoff:0}) " +
34+
@Description("CALL algo.similarity.cosine.stream([{item:id, weights:[weights]}], {similarityCutoff:0.1,degreeCutoff:0}) " +
3535
"YIELD item1, item2, count1, count2, intersection, similarity - computes cosine distance")
3636
// todo count1,count2 = could be the non-null values, intersection the values where both are non-null?
3737
public Stream<SimilarityResult> cosineStream(
@@ -57,7 +57,7 @@ public Stream<SimilarityResult> cosineStream(
5757
}
5858

5959
@Procedure(name = "algo.similarity.cosine", mode = Mode.WRITE)
60-
@Description("CALL algo.similarity.cosine([{item:id, weights:[weights]}], {similarityCutoff:-1,degreeCutoff:0}) " +
60+
@Description("CALL algo.similarity.cosine([{item:id, weights:[weights]}], {similarityCutoff:0.1,degreeCutoff:0}) " +
6161
"YIELD p50, p75, p90, p99, p999, p100 - computes cosine similarities")
6262
public Stream<SimilaritySummaryResult> cosine(
6363
@Name(value = "data", defaultValue = "null") List<Map<String, Object>> data,

‎algo/src/main/java/org/neo4j/graphalgo/similarity/EuclideanProc.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public Stream<SimilarityResult> euclideanStream(
4444

4545
WeightedInput[] inputs = prepareWeights(data, getDegreeCutoff(configuration));
4646

47-
double similarityCutoff = getSimilarityCutoff(configuration);
47+
double similarityCutoff = configuration.get("similarityCutoff", -1.0D);
4848
// as we don't compute the sqrt until the end
4949
if (similarityCutoff > 0d) similarityCutoff *= similarityCutoff;
5050

@@ -69,7 +69,7 @@ public Stream<SimilaritySummaryResult> euclidean(
6969

7070
WeightedInput[] inputs = prepareWeights(data, getDegreeCutoff(configuration));
7171

72-
double similarityCutoff = getSimilarityCutoff(configuration);
72+
double similarityCutoff = configuration.get("similarityCutoff", -1.0D);
7373
// as we don't compute the sqrt until the end
7474
if (similarityCutoff > 0d) similarityCutoff *= similarityCutoff;
7575

‎algo/src/main/java/org/neo4j/graphalgo/similarity/JaccardProc.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
public class JaccardProc extends SimilarityProc {
3030

3131
@Procedure(name = "algo.similarity.jaccard.stream", mode = Mode.READ)
32-
@Description("CALL algo.similarity.jaccard.stream([{item:id, categories:[ids]}], {similarityCutoff:-1,degreeCutoff:0}) " +
32+
@Description("CALL algo.similarity.jaccard.stream([{item:id, categories:[ids]}], {similarityCutoff:0.1,degreeCutoff:0}) " +
3333
"YIELD item1, item2, count1, count2, intersection, similarity - computes jaccard similarities")
3434
public Stream<SimilarityResult> similarityStream(
3535
@Name(value = "data", defaultValue = "null") List<Map<String,Object>> data,
@@ -45,7 +45,7 @@ public Stream<SimilarityResult> similarityStream(
4545
}
4646

4747
@Procedure(name = "algo.similarity.jaccard", mode = Mode.WRITE)
48-
@Description("CALL algo.similarity.jaccard([{item:id, categories:[ids]}], {similarityCutoff:-1,degreeCutoff:0}) " +
48+
@Description("CALL algo.similarity.jaccard([{item:id, categories:[ids]}], {similarityCutoff:0.1,degreeCutoff:0}) " +
4949
"YIELD p50, p75, p90, p99, p999, p100 - computes jaccard similarities")
5050
public Stream<SimilaritySummaryResult> jaccard(
5151
@Name(value = "data", defaultValue = "null") List<Map<String, Object>> data,
@@ -60,7 +60,7 @@ public Stream<SimilaritySummaryResult> jaccard(
6060
double similarityCutoff = getSimilarityCutoff(configuration);
6161
Stream<SimilarityResult> stream = topN(similarityStream(inputs, computer, configuration, similarityCutoff, getTopK(configuration)), getTopN(configuration));
6262

63-
boolean write = configuration.isWriteFlag(false);
63+
boolean write = configuration.isWriteFlag(false) && similarityCutoff > 0.0;
6464
return writeAndAggregateResults(configuration, stream, inputs.length, write, "SIMILAR");
6565
}
6666

‎algo/src/main/java/org/neo4j/graphalgo/similarity/OverlapProc.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
public class OverlapProc extends SimilarityProc {
3232

3333
@Procedure(name = "algo.similarity.overlap.stream", mode = Mode.READ)
34-
@Description("CALL algo.similarity.overlap.stream([{item:id, targets:[ids]}], {similarityCutoff:-1,degreeCutoff:0}) " +
34+
@Description("CALL algo.similarity.overlap.stream([{item:id, categories:[ids]}], {similarityCutoff:0.1,degreeCutoff:0}) " +
3535
"YIELD item1, item2, count1, count2, intersection, similarity - computes overlap similarities")
3636
public Stream<SimilarityResult> similarityStream(
3737
@Name(value = "data", defaultValue = "null") List<Map<String,Object>> data,
@@ -47,7 +47,7 @@ public Stream<SimilarityResult> similarityStream(
4747
}
4848

4949
@Procedure(name = "algo.similarity.overlap", mode = Mode.WRITE)
50-
@Description("CALL algo.similarity.overlap([{item:id, targets:[ids]}], {similarityCutoff:-1,degreeCutoff:0}) " +
50+
@Description("CALL algo.similarity.overlap([{item:id, categories:[ids]}], {similarityCutoff:0.1,degreeCutoff:0}) " +
5151
"YIELD p50, p75, p90, p99, p999, p100 - computes overlap similarities")
5252
public Stream<SimilaritySummaryResult> overlap(
5353
@Name(value = "data", defaultValue = "null") List<Map<String, Object>> data,

‎algo/src/main/java/org/neo4j/graphalgo/similarity/SimilarityProc.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Stream<SimilaritySummaryResult> writeAndAggregateResults(ProcedureConfiguration
8888
}
8989

9090
Double getSimilarityCutoff(ProcedureConfiguration configuration) {
91-
return configuration.get("similarityCutoff", -1D);
91+
return configuration.get("similarityCutoff", 0.1D);
9292
}
9393

9494
<T> Stream<SimilarityResult> similarityStream(T[] inputs, SimilarityComputer<T> computer, ProcedureConfiguration configuration, double cutoff, int topK) {

‎doc/asciidoc/similarity-cosine.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ For example, the person most similar to Praveena is Michael, but the person most
163163
| `data` | list | null | no | A list of maps of the following structure: `{item: nodeId, weights: [weight, weight, weight]}`
164164
| `top` | int | 0 | yes | The number of similar pairs to return. If `0`, it will return as many as it finds.
165165
| `topK` | int | 0 | yes | The number of similar values to return per node. If `0`, it will return as many as it finds.
166-
| `similarityCutoff` | int | -1 | yes | The threshold for cosine similarity. Values below this will not be returned.
166+
| `similarityCutoff` | int | 0.1 | yes | The threshold for cosine similarity. Values below this will not be returned.
167167
| `degreeCutoff` | int | 0 | yes | The threshold for the number of items in the `targets` list. If the list contains less than this amount, that node will be excluded from the calculation.
168168
| `concurrency` | int | available CPUs | yes | The number of concurrent threads.
169169
|===
@@ -220,7 +220,7 @@ include::scripts/similarity-cosine.cypher[tag=query]
220220
| `data` | list | null | no | A list of maps of the following structure: `{item: nodeId, categories: [nodeId, nodeId, nodeId]}`
221221
| `top` | int | 0 | yes | The number of similar pairs to return. If `0`, it will return as many as it finds.
222222
| `topK` | int | 0 | yes | The number of similar values to return per node. If `0`, it will return as many as it finds.
223-
| `similarityCutoff` | int | -1 | yes | The threshold for Jaccard similarity. Values below this will not be returned.
223+
| `similarityCutoff` | int | 0.1 | yes | The threshold for Jaccard similarity. Values below this will not be returned.
224224
| `degreeCutoff` | int | 0 | yes | The threshold for the number of items in the `targets` list. If the list contains less than this amount, that node will be excluded from the calculation.
225225
| `concurrency` | int | available CPUs | yes | The number of concurrent threads.
226226
| `write` | boolean | false | yes | Indicates whether results should be stored.

‎doc/asciidoc/similarity-jaccard.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ For example, the person most similar to Praveena is Zhen, but the person most si
161161
| `data` | list | null | no | A list of maps of the following structure: `{item: nodeId, categories: [nodeId, nodeId, nodeId]}`
162162
| `top` | int | 0 | yes | The number of similar pairs to return. If `0`, it will return as many as it finds.
163163
| `topK` | int | 0 | yes | The number of similar values to return per node. If `0`, it will return as many as it finds.
164-
| `similarityCutoff` | int | -1 | yes | The threshold for Jaccard similarity. Values below this will not be returned.
164+
| `similarityCutoff` | int | 0.1 | yes | The threshold for Jaccard similarity. Values below this will not be returned.
165165
| `degreeCutoff` | int | 0 | yes | The threshold for the number of items in the `targets` list. If the list contains less than this amount, that node will be excluded from the calculation.
166166
| `concurrency` | int | available CPUs | yes | The number of concurrent threads.
167167
|===
@@ -217,7 +217,7 @@ include::scripts/similarity-jaccard.cypher[tag=query]
217217
| `data` | list | null | no | A list of maps of the following structure: `{item: nodeId, categories: [nodeId, nodeId, nodeId]}`
218218
| `top` | int | 0 | yes | The number of similar pairs to return. If `0`, it will return as many as it finds.
219219
| `topK` | int | 0 | yes | The number of similar values to return per node. If `0`, it will return as many as it finds.
220-
| `similarityCutoff` | int | -1 | yes | The threshold for Jaccard similarity. Values below this will not be returned.
220+
| `similarityCutoff` | int | 0.1 | yes | The threshold for Jaccard similarity. Values below this will not be returned.
221221
| `degreeCutoff` | int | 0 | yes | The threshold for the number of items in the `targets` list. If the list contains less than this amount, that node will be excluded from the calculation.
222222
| `concurrency` | int | available CPUs | yes | The number of concurrent threads.
223223
| `write` | boolean | false | yes | Indicates whether results should be stored.

‎doc/asciidoc/similarity-overlap.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ include::scripts/similarity-overlap.cypher[tag=stream-topk]
150150
| `data` | list | null | no | A list of maps of the following structure: `{item: nodeId, categories: [nodeId, nodeId, nodeId]}`
151151
| `top` | int | 0 | yes | The number of similar pairs to return. If `0`, it will return as many as it finds.
152152
| `topK` | int | 0 | yes | The number of similar values to return per node. If `0`, it will return as many as it finds.
153-
| `similarityCutoff` | int | -1 | yes | The threshold for Overlap similarity. Values below this will not be returned.
153+
| `similarityCutoff` | int | 0.1 | yes | The threshold for Overlap similarity. Values below this will not be returned.
154154
| `degreeCutoff` | int | 0 | yes | The threshold for the number of items in the `targets` list. If the list contains less than this amount, that node will be excluded from the calculation.
155155
| `concurrency` | int | available CPUs | yes | The number of concurrent threads.
156156
|===
@@ -208,7 +208,7 @@ include::scripts/similarity-overlap.cypher[tag=query]
208208
| `data` | list | null | no | A list of maps of the following structure: `{item: nodeId, categories: [nodeId, nodeId, nodeId]}`
209209
| `top` | int | 0 | yes | The number of similar pairs to return. If `0`, it will return as many as it finds.
210210
| `topK` | int | 0 | yes | The number of similar values to return per node. If `0`, it will return as many as it finds.
211-
| `similarityCutoff` | int | -1 | yes | The threshold for Overlap similarity. Values below this will not be returned.
211+
| `similarityCutoff` | int | 0.1 | yes | The threshold for Overlap similarity. Values below this will not be returned.
212212
| `degreeCutoff` | int | 0 | yes | The threshold for the number of items in the `targets` list. If the list contains less than this amount, that node will be excluded from the calculation.
213213
| `concurrency` | int | available CPUs | yes | The number of concurrent threads.
214214
| `write` | boolean | false | yes | Indicates whether results should be stored.

‎tests/src/test/java/org/neo4j/graphalgo/algo/similarity/CosineTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,15 +187,15 @@ public void cosineSingleMultiThreadComparisionTopK() {
187187

188188
@Test
189189
public void topNcosineStreamTest() {
190-
Result results = db.execute(STATEMENT_STREAM, map("config",map("top",2)));
190+
Result results = db.execute(STATEMENT_STREAM, map("config",map("top",2,"similarityCutoff",-1.0)));
191191
assert01(results.next());
192192
assert02(results.next());
193193
assertFalse(results.hasNext());
194194
}
195195

196196
@Test
197197
public void cosineStreamTest() {
198-
Result results = db.execute(STATEMENT_STREAM, map("config",map("concurrency",1)));
198+
Result results = db.execute(STATEMENT_STREAM, map("config",map("concurrency",1,"similarityCutoff",-1.0)));
199199
assertTrue(results.hasNext());
200200
assert01(results.next());
201201
assert02(results.next());
@@ -208,7 +208,7 @@ public void cosineStreamTest() {
208208

209209
@Test
210210
public void topKCosineStreamTest() {
211-
Map<String, Object> params = map("config", map( "concurrency", 1,"topK", 1));
211+
Map<String, Object> params = map("config", map( "concurrency", 1,"topK", 1, "similarityCutoff", -1.0));
212212
System.out.println(db.execute(STATEMENT_STREAM, params).resultAsString());
213213
Result results = db.execute(STATEMENT_STREAM, params);
214214
assertTrue(results.hasNext());
@@ -253,7 +253,7 @@ public void topK4cosineStreamTest() {
253253

254254
@Test
255255
public void topK3cosineStreamTest() {
256-
Map<String, Object> params = map("config", map("concurrency", 3, "topK", 3));
256+
Map<String, Object> params = map("config", map("concurrency", 3, "topK", 3, "similarityCutoff", -1.0));
257257

258258
System.out.println(db.execute(STATEMENT_STREAM, params).resultAsString());
259259

@@ -267,7 +267,7 @@ public void topK3cosineStreamTest() {
267267

268268
@Test
269269
public void simpleCosineTest() {
270-
Map<String, Object> params = map("config", map());
270+
Map<String, Object> params = map("config", map("similarityCutoff",-1.0));
271271

272272
Map<String, Object> row = db.execute(STATEMENT,params).next();
273273
assertEquals((double) row.get("p25"), 0.0, 0.01);
@@ -283,7 +283,7 @@ public void simpleCosineTest() {
283283
public void simpleCosineFromEmbeddingTest() {
284284
db.execute(STORE_EMBEDDING_STATEMENT);
285285

286-
Map<String, Object> params = map("config", map());
286+
Map<String, Object> params = map("config", map("similarityCutoff",-1.0));
287287

288288
Map<String, Object> row = db.execute(EMBEDDING_STATEMENT,params).next();
289289
assertEquals((double) row.get("p25"), 0.0, 0.01);

‎tests/src/test/java/org/neo4j/graphalgo/algo/similarity/JaccardTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,15 +164,15 @@ public void jaccardSingleMultiThreadComparisionTopK() {
164164

165165
@Test
166166
public void topNjaccardStreamTest() {
167-
Result results = db.execute(STATEMENT_STREAM, map("config",map("top",2)));
167+
Result results = db.execute(STATEMENT_STREAM, map("config",map("top",2,"similarityCutoff",-1.0)));
168168
assert01(results.next());
169169
assert02(results.next());
170170
assertFalse(results.hasNext());
171171
}
172172

173173
@Test
174174
public void jaccardStreamTest() {
175-
Result results = db.execute(STATEMENT_STREAM, map("config",map("concurrency",1)));
175+
Result results = db.execute(STATEMENT_STREAM, map("config",map("concurrency",1,"similarityCutoff",-1.0)));
176176
assertTrue(results.hasNext());
177177
assert01(results.next());
178178
assert02(results.next());
@@ -182,7 +182,7 @@ public void jaccardStreamTest() {
182182

183183
@Test
184184
public void topKJaccardStreamTest() {
185-
Map<String, Object> params = map("config", map( "concurrency", 1,"topK", 1));
185+
Map<String, Object> params = map("config", map( "concurrency", 1,"topK", 1,"similarityCutoff",-1.0));
186186
System.out.println(db.execute(STATEMENT_STREAM, params).resultAsString());
187187

188188
Result results = db.execute(STATEMENT_STREAM, params);
@@ -227,7 +227,7 @@ public void topK4jaccardStreamTest() {
227227

228228
@Test
229229
public void topK3jaccardStreamTest() {
230-
Map<String, Object> params = map("config", map("concurrency", 3, "topK", 3));
230+
Map<String, Object> params = map("config", map("concurrency", 3, "topK", 3, "similarityCutoff",-1.0));
231231

232232
System.out.println(db.execute(STATEMENT_STREAM, params).resultAsString());
233233

0 commit comments

Comments
 (0)