Package org.neo4j.gds.embeddings.graphsage

Class GraphSageMutateProc

  • All Implemented Interfaces:
    org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig,​java.util.stream.Stream<GraphSageMutateProc.MutateResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>>
    public class GraphSageMutateProc
extends org.neo4j.gds.MutatePropertyProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​GraphSageMutateProc.MutateResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>

    • Field Summary

      • Fields inherited from class org.neo4j.gds.AlgoBaseProc

        STATS_DESCRIPTION

      • Fields inherited from class org.neo4j.gds.BaseProc

        api, callContext, ESTIMATE_DESCRIPTION, internalModelCatalog, log, procedureTransaction, taskRegistryFactory, transaction, userLogRegistryFactory, username

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.neo4j.gds.GraphAlgorithmFactory<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> algorithmFactory()  
      java.util.stream.Stream<org.neo4j.gds.results.MemoryEstimateResult> estimate​(java.lang.Object graphNameOrConfiguration, java.util.Map<java.lang.String,​java.lang.Object> algoConfiguration)  
      java.util.stream.Stream<GraphSageMutateProc.MutateResult> mutate​(java.lang.String graphName, java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      protected org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig newConfig​(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)  
      protected org.neo4j.gds.api.NodeProperties nodeProperties​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> computationResult)  
      protected org.neo4j.gds.result.AbstractResultBuilder<GraphSageMutateProc.MutateResult> resultBuilder​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> computeResult, org.neo4j.gds.executor.ExecutionContext executionContext)  
      org.neo4j.gds.executor.validation.ValidationConfiguration<org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> validationConfig()  
      org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig,​java.util.stream.Stream<GraphSageMutateProc.MutateResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>> withModelCatalog​(org.neo4j.gds.core.model.ModelCatalog modelCatalog)  

      • Methods inherited from class org.neo4j.gds.MutatePropertyProc

        computationResultConsumer, nodePropertyList

      • Methods inherited from class org.neo4j.gds.MutateProc

        mutate

      • Methods inherited from class org.neo4j.gds.AlgoBaseProc

        compute, compute, computeEstimate, configParser, name, newConfigFunction

      • Methods inherited from class org.neo4j.gds.BaseProc

        databaseId, executionContext, graphLoaderContext, graphStoreFromCatalog, isGdsAdmin, memoryUsageValidator, modelCatalog, runWithExceptionLogging, runWithExceptionLogging, setModelCatalog, username, validateConfig, validateConfig, validateGraphName

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.neo4j.gds.executor.AlgorithmSpec

        createDefaultExecutorSpec

    • Constructor Detail

      • GraphSageMutateProc

        public GraphSageMutateProc()

    • Method Detail

      • mutate

        public java.util.stream.Stream<GraphSageMutateProc.MutateResult> mutate​(java.lang.String graphName,
                                                                        java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • estimate

        public java.util.stream.Stream<org.neo4j.gds.results.MemoryEstimateResult> estimate​(java.lang.Object graphNameOrConfiguration,
                                                                                    java.util.Map<java.lang.String,​java.lang.Object> algoConfiguration)

      • nodeProperties

        protected org.neo4j.gds.api.NodeProperties nodeProperties​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> computationResult)
        Overrides:
        nodeProperties in class org.neo4j.gds.MutatePropertyProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​GraphSageMutateProc.MutateResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>

      • resultBuilder

        protected org.neo4j.gds.result.AbstractResultBuilder<GraphSageMutateProc.MutateResult> resultBuilder​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> computeResult,
                                                                                                     org.neo4j.gds.executor.ExecutionContext executionContext)
        Specified by:
        resultBuilder in class org.neo4j.gds.MutateProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​GraphSageMutateProc.MutateResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>

      • validationConfig

        public org.neo4j.gds.executor.validation.ValidationConfiguration<org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> validationConfig()
        Specified by:
        validationConfig in interface org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig,​java.util.stream.Stream<GraphSageMutateProc.MutateResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>>
        Overrides:
        validationConfig in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig,​GraphSageMutateProc.MutateResult>

      • newConfig

        protected org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig newConfig​(java.lang.String username,
                                                                                  org.neo4j.gds.core.CypherMapWrapper config)
        Specified by:
        newConfig in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig,​GraphSageMutateProc.MutateResult>

      • algorithmFactory

        public org.neo4j.gds.GraphAlgorithmFactory<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig> algorithmFactory()

      • withModelCatalog

        public org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage.GraphSageResult,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig,​java.util.stream.Stream<GraphSageMutateProc.MutateResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.embeddings.graphsage.algo.GraphSage,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageMutateConfig>> withModelCatalog​(org.neo4j.gds.core.model.ModelCatalog modelCatalog)