starttrainedmodeldeployment

Documentation

Overview

Start a trained model deployment.

Index

• Variables
• type NewStartTrainedModelDeployment
  • func NewStartTrainedModelDeploymentFunc(tp elastictransport.Interface) NewStartTrainedModelDeployment
• type Response
  • func NewResponse() *Response
• type StartTrainedModelDeployment
  • func New(tp elastictransport.Interface) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) CacheSize(bytesize string) *StartTrainedModelDeployment
  • func (r StartTrainedModelDeployment) Do(ctx context.Context) (*Response, error)
  • func (r *StartTrainedModelDeployment) Header(key, value string) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r StartTrainedModelDeployment) IsSuccess(ctx context.Context) (bool, error)
  • func (r *StartTrainedModelDeployment) ModelId(modelid string) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) NumberOfAllocations(numberofallocations int) *StartTrainedModelDeployment
  • func (r StartTrainedModelDeployment) Perform(ctx context.Context) (*http.Response, error)
  • func (r *StartTrainedModelDeployment) Priority(priority trainingpriority.TrainingPriority) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) QueueCapacity(queuecapacity int) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) ThreadsPerAllocation(threadsperallocation int) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) Timeout(duration string) *StartTrainedModelDeployment
  • func (r *StartTrainedModelDeployment) WaitFor(waitfor deploymentallocationstate.DeploymentAllocationState) *StartTrainedModelDeployment

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type NewStartTrainedModelDeployment

type NewStartTrainedModelDeployment func(modelid string) *StartTrainedModelDeployment

NewStartTrainedModelDeployment type alias for index.

func NewStartTrainedModelDeploymentFunc

func NewStartTrainedModelDeploymentFunc(tp elastictransport.Interface) NewStartTrainedModelDeployment

NewStartTrainedModelDeploymentFunc returns a new instance of StartTrainedModelDeployment with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response struct {
	Assignment types.TrainedModelAssignment `json:"assignment"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StartTrainedModelDeployment

type StartTrainedModelDeployment struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *StartTrainedModelDeployment

Start a trained model deployment.

https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html

func (*StartTrainedModelDeployment) CacheSize

func (r *StartTrainedModelDeployment) CacheSize(bytesize string) *StartTrainedModelDeployment

CacheSize The inference cache size (in memory outside the JVM heap) per node for the model. The default value is the same size as the `model_size_bytes`. To disable the cache, `0b` can be provided. API name: cache_size

func (StartTrainedModelDeployment) Do

func (r StartTrainedModelDeployment) Do(ctx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a starttrainedmodeldeployment.Response

func (*StartTrainedModelDeployment) Header

func (r *StartTrainedModelDeployment) Header(key, value string) *StartTrainedModelDeployment

Header set a key, value pair in the StartTrainedModelDeployment headers map.

func (*StartTrainedModelDeployment) HttpRequest

func (r *StartTrainedModelDeployment) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (StartTrainedModelDeployment) IsSuccess

func (r StartTrainedModelDeployment) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (*StartTrainedModelDeployment) ModelId

func (r *StartTrainedModelDeployment) ModelId(modelid string) *StartTrainedModelDeployment

ModelId The unique identifier of the trained model. Currently, only PyTorch models are supported. API Name: modelid

func (*StartTrainedModelDeployment) NumberOfAllocations

func (r *StartTrainedModelDeployment) NumberOfAllocations(numberofallocations int) *StartTrainedModelDeployment

NumberOfAllocations The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. API name: number_of_allocations

func (StartTrainedModelDeployment) Perform

func (r StartTrainedModelDeployment) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*StartTrainedModelDeployment) Priority

func (r *StartTrainedModelDeployment) Priority(priority trainingpriority.TrainingPriority) *StartTrainedModelDeployment

Priority The deployment priority. API name: priority

func (*StartTrainedModelDeployment) QueueCapacity

func (r *StartTrainedModelDeployment) QueueCapacity(queuecapacity int) *StartTrainedModelDeployment

QueueCapacity Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds this value, new requests are rejected with a 429 error. API name: queue_capacity

func (*StartTrainedModelDeployment) ThreadsPerAllocation

func (r *StartTrainedModelDeployment) ThreadsPerAllocation(threadsperallocation int) *StartTrainedModelDeployment

ThreadsPerAllocation Sets the number of threads used by each model allocation during inference. This generally increases the inference speed. The inference process is a compute-bound process; any number greater than the number of available hardware threads on the machine does not increase the inference speed. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. API name: threads_per_allocation

func (*StartTrainedModelDeployment) Timeout

func (r *StartTrainedModelDeployment) Timeout(duration string) *StartTrainedModelDeployment

Timeout Specifies the amount of time to wait for the model to deploy. API name: timeout

func (*StartTrainedModelDeployment) WaitFor

func (r *StartTrainedModelDeployment) WaitFor(waitfor deploymentallocationstate.DeploymentAllocationState) *StartTrainedModelDeployment

WaitFor Specifies the allocation status to wait for before returning. API name: wait_for