001/*
002 * Copyright (c) 2015-2020, Oracle and/or its affiliates. All rights reserved.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.tribuo.evaluation.metrics;
018
019import com.oracle.labs.mlrg.olcut.util.Pair;
020import org.tribuo.Output;
021import org.tribuo.evaluation.Evaluation;
022
023/**
024 * Just an easier-to-read alias for {@code Pair<MetricTarget<T>, String>}.
025 * <p>
026 * Used as a key in metric result maps. See {@link Evaluation#asMap()}.
027 * <p>
028 * @param <T> The type of output.
029 */
030public final class MetricID<T extends Output<T>> extends Pair<MetricTarget<T>, String> {
031    private static final long serialVersionUID = 1L;
032
033    public MetricID(MetricTarget<T> target, String metricName) {
034        super(target, metricName);
035    }
036
037    @Override
038    public String toString() {
039        String targetStr = (getA().getOutputTarget().isPresent()) ?
040                getA().getOutputTarget().get().toString() :
041                getA().getAverageTarget().get().name();
042        return String.format("MetricID{metric==%s target=%s}", getB(), targetStr);
043    }
044}