org.neo4j.gds.embeddings.hashgnn.HashGNNStreamProc 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.hashgnn;

import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
import org.neo4j.gds.procedures.GraphDataScienceProcedures;
import org.neo4j.gds.procedures.algorithms.embeddings.HashGNNStreamResult;
import org.neo4j.procedure.Context;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Internal;
import org.neo4j.procedure.Name;
import org.neo4j.procedure.Procedure;

import java.util.Map;
import java.util.stream.Stream;

import static org.neo4j.gds.embeddings.hashgnn.HashGNNProcCompanion.HASH_GNN_DESCRIPTION;
import static org.neo4j.gds.procedures.ProcedureConstants.MEMORY_ESTIMATION_DESCRIPTION;
import static org.neo4j.procedure.Mode.READ;

public class HashGNNStreamProc {
    @Context
    public GraphDataScienceProcedures facade;

    @Procedure(value = "gds.hashgnn.stream", mode = READ)
    @Description(HASH_GNN_DESCRIPTION)
    public Stream stream(
        @Name(value = "graphName") String graphName,
        @Name(value = "configuration", defaultValue = "{}") Map configuration
    ) {
        return facade.algorithms().nodeEmbeddings().hashGnnStream(graphName, configuration);
    }

    @Internal
    @Deprecated(forRemoval = true)
    @Procedure(value = "gds.beta.hashgnn.stream", deprecatedBy = "gds.hashgnn.stream", mode = READ)
    @Description(HASH_GNN_DESCRIPTION)
    public Stream betaStream(
        @Name(value = "graphName") String graphName,
        @Name(value = "configuration", defaultValue = "{}") Map configuration
    ) {
        facade.deprecatedProcedures().called("gds.beta.hashgnn.stream");
        facade
            .log()
            .warn("Procedure `gds.beta.hashgnn.stream` has been deprecated, please use `gds.hashgnn.stream`.");

        return stream(graphName, configuration);
    }

    @Procedure(value = "gds.hashgnn.stream.estimate", mode = READ)
    @Description(MEMORY_ESTIMATION_DESCRIPTION)
    public Stream estimate(
        @Name(value = "graphNameOrConfiguration") Object graphNameOrConfiguration,
        @Name(value = "algoConfiguration") Map algoConfiguration
    ) {
        return facade.algorithms().nodeEmbeddings().hashGnnStreamEstimate(graphNameOrConfiguration, algoConfiguration);
    }

    @Internal
    @Deprecated(forRemoval = true)
    @Procedure(value = "gds.beta.hashgnn.stream.estimate", deprecatedBy = "gds.hashgnn.stream.estimate", mode = READ)
    @Description(MEMORY_ESTIMATION_DESCRIPTION)
    public Stream betaEstimate(
        @Name(value = "graphNameOrConfiguration") Object graphNameOrConfiguration,
        @Name(value = "algoConfiguration") Map algoConfiguration
    ) {
        facade.deprecatedProcedures().called("gds.beta.hashgnn.stream.estimate");
        facade
            .log()
            .warn("Procedure `gds.beta.hashgnn.stream.estimate` has been deprecated, please use `gds.hashgnn.stream.estimate`.");

        return estimate(graphNameOrConfiguration, algoConfiguration);
    }
}