Class Dataset

Definition

Namespace:

Tizen.MachineLearning.Train

Assembly:

Tizen.MachineLearning.Train.dll

Create the dataset for neural network

public class Dataset : IDisposable

Inheritance

object

Dataset

Implements

System.IDisposable

Remarks

Use this class to create a dataset. dataset should be released using Dispose(). dataset is available until the model is released.

Constructors

Dataset()

Constructs the dataset.

Declaration

public Dataset()

Remarks

Use this class to create a dataset. dataset should be released using Dispose(). dataset is available until the model is released.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.UnauthorizedAccessException	Thrown when the application does not have the required privilege.
System.InvalidOperationException	Thrown when the method failed due to the wrong pipeline description or internal error.

Methods

AddFile(NNTrainerDatasetMode, string)

Adds data file to dataset.

Declaration

public void AddFile(NNTrainerDatasetMode mode, string file)

Parameters

Type	Name	Description
NNTrainerDatasetMode	mode	The phase where this file should be used.
string	file	File path.

Remarks

Use this method to add a data file from where data is retrieved. If you want to access only internal storage by using this method, you should add privilege %http://tizen.org/privilege/mediastorage. Or, if you want to access only external storage by using this method, you should add privilege %http://tizen.org/privilege/externalstorage. If you can access both storage, you must add all privilege

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.UnauthorizedAccessException	Thrown when the application does not have the required privilege.
System.InvalidOperationException	Thrown when the method failed due to the wrong pipeline description or internal error.

Dispose()

Releases any unmanaged resources used by this object.

Declaration

public void Dispose()

Remarks

Use this class to create a dataset. dataset should be released using Dispose(). dataset is available until the model is released.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.UnauthorizedAccessException	Thrown when the application does not have the required privilege.
System.InvalidOperationException	Thrown when the method failed due to the wrong pipeline description or internal error.

Dispose(bool)

Releases any unmanaged resources used by this object including opened handle.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	If true, disposes any disposable objects. If false, does not dispose disposable objects.

Remarks

Use this class to create a dataset. dataset should be released using Dispose(). dataset is available until the model is released.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.UnauthorizedAccessException	Thrown when the application does not have the required privilege.
System.InvalidOperationException	Thrown when the method failed due to the wrong pipeline description or internal error.

~Dataset()

Frees the neural network dataset.

Declaration

protected ~Dataset()

Remarks

Use this method to destroy dataset. Fails if dataset is owned by a model.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.UnauthorizedAccessException	Thrown when the application does not have the required privilege.
System.InvalidOperationException	Thrown when the method failed due to the wrong pipeline description or internal error.

SetProperty(NNTrainerDatasetMode, params string[])

Sets the neural network dataset property.

Declaration

public void SetProperty(NNTrainerDatasetMode mode, params string[] property)

Parameters

Type	Name	Description
NNTrainerDatasetMode	mode	The mode to set the property.
string[]	property	Property for dataset.

Remarks

Use this method to set dataset property for a specific mode. The input format of property must be 'key = value' format.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.UnauthorizedAccessException	Thrown when the application does not have the required privilege.
System.InvalidOperationException	Thrown when the method failed due to the wrong pipeline description or internal error.

Implements

System.IDisposable