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.classification;
018
019import org.tribuo.Trainer;
020
021import java.util.Map;
022
023/**
024 * Tag interface denoting the {@link Trainer} can use label weights.
025 */
026public interface WeightedLabels {
027
028    /**
029     * Sets the label weights used by this trainer.
030     * <p>
031     * Supply {@link java.util.Collections#emptyMap()} to turn off label weights.
032     * @param map A map from Label instances to weight values.
033     */
034    public void setLabelWeights(Map<Label,Float> map);
035
036}
037
038