Package org.api4.java.ai.ml.core.dataset

Interface IDataSource<I extends IInstance>

All Superinterfaces:

IInstanceSchemaHandler, java.lang.Iterable<I>

All Known Subinterfaces:

IDataset<I>, IDyadRankingDataset, IDyadRankingDataSource, ILabeledDataset<I>, ILabeledDataSource<I>, ILabelRankingDataset, ILabelRankingDataSource, IMultiLabelClassificationDataset<I>, IMultiLabelClassificationDataSource<I>, IRankingDataset<O,I>, IRankingDataSource<O,I>, IRegressionDataset, IRegressionDataSource, ISingleLabelClassificationDataset, ISingleLabelClassificationDataSource<I>

public interface IDataSource<I extends IInstance>
extends IInstanceSchemaHandler, java.lang.Iterable<I>

The general dataset interface.

Method Summary

Modifier and Type	Method	Description
IDataSource<I>	createCopy()	Creates a copy of the dataset with the same meta data.
IDataSource<I>	createEmptyCopy()	Creates an empty copy of the dataset with the same meta data.

Methods inherited from interface org.api4.java.ai.ml.core.dataset.schema.IInstanceSchemaHandler

getAttribute, getInstanceSchema, getListOfAttributes, getNumAttributes

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

createEmptyCopy

IDataSource<I> createEmptyCopy()
                        throws DatasetCreationException,
                               java.lang.InterruptedException

Creates an empty copy of the dataset with the same meta data.

Returns:

The newly created dataset.

Throws:

DatasetCreationException - Thrown, if an issue occurred while copying the meta data of the dataset.

java.lang.InterruptedException - Thrown, if the process of copying the meta data of the dataset has been interrupted.

createCopy

IDataSource<I> createCopy()
                   throws DatasetCreationException,
                          java.lang.InterruptedException

Creates a copy of the dataset with the same meta data.

Returns:

The newly created dataset.

Throws:

DatasetCreationException - Thrown, if an issue occurred while copying the meta data of the dataset.

java.lang.InterruptedException - Thrown, if the process of copying the meta data of the dataset has been interrupted.