Class Dataset

Definition

Namespace:: Tizen.MachineLearning.Train

Assembly:: Tizen.MachineLearning.Train.dll

API Level:: 10

Feature:: http://tizen.org/feature/machine_learning.training

Create the dataset for neural network


                C#
                
                    Copy
                    
                
            
public class Dataset : IDisposable

Inheritance: System.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

View Source

Dataset()

Constructs the dataset.

Declaration


                C#
                
                    Copy
                    
                
            
public Dataset()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
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.

API Level: 10

Methods

View Source

AddFile(NNTrainerDatasetMode, String)

Adds data file to dataset.

Declaration


                C#
                
                    Copy
                    
                
            
public void AddFile(NNTrainerDatasetMode mode, string file)

Parameters

Type	Name	Description
NNTrainerDatasetMode	mode	The phase where this file should be used.
System.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.
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.

API Level: 10

View Source

Dispose()

Releases any unmanaged resources used by this object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
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.

API Level: 10

View Source

Dispose(Boolean)

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

Declaration


                C#
                
                    Copy
                    
                
            
protected virtual void Dispose(bool disposing)

Parameters

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

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the feature is not supported.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
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.

API Level: 10

View Source

Finalize()

Frees the neural network dataset.

Declaration


                C#
                
                    Copy
                    
                
            
protected void Finalize()

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.
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.

API Level: 10

View Source

SetProperty(NNTrainerDatasetMode, String[])

Sets the neural network dataset property.

Declaration


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

Parameters

Type	Name	Description
NNTrainerDatasetMode	mode	The mode to set the property.
System.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.
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.

API Level: 10

Implements

System.IDisposable