com.feedzai.openml.provider.lightgbm.LightGBMAlgorithms 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.descriptor.MLAlgorithmDescriptor;
import com.feedzai.openml.provider.descriptor.MachineLearningAlgorithmType;
import com.feedzai.openml.util.algorithm.MLAlgorithmEnum;

import static com.feedzai.openml.util.algorithm.MLAlgorithmEnum.createDescriptor;

/**
 * Specifies the LightGBM algorithms that can be imported.
 *
 * @author Alberto Ferreira ([email protected])
 * @since 1.0.10
 */
public enum LightGBMAlgorithms implements MLAlgorithmEnum {

    /**
     * LightGBM binary classifier algorithm.
     */
    LIGHTGBM_BINARY_CLASSIFIER(createDescriptor(
            "LightGBM Binary Classifier",
            LightGBMDescriptorUtil.PARAMS,
            MachineLearningAlgorithmType.SUPERVISED_BINARY_CLASSIFICATION,
            "https://lightgbm.readthedocs.io/"
    )),

    /**
     * FairGBM binary classifier algorithm.
     */
    FAIRGBM_BINARY_CLASSIFIER(createDescriptor(
            "FairGBM (LightGBM with Fairness)",
            FairGBMDescriptorUtil.PARAMS,
            MachineLearningAlgorithmType.SUPERVISED_BINARY_CLASSIFICATION,
            "https://lightgbm.readthedocs.io/"  // TODO: link to our documentation
    )),
    ;

    /**
     * {@link MLAlgorithmDescriptor} for this algorithm.
     */
    private final MLAlgorithmDescriptor descriptor;

    /**
     * Constructor.
     *
     * @param descriptor {@link MLAlgorithmDescriptor} for this algorithm.
     */
    LightGBMAlgorithms(final MLAlgorithmDescriptor descriptor) {
        this.descriptor = descriptor;
    }

    @Override
    public MLAlgorithmDescriptor getAlgorithmDescriptor() {
        return this.descriptor;
    }
}