Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference

Class TrainedModelConfig

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.TrainedModelConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class TrainedModelConfig
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrainedModelConfig.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	COMPRESSED_DEFINITION
static final ParseField	CREATE_TIME
static final ParseField	CREATED_BY
static final int	CURRENT_DEFINITION_COMPRESSION_VERSION
static final String	DECOMPRESS_DEFINITION
static final ParseField	DEFAULT_FIELD_MAP
static final ParseField	DEFINITION
static final String	DEFINITION_STATUS
static final ParseField	DEPRECATED_ESTIMATED_HEAP_MEMORY_USAGE_BYTES
static final ParseField	DESCRIPTION
static final ParseField	ESTIMATED_OPERATIONS
static final String	FEATURE_IMPORTANCE_BASELINE
static final String	HYPERPARAMETERS
static final ParseField	INFERENCE_CONFIG
static final ParseField	INPUT
static final ObjectParser<TrainedModelConfig.Builder,Void>	LENIENT_PARSER
static final ParseField	LICENSE_LEVEL
static final ParseField	LOCATION
static final ParseField	METADATA
static final String	MODEL_ALIASES
static final ParseField	MODEL_ID
static final ParseField	MODEL_PACKAGE
static final ParseField	MODEL_SIZE_BYTES
static final ParseField	MODEL_SIZE_BYTES_WITH_DEPRECATION
static final ParseField	MODEL_TYPE
static final String	NAME
static final ParseField	PER_ALLOCATION_MEMORY_BYTES
static final ParseField	PER_DEPLOYMENT_MEMORY_BYTES
static final ParseField	PLATFORM_ARCHITECTURE
static final ParseField	PREFIX_STRINGS
static final ObjectParser<TrainedModelConfig.Builder,Void>	STRICT_PARSER
static final ParseField	TAGS
static final String	TOTAL_FEATURE_IMPORTANCE
static final ParseField	VERSION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TrainedModelConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static TrainedModelConfig.Builder	builder()
void	clearCompressed()
TrainedModelConfig	ensureParsedDefinition(NamedXContentRegistry xContentRegistry)
TrainedModelConfig	ensureParsedDefinitionUnsafe(NamedXContentRegistry xContentRegistry)
boolean	equals(Object o)
static TrainedModelConfig.Builder	fromXContent(XContentParser parser, boolean lenient)
BytesReference	getCompressedDefinition()
BytesReference	getCompressedDefinitionIfSet()
String	getCreatedBy()
Instant	getCreateTime()
Map<String,String>	getDefaultFieldMap()
String	getDescription()
long	getEstimatedOperations()
InferenceConfig	getInferenceConfig()
TrainedModelInput	getInput()
License.OperationMode	getLicenseLevel()
TrainedModelLocation	getLocation()
Map<String,Object>	getMetadata()
TrainedModelDefinition	getModelDefinition()
String	getModelId()
ModelPackageConfig	getModelPackageConfig()
long	getModelSize()
TrainedModelType	getModelType()
long	getPerAllocationMemoryBytes()
long	getPerDeploymentMemoryBytes()
String	getPlatformArchitecture()
TrainedModelPrefixStrings	getPrefixStrings()
List<String>	getTags()
MlConfigVersion	getVersion()
int	hashCode()
boolean	isAllocateOnly()
boolean	isPackagedModel()
void	setFullDefinition(boolean fullDefinition)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CURRENT_DEFINITION_COMPRESSION_VERSION

public static final int CURRENT_DEFINITION_COMPRESSION_VERSION

See Also:

• Constant Field Values

DECOMPRESS_DEFINITION

public static final String DECOMPRESS_DEFINITION

See Also:

• Constant Field Values

TOTAL_FEATURE_IMPORTANCE

public static final String TOTAL_FEATURE_IMPORTANCE

See Also:

• Constant Field Values

FEATURE_IMPORTANCE_BASELINE

public static final String FEATURE_IMPORTANCE_BASELINE

See Also:

• Constant Field Values

HYPERPARAMETERS

public static final String HYPERPARAMETERS

See Also:

• Constant Field Values

MODEL_ALIASES

public static final String MODEL_ALIASES

See Also:

• Constant Field Values

DEFINITION_STATUS

public static final String DEFINITION_STATUS

See Also:

• Constant Field Values

MODEL_ID

public static final ParseField MODEL_ID

MODEL_TYPE

public static final ParseField MODEL_TYPE

CREATED_BY

public static final ParseField CREATED_BY

