Skip to content

Commit

Permalink
[API] Promotes machine learning APIs from Experimental to Beta
Browse files Browse the repository at this point in the history
machine_learning.clear_trained_model_deployment_cache.rb
machine_learning.infer_trained_model.rb
machine_learning.put_trained_model_definition_part.rb
machine_learning.put_trained_model_vocabulary.rb
machine_learning.start_trained_model_deployment.rb
machine_learning.stop_trained_model_deployment.rb
  • Loading branch information
picandocodigo committed Oct 17, 2022
1 parent ca4998f commit 56e015a
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ module API
module MachineLearning
module Actions
# Clear the cached results from a trained model deployment
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in Beta and is subject to change. The design and
# code is less mature than official GA features and is being provided
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
# @option arguments [Hash] :headers Custom HTTP headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ module API
module MachineLearning
module Actions
# Evaluate a trained model.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in Beta and is subject to change. The design and
# code is less mature than official GA features and is being provided
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
# @option arguments [Time] :timeout Controls the amount of time to wait for inference results.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ module API
module MachineLearning
module Actions
# Creates part of a trained model definition
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in Beta and is subject to change. The design and
# code is less mature than official GA features and is being provided
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [String] :model_id The ID of the trained model for this definition part
# @option arguments [Integer] :part The part number
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ module API
module MachineLearning
module Actions
# Creates a trained model vocabulary
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in Beta and is subject to change. The design and
# code is less mature than official GA features and is being provided
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [String] :model_id The ID of the trained model for this vocabulary
# @option arguments [Hash] :headers Custom HTTP headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ module API
module MachineLearning
module Actions
# Start a trained model deployment.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in Beta and is subject to change. The design and
# code is less mature than official GA features and is being provided
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
# @option arguments [String] :cache_size A byte-size value for configuring the inference cache size. For example, 20mb.
# @option arguments [Integer] :number_of_allocations The number of model allocations on each node where the model is deployed.
# @option arguments [Integer] :number_of_allocations The total number of allocations this model is assigned across machine learning nodes.
# @option arguments [Integer] :threads_per_allocation The number of threads used by each model allocation during inference.
# @option arguments [Integer] :queue_capacity Controls how many inference requests are allowed in the queue at a time.
# @option arguments [Time] :timeout Controls the amount of time to wait for the model to deploy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ module API
module MachineLearning
module Actions
# Stop a trained model deployment.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in Beta and is subject to change. The design and
# code is less mature than official GA features and is being provided
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified)
Expand Down

0 comments on commit 56e015a

Please sign in to comment.