Package org.opensearch.ml.common.dataset

Class DataFrameInputDataset

java.lang.Object

org.opensearch.ml.common.dataset.MLInputDataset

org.opensearch.ml.common.dataset.DataFrameInputDataset

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable

public class DataFrameInputDataset
extends MLInputDataset

DataFrame based input data. Client directly passes the data frame to ML plugin with this.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataFrameInputDataset.DataFrameInputDatasetBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
DataFrameInputDataset(org.opensearch.core.common.io.stream.StreamInput in)
DataFrameInputDataset(@NonNull DataFrame dataFrame)

Method Summary

Modifier and Type	Method	Description
static DataFrameInputDataset.DataFrameInputDatasetBuilder	builder()
DataFrame	getDataFrame()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput streamOutput)

Methods inherited from class org.opensearch.ml.common.dataset.MLInputDataset

fromStream, getInputDataType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DataFrameInputDataset

public DataFrameInputDataset(@NonNull
 @NonNull DataFrame dataFrame)

DataFrameInputDataset

public DataFrameInputDataset(org.opensearch.core.common.io.stream.StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput streamOutput)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class MLInputDataset

Throws:

IOException

builder

public static DataFrameInputDataset.DataFrameInputDatasetBuilder builder()

getDataFrame

public DataFrame getDataFrame()