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 com.oracle.labs.mlrg.olcut.config.Options;
020import org.tribuo.Trainer;
021
022/**
023 * An {@link Options} that can produce a classification {@link Trainer} based on the
024 * provided arguments.
025 * @param <TRAINER> The type of the trainer produced.
026 */
027public interface ClassificationOptions<TRAINER extends Trainer<Label>> extends Options {
028
029    /**
030     * Constructs the trainer based on the provided arguments.
031     * @return The trainer.
032     */
033    TRAINER getTrainer();
034
035}