com.tencent.angel.sona.tree.objective.ObjectiveFactory Maven / Gradle / Ivy

Go to download
/*
 * Tencent is pleased to support the open source community by making Angel available.
 *
 * Copyright (C) 2017-2018 THL A29 Limited, a Tencent company. All rights reserved.
 *
 * 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
 *
 * https://opensource.org/licenses/Apache-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.tencent.angel.sona.tree.objective;

import com.tencent.angel.sona.tree.objective.loss.*;
import com.tencent.angel.sona.tree.objective.metric.*;

public class ObjectiveFactory {

    public static Loss.Kind getLossKind(String lossFunc) {
        for (Loss.Kind kind : Loss.Kind.values()) {
            if (lossFunc.equalsIgnoreCase(kind.toString()))
                return kind;
        }
        throw new IllegalArgumentException("Unrecognizable loss function: " + lossFunc);
    }

    public static Loss getLoss(Loss.Kind lossFunc) {
        switch (lossFunc) {
            case RMSE:
                return RMSELoss.getInstance();
            case BinaryLogistic:
                return BinaryLogisticLoss.getInstance();
            case MultiLogistic:
                return MultinomialLogisticLoss.getInstance();
            default:
                throw new IllegalArgumentException("Unrecognizable loss function: " + lossFunc);
        }
    }

    public static BinaryLoss getBinaryLoss(Loss.Kind lossFunc) {
        switch (lossFunc) {
            case RMSE:
                return RMSELoss.getInstance();
            case BinaryLogistic:
                return BinaryLogisticLoss.getInstance();
            case MultiLogistic:
                throw new IllegalArgumentException("Loss function " + lossFunc
                        + " is not a binary loss function");
            default:
                throw new IllegalArgumentException("Unrecognizable loss function: " + lossFunc);
        }
    }

    public static MultiLoss getMultiLoss(Loss.Kind lossFunc) {
        switch (lossFunc) {
            case RMSE:
                return RMSELoss.getInstance();
            case MultiLogistic:
                return MultinomialLogisticLoss.getInstance();
            case BinaryLogistic:
                throw new IllegalArgumentException("Loss function " + lossFunc
                        + " is not a multi-class loss function");
            default:
                throw new IllegalArgumentException("Unrecognizable loss function: " + lossFunc);
        }
    }

    public static Loss getLoss(String lossFunc) {
        return getLoss(getLossKind(lossFunc));
    }

    public static BinaryLoss getBinaryLoss(String lossFunc) {
        return getBinaryLoss(getLossKind(lossFunc));
    }

    public static MultiLoss getMultiLoss(String lossFunc) {
        return getMultiLoss(getLossKind(lossFunc));
    }

    public static EvalMetric.Kind getEvalMetricKind(String metric) {
        for (EvalMetric.Kind kind: EvalMetric.Kind.values()) {
            if (metric.equalsIgnoreCase(kind.toString()))
                return kind;
        }
        throw new IllegalArgumentException("Unrecognizable eval metric: " + metric);
    }

    public static EvalMetric getEvalMetric(EvalMetric.Kind metric) {
        switch (metric) {
            case RMSE:
                return RMSEMetric.getInstance();
            case ERROR:
                return ErrorMetric.getInstance();
            case PRECISION:
                return PrecisionMetric.getInstance();
            case LOG_LOSS:
                return LogLossMetric.getInstance();
            case CROSS_ENTROPY:
                return CrossEntropyMetric.getInstance();
            case AUC:
                return AUCMetric.getInstance();
            default:
                throw new IllegalArgumentException("Unrecognizable eval metric: " + metric);
        }
    }

    public static EvalMetric getEvalMetric(String metric) {
        return getEvalMetric(getEvalMetricKind(metric));
    }

    public static EvalMetric getEvalMetricOrDefault(String metric, Loss loss) {
        if (metric == null || metric.length() == 0)
            return getEvalMetric(loss.defaultEvalMetric());
        else
            return getEvalMetric(metric);
    }

    public static EvalMetric[] getEvalMetrics(String[] metrics) {
        if (metrics.length == 0)
            throw new IllegalArgumentException("No eval metric specified");

        EvalMetric[] result = new EvalMetric[metrics.length];
        for (int i = 0; i < metrics.length; i++) {
            result[i] = getEvalMetric(metrics[i]);
        }
        return result;
    }

    public static EvalMetric[] getEvalMetricsOrDefault(String[] metrics, Loss loss) {
        if (metrics == null || metrics.length == 0)
            return new EvalMetric[]{getEvalMetric(loss.defaultEvalMetric())};
        else
            return getEvalMetrics(metrics);
    }
}