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.sequence;
018
019import com.oracle.labs.mlrg.olcut.provenance.Provenancable;
020import org.tribuo.Output;
021import org.tribuo.OutputFactory;
022import org.tribuo.provenance.DataSourceProvenance;
023
024/**
025 * A interface for things that can be given to a SequenceDataset's constructor.
026 * <p>
027 * DataSources are used to do inbound ETL of data on disk or held externally.
028 */
029public interface SequenceDataSource<T extends Output<T>> extends Provenancable<DataSourceProvenance>, Iterable<SequenceExample<T>> {
030
031    /**
032     * Gets the OutputFactory which was used to generate the Outputs in this SequenceDataSource.
033     * @return The output factory.
034     */
035    public OutputFactory<T> getOutputFactory();
036
037}