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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of node-embeddings-configs Show documentation

Neo4j Graph Data Science :: Node Embedding Configurations

The newest version!

/*
 * 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.neo4j.gds.utils.StringJoining;

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

import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
import static org.neo4j.gds.utils.StringFormatting.toUpperCaseWithLocale;

public enum EmbeddingInitializer {
    UNIFORM,
    NORMALIZED;

    private static final List VALUES = Arrays
        .stream(EmbeddingInitializer.values())
        .map(EmbeddingInitializer::name)
        .collect(Collectors.toList());

    public static EmbeddingInitializer parse(Object input) {
        if (input instanceof String) {
            var inputString = toUpperCaseWithLocale((String) input);

            if (!VALUES.contains(inputString)) {
                throw new IllegalArgumentException(formatWithLocale(
                    "EmbeddingInitializer `%s` is not supported. Must be one of: %s.",
                    input,
                    StringJoining.join(VALUES)
                ));
            }

            return valueOf(toUpperCaseWithLocale(inputString));
        } else if (input instanceof EmbeddingInitializer) {
            return (EmbeddingInitializer) input;
        }

        throw new IllegalArgumentException(formatWithLocale(
            "Expected EmbeddingInitializer or String. Got %s.",
            input.getClass().getSimpleName()
        ));
    }

    public static String toString(EmbeddingInitializer embeddingInitializer) {
        return embeddingInitializer.toString();
    }
}