Class DataFrameIter

Inheritance

System.Object

DataFrameIter

Namespace: SiaNet.Data

Assembly: SiaNet.dll

Syntax

public class DataFrameIter

Constructors

DataFrameIter(DataFrame, DataFrame)

Initializes a new instance of the DataFrameIter class.

Declaration

public DataFrameIter(DataFrame X, DataFrame Y = null)

Parameters

Type	Name	Description
DataFrame	X	The X data frame.
DataFrame	Y	The Y data frame.

DataFrameIter(Tensor, Tensor)

Initializes a new instance of the DataFrameIter class.

Declaration

public DataFrameIter(Tensor X, Tensor Y = null)

Parameters

Type	Name	Description
Tensor	X	The X Tensor.
Tensor	Y	The Y Tensor.

Properties

DataSize

Gets the size of the data which is typically the number of records or images to be processed.

Declaration

public long DataSize { get; }

Property Value

Type	Description
System.Int64	The size of the data.

Methods

GetBatch()

Gets the next batch of data to process.

Declaration

public (Tensor, Tensor)GetBatch()

Returns

Type	Description
System.ValueTuple<Tensor, Tensor>

GetBatchX()

Gets the batch for X data frame.

Declaration

public Tensor GetBatchX()

Returns

Type	Description
Tensor

GetBatchY()

Gets the batch Y data frame.

Declaration

public Tensor GetBatchY()

Returns

Type	Description
Tensor

Next()

Navigates to next batch.

Declaration

public bool Next()

Returns

Type	Description
System.Boolean

Reset()

Resets this batch size.

Declaration

public void Reset()

SetBatchSize(Int32)

Sets the size of the batch.

Declaration

public void SetBatchSize(int _batchSize)

Parameters

Type	Name	Description
System.Int32	_batchSize	Size of the batch.

Shuffle()

Shuffles this data set randomly.

Declaration

public void Shuffle()

Split(Double)

Splits the current dataset to train and test.

Declaration

public (DataFrameIter, DataFrameIter)Split(double testDataSize = 0.33000001311302185)

Parameters

Type	Name	Description
System.Double	testDataSize	Size of the test data.

Returns

Type	Description
System.ValueTuple<DataFrameIter, DataFrameIter>