VERSION

public static final ParseField VERSION

DESCRIPTION

public static final ParseField DESCRIPTION

CREATE_TIME

public static final ParseField CREATE_TIME

DEFINITION

public static final ParseField DEFINITION

COMPRESSED_DEFINITION

public static final ParseField COMPRESSED_DEFINITION

TAGS

public static final ParseField TAGS

METADATA

public static final ParseField METADATA

INPUT

public static final ParseField INPUT

MODEL_SIZE_BYTES

public static final ParseField MODEL_SIZE_BYTES

MODEL_SIZE_BYTES_WITH_DEPRECATION

public static final ParseField MODEL_SIZE_BYTES_WITH_DEPRECATION

DEPRECATED_ESTIMATED_HEAP_MEMORY_USAGE_BYTES

public static final ParseField DEPRECATED_ESTIMATED_HEAP_MEMORY_USAGE_BYTES

ESTIMATED_OPERATIONS

public static final ParseField ESTIMATED_OPERATIONS

LICENSE_LEVEL

public static final ParseField LICENSE_LEVEL

DEFAULT_FIELD_MAP

public static final ParseField DEFAULT_FIELD_MAP

INFERENCE_CONFIG

public static final ParseField INFERENCE_CONFIG

LOCATION

public static final ParseField LOCATION

MODEL_PACKAGE

public static final ParseField MODEL_PACKAGE

PREFIX_STRINGS

public static final ParseField PREFIX_STRINGS

PER_DEPLOYMENT_MEMORY_BYTES

public static final ParseField PER_DEPLOYMENT_MEMORY_BYTES

PER_ALLOCATION_MEMORY_BYTES

public static final ParseField PER_ALLOCATION_MEMORY_BYTES

PLATFORM_ARCHITECTURE

public static final ParseField PLATFORM_ARCHITECTURE

LENIENT_PARSER

public static final ObjectParser<TrainedModelConfig.Builder,Void> LENIENT_PARSER

STRICT_PARSER

public static final ObjectParser<TrainedModelConfig.Builder,Void> STRICT_PARSER

Constructor Details

TrainedModelConfig

public TrainedModelConfig(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

fromXContent

public static TrainedModelConfig.Builder fromXContent(XContentParser parser,
 boolean lenient)
                                               throws IOException

Throws:

IOException

isPackagedModel

public boolean isPackagedModel()

getModelId

public String getModelId()

getModelType

@Nullable
public TrainedModelType getModelType()

getCreatedBy

public String getCreatedBy()

getVersion

public MlConfigVersion getVersion()

getDescription

public String getDescription()

getCreateTime

public Instant getCreateTime()

getTags

public List<String> getTags()

getMetadata

public Map<String,Object> getMetadata()

getDefaultFieldMap

public Map<String,String> getDefaultFieldMap()

getInferenceConfig

@Nullable
public InferenceConfig getInferenceConfig()

getCompressedDefinition

@Nullable
public BytesReference getCompressedDefinition()
                                       throws IOException

Throws:

IOException

getCompressedDefinitionIfSet

public BytesReference getCompressedDefinitionIfSet()

getModelPackageConfig

public ModelPackageConfig getModelPackageConfig()

clearCompressed

public void clearCompressed()

ensureParsedDefinition

public TrainedModelConfig ensureParsedDefinition(NamedXContentRegistry xContentRegistry)
                                          throws IOException

Throws:

IOException

ensureParsedDefinitionUnsafe

public TrainedModelConfig ensureParsedDefinitionUnsafe(NamedXContentRegistry xContentRegistry)
                                                throws IOException

Throws:

IOException

getModelDefinition

@Nullable
public TrainedModelDefinition getModelDefinition()

getLocation

@Nullable
public TrainedModelLocation getLocation()

getInput

public TrainedModelInput getInput()

builder

public static TrainedModelConfig.Builder builder()

getModelSize

public long getModelSize()

getEstimatedOperations

public long getEstimatedOperations()

getLicenseLevel

public License.OperationMode getLicenseLevel()

isAllocateOnly

public boolean isAllocateOnly()

setFullDefinition

public void setFullDefinition(boolean fullDefinition)

getPerDeploymentMemoryBytes

public long getPerDeploymentMemoryBytes()

getPerAllocationMemoryBytes

public long getPerAllocationMemoryBytes()

getPlatformArchitecture

public String getPlatformArchitecture()

getPrefixStrings

public TrainedModelPrefixStrings getPrefixStrings()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object