org.neo4j.gds.embeddings.graphsage.GraphSageCompanion 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.graphsage;

import org.neo4j.gds.api.properties.nodes.EmptyDoubleArrayNodePropertyValues;
import org.neo4j.gds.api.properties.nodes.NodePropertyValues;
import org.neo4j.gds.api.properties.nodes.NodePropertyValuesAdapter;
import org.neo4j.gds.embeddings.graphsage.algo.GraphSageResult;

import java.util.Optional;

public final class GraphSageCompanion {

    static final String GRAPH_SAGE_DESCRIPTION = "The GraphSage algorithm inductively computes embeddings for nodes based on a their features and neighborhoods.";

    private GraphSageCompanion() {}

    static NodePropertyValues nodePropertyValues(Optional graphSageResult) {
        return graphSageResult
            .map(GraphSageResult::embeddings)
            .map(embeddings -> NodePropertyValuesAdapter.adapt(embeddings))
            .orElse(EmptyDoubleArrayNodePropertyValues.INSTANCE);
    }
}