org.neo4j.gds.embeddings.node2vec.Node2VecMutateSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proc-embeddings Show documentation
Neo4j Graph Data Science :: Procedures :: Embeddings
There is a newer version: 2.12.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.gds.embeddings.node2vec;

import org.jetbrains.annotations.NotNull;
import org.neo4j.gds.MutatePropertyComputationResultConsumer;
import org.neo4j.gds.algorithms.embeddings.FloatEmbeddingNodePropertyValues;
import org.neo4j.gds.api.properties.nodes.EmptyFloatArrayNodePropertyValues;
import org.neo4j.gds.api.properties.nodes.FloatArrayNodePropertyValues;
import org.neo4j.gds.core.write.NodeProperty;
import org.neo4j.gds.executor.AlgorithmSpec;
import org.neo4j.gds.executor.ComputationResult;
import org.neo4j.gds.executor.ComputationResultConsumer;
import org.neo4j.gds.executor.ExecutionContext;
import org.neo4j.gds.executor.GdsCallable;
import org.neo4j.gds.procedures.algorithms.configuration.NewConfigFunction;
import org.neo4j.gds.procedures.algorithms.embeddings.Node2VecMutateResult;

import java.util.List;
import java.util.stream.Stream;

import static org.neo4j.gds.executor.ExecutionMode.MUTATE_NODE_PROPERTY;

@GdsCallable(
    name = "gds.node2vec.mutate",
    aliases = "gds.beta.node2vec.mutate",
    description = Node2VecCompanion.NODE2VEC_DESCRIPTION,
    executionMode = MUTATE_NODE_PROPERTY
)
public class Node2VecMutateSpec implements AlgorithmSpec, Node2VecAlgorithmFactory> {
    @Override
    public String name() {
        return "Node2VecMutate";
    }

    @Override
    public Node2VecAlgorithmFactory algorithmFactory(ExecutionContext executionContext) {
        return new Node2VecAlgorithmFactory<>();
    }

    @Override
    public NewConfigFunction newConfigFunction() {
        return (__, userInput) -> Node2VecMutateConfig.of(userInput);
    }

    @Override
    public ComputationResultConsumer> computationResultConsumer() {
        return new MutatePropertyComputationResultConsumer<>(
            this::nodePropertyList,
            this::resultBuilder
        );
    }

    private List nodePropertyList(
        ComputationResult computationResult
    ) {
        return List.of(
            NodeProperty.of(
                computationResult.config().mutateProperty(),
                nodePropertyValues(computationResult)
            )
        );
    }

    @NotNull
    private static FloatArrayNodePropertyValues nodePropertyValues(ComputationResult computationResult) {
        return computationResult.result()
            .map(result -> (FloatArrayNodePropertyValues) new FloatEmbeddingNodePropertyValues(result.embeddings()))
            .orElse(EmptyFloatArrayNodePropertyValues.INSTANCE);
    }

    private Node2VecMutateResult.Builder resultBuilder(
        ComputationResult computeResult,
        ExecutionContext executionContext
    ) {
        var builder = new Node2VecMutateResult.Builder();
        computeResult.result().ifPresent(result -> {
            builder.withLossPerIteration(result.lossPerIteration());
        });

        return builder;
    }

}