Skip to content

Commit 96dabd3

Browse files
FlorentinDMats-SX
andcommitted
Fix procedure descriptions for LinkPrediction predict procs
Co-authored-by: Mats Rydberg <mats@neotechnology.com>
1 parent aa2d686 commit 96dabd3

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

proc/machine-learning/src/main/java/org/neo4j/gds/ml/linkmodels/pipeline/LinkPredictionPipelineCompanion.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@
3535

3636
public final class LinkPredictionPipelineCompanion {
3737

38-
public static final String PREDICT_DESCRIPTION = "Predicts relationships for all node pairs based on a previously trained link prediction model.";
38+
public static final String PREDICT_DESCRIPTION = "Predicts relationships for all non-connected node pairs based on a previously trained LinkPrediction model.";
39+
public static final String ESTIMATE_PREDICT_DESCRIPTION = "Estimates memory for predicting relationships for all non-connected node pairs based on a previously trained LinkPrediction model";
40+
3941
static final Map<String, List<Map<String, Object>>> DEFAULT_PARAM_SPACE = Map.of(
4042
TrainingMethod.LogisticRegression.name(), List.of(),
4143
TrainingMethod.RandomForest.name(), List.of()

proc/machine-learning/src/main/java/org/neo4j/gds/ml/linkmodels/pipeline/predict/LinkPredictionPipelineMutateProc.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,14 @@
5959

6060
import static org.neo4j.gds.executor.ExecutionMode.MUTATE_RELATIONSHIP;
6161
import static org.neo4j.gds.ml.PipelineCompanion.prepareTrainConfig;
62-
import static org.neo4j.gds.ml.linkmodels.pipeline.predict.LinkPredictionPipelineMutateProc.DESCRIPTION;
63-
import static org.neo4j.gds.ml.nodemodels.pipeline.NodeClassificationPipelineCompanion.ESTIMATE_PREDICT_DESCRIPTION;
62+
import static org.neo4j.gds.ml.linkmodels.pipeline.LinkPredictionPipelineCompanion.ESTIMATE_PREDICT_DESCRIPTION;
63+
import static org.neo4j.gds.ml.linkmodels.pipeline.LinkPredictionPipelineCompanion.PREDICT_DESCRIPTION;
6464

65-
@GdsCallable(name = "gds.beta.pipeline.linkPrediction.predict.mutate", description = DESCRIPTION, executionMode = MUTATE_RELATIONSHIP)
65+
@GdsCallable(name = "gds.beta.pipeline.linkPrediction.predict.mutate", description = PREDICT_DESCRIPTION, executionMode = MUTATE_RELATIONSHIP)
6666
public class LinkPredictionPipelineMutateProc extends MutateProc<LinkPredictionPredictPipelineExecutor, LinkPredictionResult, LinkPredictionPipelineMutateProc.MutateResult, LinkPredictionPredictPipelineMutateConfig> {
67-
static final String DESCRIPTION = "Predicts relationships for all non-connected node pairs based on a previously trained Link prediction pipeline.";
6867

6968
@Procedure(name = "gds.beta.pipeline.linkPrediction.predict.mutate", mode = Mode.READ)
70-
@Description(DESCRIPTION)
69+
@Description(PREDICT_DESCRIPTION)
7170
public Stream<LinkPredictionPipelineMutateProc.MutateResult> mutate(
7271
@Name(value = "graphName") String graphName,
7372
@Name(value = "configuration", defaultValue = "{}") Map<String, Object> configuration

proc/machine-learning/src/main/java/org/neo4j/gds/ml/linkmodels/pipeline/predict/LinkPredictionPipelineStreamProc.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@
4242

4343
import static org.neo4j.gds.executor.ExecutionMode.STREAM;
4444
import static org.neo4j.gds.ml.PipelineCompanion.prepareTrainConfig;
45+
import static org.neo4j.gds.ml.linkmodels.pipeline.LinkPredictionPipelineCompanion.ESTIMATE_PREDICT_DESCRIPTION;
4546
import static org.neo4j.gds.ml.linkmodels.pipeline.LinkPredictionPipelineCompanion.PREDICT_DESCRIPTION;
46-
import static org.neo4j.gds.ml.nodemodels.pipeline.NodeClassificationPipelineCompanion.ESTIMATE_PREDICT_DESCRIPTION;
4747

4848
@GdsCallable(name = "gds.beta.pipeline.linkPrediction.predict.stream", description = PREDICT_DESCRIPTION, executionMode = STREAM)
4949
public class LinkPredictionPipelineStreamProc extends AlgoBaseProc<LinkPredictionPredictPipelineExecutor, LinkPredictionResult, LinkPredictionPredictPipelineStreamConfig, LinkPredictionPipelineStreamProc.Result> {

0 commit comments

Comments
 (0)