001/*
002 * Copyright (c) 2021, 2022, 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.sgd.fm;
018
019import com.oracle.labs.mlrg.olcut.config.ConfigurationManager;
020import com.oracle.labs.mlrg.olcut.config.Options;
021import com.oracle.labs.mlrg.olcut.config.UsageException;
022import org.tribuo.Trainer;
023import org.tribuo.classification.Label;
024import org.tribuo.classification.TrainTestHelper;
025import org.tribuo.classification.ensemble.ClassificationEnsembleOptions;
026import org.tribuo.data.DataOptions;
027
028import java.io.IOException;
029import java.util.logging.Logger;
030
031/**
032 * Build and run a classifier for a standard dataset using FMClassificationTrainer.
033 */
034public class TrainTest {
035
036    private static final Logger logger = Logger.getLogger(TrainTest.class.getName());
037
038    /**
039     * Command line options.
040     */
041    public static class TrainTestOptions implements Options {
042        @Override
043        public String getOptionsDescription() {
044            return "Trains and tests a linear SGD model on the specified datasets.";
045        }
046
047        /**
048         * The data loading options.
049         */
050        public DataOptions general;
051        /**
052         * The factorization machine trainer options.
053         */
054        public FMClassificationOptions trainerOptions;
055        /**
056         * The ensemble options.
057         */
058        public ClassificationEnsembleOptions ensembleOptions;
059    }
060
061    /**
062     * Runs a TrainTest CLI.
063     * @param args the command line arguments
064     * @throws IOException if there is any error reading the examples.
065     */
066    public static void main(String[] args) throws IOException {
067        TrainTestOptions o = new TrainTestOptions();
068        try (ConfigurationManager cm = new ConfigurationManager(args,o)) {
069            Trainer<Label> trainer = o.trainerOptions.getTrainer();
070            trainer = o.ensembleOptions.wrapTrainer(trainer);
071            TrainTestHelper.run(cm, o.general, trainer);
072        } catch (UsageException e) {
073            logger.info(e.getMessage());
074        }
075    }
076}