org.eclipse.kura.ai.inference

Class ModelInfo

java.lang.Object

org.eclipse.kura.ai.inference.ModelInfo

@ProviderType
public class ModelInfo
extends java.lang.Object

The ModelInfo class represents the metadata of a model for Artificial Intelligence and Machine Learning algorithms

Since:

2.3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelInfo(java.lang.String modelName, java.util.Optional<java.lang.String> platform, java.util.Optional<java.lang.String> version, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.List<TensorDescriptor> inputDescriptors, java.util.List<TensorDescriptor> outputDescriptors) Instantiates a new ModelInfo

Method Summary

Modifier and Type	Method and Description
static ModelInfoBuilder	builder(java.lang.String name) Instantiates a builder for a ModelInfo
java.util.List<TensorDescriptor>	getInputs() Return the descriptors of the input tensors
java.lang.String	getName() Return the name of the model
java.util.List<TensorDescriptor>	getOutputs() Return the descriptors of the output tensors
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Return the optional parameters assigned to the model
java.util.Optional<java.lang.String>	getPlatform() Return the platform used for running this model
java.util.Optional<java.lang.String>	getVersion() Return the version of the model
ModelInfoBuilder	toBuilder() Creates a new ModelInfoBuilder and initializes it from this ModelInfo instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelInfo

protected ModelInfo(java.lang.String modelName,
                    java.util.Optional<java.lang.String> platform,
                    java.util.Optional<java.lang.String> version,
                    java.util.Map<java.lang.String,java.lang.Object> parameters,
                    java.util.List<TensorDescriptor> inputDescriptors,
                    java.util.List<TensorDescriptor> outputDescriptors)

Instantiates a new ModelInfo

Parameters:

modelName - the name of the model

platform - an optional string representing the model platform

version - an optional string representing the model version

parameters - a map containing the model parameters. It can be empty.

inputDescriptors - a list of TensorDescriptor of the input tensors

outputDescriptors - a list of TensorDescriptor of the output tensors

Method Detail

builder

public static ModelInfoBuilder builder(java.lang.String name)

Instantiates a builder for a ModelInfo

Parameters:

name - the name of the model

Returns:

a ModelInfoBuilder

toBuilder

public ModelInfoBuilder toBuilder()

Creates a new ModelInfoBuilder and initializes it from this ModelInfo instance.

Returns:

a new ModelInfoBuilder

getName

public java.lang.String getName()

Return the name of the model

Returns:

a string representing the model name

getPlatform

public java.util.Optional<java.lang.String> getPlatform()

Return the platform used for running this model

Returns:

an optional string representing the model platform

getVersion

public java.util.Optional<java.lang.String> getVersion()

Return the version of the model

Returns:

an optional string representing the version of the model

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Return the optional parameters assigned to the model

Returns:

an unmodifiable map containing the model parameters

getInputs

public java.util.List<TensorDescriptor> getInputs()

Return the descriptors of the input tensors

Returns:

an unmodifiable list of TensorDescriptor of the input tensors

getOutputs

public java.util.List<TensorDescriptor> getOutputs()

Return the descriptors of the output tensors

Returns:

an unmodifiable list of TensorDescriptor of the output tensors