com.feedzai.openml.provider.lightgbm.LightGBMMLProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openml-lightgbm Show documentation

OpenML LightGBM Machine Learning Model and Classifier provider

The newest version!

/*
 * Copyright 2020 Feedzai
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.feedzai.openml.provider.lightgbm;

import com.feedzai.openml.provider.MachineLearningProvider;
import com.feedzai.openml.provider.TrainingMachineLearningProvider;
import com.feedzai.openml.provider.descriptor.MLAlgorithmDescriptor;
import com.feedzai.openml.util.algorithm.MLAlgorithmEnum;
import com.google.auto.service.AutoService;

import java.util.Optional;
import java.util.Set;

/**
 * This class implements Feedzai's OpenML MachineLearningProvider interface for LightGBM.
 *
 * @author Alberto Ferreira ([email protected])
 * @since 1.0.10
 */
@AutoService(MachineLearningProvider.class)
public class LightGBMMLProvider implements TrainingMachineLearningProvider {

    /**
     * The reported name of this provider.
     */
//    private static final String PROVIDER_NAME = "Feedzai GBM";    // TODO: https://github.com/feedzai/feedzai-openml-java/issues/129
    private static final String PROVIDER_NAME = "Microsoft LightGBM";

    @Override
    public String getName() {
        return PROVIDER_NAME;
    }

    @Override
    public Set getAlgorithms() {
//        return MLAlgorithmEnum.getDescriptors(LightGBMAlgorithms.values());   // TODO: https://github.com/feedzai/feedzai-openml-java/issues/129
        return MLAlgorithmEnum.getDescriptors(new MLAlgorithmEnum[]{LightGBMAlgorithms.LIGHTGBM_BINARY_CLASSIFIER});
    }

    @Override
    public Optional getModelCreator(final String algorithmName) {
        return MLAlgorithmEnum.getByName(new MLAlgorithmEnum[]{LightGBMAlgorithms.LIGHTGBM_BINARY_CLASSIFIER}, algorithmName)
                .map(algorithm -> new LightGBMModelCreator());
    }
}