org.neo4j.gds.embeddings.hashgnn.GenerateFeaturesTask Maven / Gradle / Ivy

Go to download
/*
 * 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.apache.commons.lang3.mutable.MutableLong;
import org.neo4j.gds.api.Graph;
import org.neo4j.gds.collections.ha.HugeObjectArray;
import org.neo4j.gds.core.concurrency.Concurrency;
import org.neo4j.gds.core.concurrency.RunWithConcurrency;
import org.neo4j.gds.core.utils.paged.HugeAtomicBitSet;
import org.neo4j.gds.core.utils.partition.Partition;
import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
import org.neo4j.gds.termination.TerminationFlag;

import java.util.List;
import java.util.Random;
import java.util.stream.Collectors;

class GenerateFeaturesTask implements Runnable {
    private final Partition partition;
    private final HugeObjectArray output;
    private final Graph graph;
    private final Random rng;
    private final GenerateFeaturesConfig generateFeaturesConfig;
    private final ProgressTracker progressTracker;
    private final long randomSeed;
    private long totalFeatureCount = 0;

    GenerateFeaturesTask(
        Partition partition,
        Graph graph,
        long randomSeed,
        GenerateFeaturesConfig config,
        HugeObjectArray output,
        ProgressTracker progressTracker
    ) {
        this.partition = partition;
        this.graph = graph;
        this.rng = new Random();
        this.randomSeed = randomSeed;
        this.generateFeaturesConfig = config;
        this.output = output;
        this.progressTracker = progressTracker;
    }

    static HugeObjectArray compute(
        GenerateFeaturesConfig generateFeatures,
        Graph graph,
        List partition,
        Concurrency concurrency,
        long randomSeed,
        ProgressTracker progressTracker,
        TerminationFlag terminationFlag,
        MutableLong totalFeatureCountOutput
    ) {
        progressTracker.beginSubTask("Generate base node property features");

        var output = HugeObjectArray.newArray(HugeAtomicBitSet.class, graph.nodeCount());

        var tasks = partition.stream()
            .map(p -> new GenerateFeaturesTask(
                p,
                graph,
                randomSeed,
                generateFeatures,
                output,
                progressTracker
            ))
            .collect(Collectors.toList());
        RunWithConcurrency.builder()
            .concurrency(concurrency)
            .tasks(tasks)
            .terminationFlag(terminationFlag)
            .run();

        totalFeatureCountOutput.add(tasks.stream().mapToLong(GenerateFeaturesTask::totalFeatureCount).sum());

        progressTracker.endSubTask("Generate base node property features");

        return output;
    }

    @Override
    public void run() {
        int dimension = generateFeaturesConfig.dimension();
        int densityLevel = generateFeaturesConfig.densityLevel();

        partition.consume(nodeId -> {
            var generatedFeatures = HugeAtomicBitSet.create(dimension);

            rng.setSeed(this.randomSeed ^ graph.toOriginalNodeId(nodeId));

            var randomInts = rng.ints(densityLevel, 0, dimension);
            randomInts.forEach(generatedFeatures::set);

            totalFeatureCount += generatedFeatures.cardinality();

            output.set(nodeId, generatedFeatures);
        });

        progressTracker.logProgress(partition.nodeCount());
    }

    public long totalFeatureCount() {
        return totalFeatureCount;
    }
}