Class SingleShot
Definition
- Assembly:
- Tizen.MachineLearning.Inference.dll
The SingleShot class loads a Machine Learning model and make inferences from input data.
public class SingleShot : IDisposable
- Inheritance
-
objectSingleShot
- Implements
-
System.IDisposable
Constructors
View SourceSingleShot(string, NNFWType, HWType, bool)
Loads the neural network model and configures runtime environment without TensorsInfo
Declaration
public SingleShot(string modelAbsPath, NNFWType fwType = NNFWType.Any, HWType hwType = HWType.Any, bool isDynamicMode = false)
Parameters
Type | Name | Description |
---|---|---|
string | modelAbsPath | Absolute path to the neural network model file. |
NNFWType | fwType | Types of Neural Network Framework (Default:NNFWType.Any) |
HWType | hwType | Types of hardware resources to be used for NNFWs (Default: HWType.Any) |
bool | isDynamicMode | Support Dynamic Mode (Default: false) |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
System.NotSupportedException | Thrown when the feature is not supported. |
SingleShot(string, TensorsInfo, TensorsInfo, NNFWType, HWType, bool)
Loads the neural network model and configures runtime environment with Neural Network Framework and HW information
Declaration
public SingleShot(string modelAbsPath, TensorsInfo inTensorsInfo, TensorsInfo outTensorsInfo, NNFWType fwType, HWType hwType, bool isDynamicMode)
Parameters
Type | Name | Description |
---|---|---|
string | modelAbsPath | Absolute path to the neural network model file. |
TensorsInfo | inTensorsInfo | Input TensorsInfo object |
TensorsInfo | outTensorsInfo | Output TensorsInfo object for inference result |
NNFWType | fwType | Types of Neural Network Framework |
HWType | hwType | Types of hardware resources to be used for NNFWs |
bool | isDynamicMode | Support Dynamic Mode |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
System.NotSupportedException | Thrown when the feature is not supported. |
SingleShot(string, TensorsInfo, TensorsInfo)
Loads the neural network model and configures runtime environment
Declaration
public SingleShot(string modelAbsPath, TensorsInfo inTensorsInfo, TensorsInfo outTensorsInfo)
Parameters
Type | Name | Description |
---|---|---|
string | modelAbsPath | Absolute path to the neural network model file. |
TensorsInfo | inTensorsInfo | Input TensorsInfo object |
TensorsInfo | outTensorsInfo | Output TensorsInfo object for inference result |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
System.NotSupportedException | Thrown when the feature is not supported. |
Properties
View SourceInput
The information (tensor dimension, type, name and so on) of required input data for the given model.
Declaration
public TensorsInfo Input { get; set; }
Property Value
Type | Description |
---|---|
TensorsInfo |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
Output
The information (tensor dimension, type, name and so on) of output data for the given model.
Declaration
public TensorsInfo Output { get; }
Property Value
Type | Description |
---|---|
TensorsInfo |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
Methods
View SourceDispose()
Releases any unmanaged resources used by this object.
Declaration
public void Dispose()
Dispose(bool)
Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
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. |
~SingleShot()
Destructor of the Single instance.
Declaration
protected ~SingleShot()
GetValue(string)
Gets the property value for the given model.
Declaration
public string GetValue(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The property name |
Returns
Type | Description |
---|---|
string | The property value |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported, or given property is not available. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
Invoke(TensorsData)
Invokes the model with the given input data.
Declaration
public TensorsData Invoke(TensorsData inTensorsData)
Parameters
Type | Name | Description |
---|---|---|
TensorsData | inTensorsData | The input data to be inferred. |
Returns
Type | Description |
---|---|
TensorsData | TensorsData instance which contains the inferred result. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
System.TimeoutException | Thrown when failed to get the result from sink element. |
System.NotSupportedException | Thrown when the feature is not supported. |
SetTimeout(int)
Sets the maximum amount of time to wait for an output, in milliseconds.
Declaration
public void SetTimeout(int ms)
Parameters
Type | Name | Description |
---|---|---|
int | ms | The time to wait for an output (milliseconds) |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |
SetValue(string, string)
Sets the property value for the given model.
A model/framework may support changing the model information, such as tensor dimension and data layout, after opening the model.
If tries to change unavailable property or the model does not allow changing the information, this will raise an exception.
For the details about the properties, see 'tensor_filter' plugin definition in NNStreamer.
Declaration
public void SetValue(string name, string value)
Parameters
Type | Name | Description |
---|---|---|
string | name | The property name |
string | value | The property value |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported, or given property is not available. |
System.ArgumentException | Thrown when the method failed due to an invalid parameter. |