stretchy-model 0.6.0 → 0.6.6

data/docs/styles.css

@@ -0,0 +1,90 @@
+:root {
+    --theme-color: #F9448F;
+    --theme-color-light: #f79fc4;
+    --secondary-color: #8E4EB0;
+}
+
+
+section.cover .cover-main>p:last-child a {
+    border-radius: 2rem;
+    border: 1px solid #F9448F;
+    border-color: var(--theme-color,#F9448F);
+    box-sizing: border-box;
+    color: #F9448F;
+    color: var(--theme-color,#F9448F);
+    display: inline-block;
+    font-size: 1.05rem;
+    letter-spacing: .1rem;
+    margin: .5rem 1rem;
+    padding: .75em 2rem;
+    text-decoration: none;
+    transition: all .15s ease;
+}
+
+section.cover .cover-main>p:last-child a:last-child {
+    background-color: #F9448F;
+    background-color: var(--theme-color,#F9448F);
+    color: #fff;
+}
+
+section.cover .cover-main>p:last-child a:hover {
+    color: #fff !important;
+    border-color: var(--secondary-color, #8E4EB0);
+    background-color: var(--secondary-color, #8E4EB0);
+    /* opacity: .8; */
+}
+
+.docsify-hide a:first-child>img{ display: none;}
+
+.app-sub-sidebar li:before {
+    content: "";
+    padding-right: 4px;
+    float: left;
+}
+
+.sidebar h3 {
+    text-align: center;
+}
+
+
+pre {
+    position: relative;
+}
+pre .clipboard-copy {
+    position: absolute;
+    right: 15px;
+    opacity: 1;
+    top: 20px;
+    color: var(--theme-color, #F9448F);
+    background-color: transparent;
+
+}
+pre .clipboard-copy:hover {
+    cursor: pointer;
+    transition: opacity 0.3s ease;
+    opacity: 1;
+}
+
+pre .clipboard-copy .copy-text {
+    position: absolute;
+    opacity: 0;
+    left: -70px;
+    top: 15px;
+}
+
+pre .clipboard-copy .copy-text.show {
+    transition: top 0.3s ease, opacity 0.3s ease;
+    opacity: 1;
+    color: #8E4EB0;
+    top: 0px;
+}
+
+.show {
+    display: block;
+}
+
+
+
+/*dt,dd {
+    display: flex;
+} */

data/lib/elasticsearch/api/actions/machine_learning/models/delete_model.rb

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Returns a model.
+	        #
+	        # @option arguments [String] :id The model id
+          # @option arguments [Hash] :headers Custom HTTP headers
+	        #
+	        # Example
+	        # delete_model(id: 109sdj0asl092)
+          # 
+          # DELETE /_plugins/_ml/models/<model_id>
+	        def delete_model(arguments = {})
+		        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+		        headers = arguments.delete(:headers) || {}
+		        
+            _id = arguments.delete(:id)
+				
+		        method = Elasticsearch::API::HTTP_DELETE
+		        path   = "_plugins/_ml/models/#{Utils.__listify(_id)}"
+		        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+				
+            body = nil
+		        perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/deploy.rb

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # POST /_plugins/_ml/models/<model_id>/_deploy
+	        def deploy(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+	          _id = arguments.delete(:id)
+	          arguments = arguments.clone
+            headers = arguments.delete(:headers) || {}
+	
+	          method = Elasticsearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/#{Utils.__listify(_id)}/_deploy"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/get_model.rb

@@ -0,0 +1,43 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Returns a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        #
+	        # Example
+	        # get_model(id: 109sdj0asl092)
+	        #
+	        # Example
+	        # # Get all models
+	        # get_model
+          # 
+          # GET /_plugins/_ml/models/<model_id>
+	        def get_model(arguments = {})
+            _id = arguments.delete(:id)
+            headers = arguments.delete(:headers) || {}
+		        method = Elasticsearch::API::HTTP_GET
+		        path   = if _id
+		                     body = nil
+		                     "_ml/trained_models/#{Utils.__listify(_id)}"
+		                   else
+		                     body = {
+														"query": {
+															"match_all": {}
+														},
+														"size": 1000
+													}
+		                     '_ml/trained_models'
+		                   end
+		        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+		
+		        perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/get_status.rb

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # GET /_plugins/_ml/tasks/<task_id>
+	        def get_status(arguments = {})
+						raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+	          _id = arguments.delete(:task_id)
+	          arguments = arguments.clone
+						headers = arguments.delete(:headers) || {}
+	
+	          method = Elasticsearch::API::HTTP_GET
+	          path   = "_plugins/_ml/tasks/#{Utils.__listify(_id)}"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+						body = nil
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/params_registry.rb

@@ -0,0 +1,45 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Models
+          module Actions
+            module ParamsRegistry
+              extend self
+    
+              # A Mapping of all the actions to their list of valid params.
+              #
+              # @since 6.1.1
+              PARAMS = {}
+    
+              # Register an action with its list of valid params.
+              #
+              # @example Register the action.
+              #   ParamsRegistry.register(:benchmark, [ :verbose ])
+              #
+              # @param [ Symbol ] action The action to register.
+              # @param [ Array[Symbol] ] valid_params The list of valid params.
+              #
+              # @since 6.1.1
+              def register(action, valid_params)
+                PARAMS[action.to_sym] = valid_params
+              end
+    
+              # Get the list of valid params for a given action.
+              #
+              # @example Get the list of valid params.
+              #   ParamsRegistry.get(:benchmark)
+              #
+              # @param [ Symbol ] action The action.
+              #
+              # @return [ Array<Symbol> ] The list of valid params for the action.
+              #
+              # @since 6.1.1
+              def get(action)
+                PARAMS.fetch(action, [])
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/register.rb

@@ -0,0 +1,45 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [Hash] :body The model definition **Required**
+	        # @option arguments [Boolean] :deploy Whether to deploy the model after registering it. The deploy operation is performed by calling the [Deploy Model API](https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/deploy-model/). Default is `false`
+	        #
+	        # Example
+          # client.machine_learing_model.register(body: {
+          #	  "name": "huggingface/sentence-transformers/msmarco-distilbert-base-tas-b",
+          #	  "version": "1.0.1",
+          #	  "model_group_id": "Z1eQf4oB5Vm0Tdw8EIP2",
+          #	  "model_format": "TORCH_SCRIPT"
+          #	},
+          #	deploy: true 
+          #
+          # POST /_plugins/_ml/models/_register
+	        def register(arguments = {})
+	          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+	          
+	          arguments = arguments.clone
+            headers = arguments.delete(:headers) || {}
+	
+	          method = Elasticsearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/_register"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	        # Register this action with its valid params when the module is loaded.
+	        #
+	        # @since 6.2.0
+	        ParamsRegistry.register(:put_pipeline, %i[
+				deploy
+	        ].freeze)
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/undeploy.rb

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # POST /_plugins/_ml/models/<model_id>/_undeploy
+	        def undeploy(arguments = {})
+		      raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+	          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+	          _id = arguments.delete(:id)
+	          arguments = arguments.clone
+            headers = arguments.delete(:headers) || {}
+	
+	          method = Elasticsearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/#{Utils.__listify(_id)}/_undeploy"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/models/update_model.rb

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Returns a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The request fields
+	        #
+	        # Example
+	        # update_model(id: 109sdj0asl092, "rate_limiter": {
+          #    "limit": "4",
+          #    "unit": "MINUTES"
+          #  }
+          # )
+          # 
+          # PUT /_plugins/_ml/models/<model_id>
+	        def update_model(arguments = {})
+		        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+		        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+		        
+            _id = arguments.delete(:id)
+
+            headers = arguments.delete(:headers) || {}
+
+		        method = Elasticsearch::API::HTTP_PUT
+		        path   = "_plugins/_ml/models/#{Utils.__listify(_id)}"
+		        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+				
+            body = arguments[:body]
+		        perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/elasticsearch/api/namespace/machine_learning/model.rb

@@ -0,0 +1,27 @@
+Dir[File.expand_path('../../actions/**/*.rb', __dir__)].sort.each   { |f| require f }
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Models
+          module Actions; end
+    
+          # Client for the "machine_learning/models" namespace (includes the {MachineLearning::Models::Actions} methods)
+          #
+          class MachineLearningClient
+            include MachineLearning::Models::Actions
+            include Elasticsearch::API::Common::Client::Base
+            include Elasticsearch::API::Common::Client
+          end
+    
+          # Proxy method for {MachineLearningModel}, available in the receiving object
+          #
+          def machine_learning
+            @machine_learning ||= MachineLearningClient.new(self)
+          end
+    
+          alias ml machine_learning
+        end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/delete_model.rb

@@ -0,0 +1,33 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Returns a model.
+	        #
+	        # @option arguments [String] :id The model id
+          # @option arguments [Hash] :headers Custom HTTP headers
+	        #
+	        # Example
+	        # delete_model(id: 109sdj0asl092)
+          # 
+          # DELETE /_plugins/_ml/models/<model_id>
+	        def delete_model(arguments = {})
+		        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+		        headers = arguments.delete(:headers) || {}
+		        
+            _id = arguments.delete(:id)
+				
+		        method = OpenSearch::API::HTTP_DELETE
+		        path   = "_plugins/_ml/models/#{Utils.__listify(_id)}"
+		        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+				
+            body = nil
+		        perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/deploy.rb

@@ -0,0 +1,31 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # POST /_plugins/_ml/models/<model_id>/_deploy
+	        def deploy(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+	          _id = arguments.delete(:id)
+	          arguments = arguments.clone
+            headers = arguments.delete(:headers) || {}
+	
+	          method = OpenSearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/#{Utils.__listify(_id)}/_deploy"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/get_model.rb

@@ -0,0 +1,44 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Returns a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        #
+	        # Example
+	        # get_model(id: 109sdj0asl092)
+	        #
+	        # Example
+	        # # Get all models
+	        # get_model
+          # 
+          # GET /_plugins/_ml/models/<model_id>
+	        def get_model(arguments = {})
+            _id = arguments.delete(:id)
+            headers = arguments.delete(:headers) || {}
+		        method = OpenSearch::API::HTTP_GET
+		        path   = if _id
+		                     body = nil
+		                     "_plugins/_ml/models/#{Utils.__listify(_id)}"
+		                   else
+		                     body = {
+                            "query": {
+                              "match_all": {}
+                            },
+                            "size": 1000
+                          }
+                        '_plugins/_ml/models/_search'
+		                   end
+
+		        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+		
+		        perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/get_status.rb

@@ -0,0 +1,31 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # GET /_plugins/_ml/tasks/<task_id>
+	        def get_status(arguments = {})
+						raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+	          _id = arguments.delete(:task_id)
+	          arguments = arguments.clone
+						headers = arguments.delete(:headers) || {}
+	
+	          method = OpenSearch::API::HTTP_GET
+	          path   = "_plugins/_ml/tasks/#{Utils.__listify(_id)}"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+						body = nil
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/params_registry.rb

@@ -0,0 +1,45 @@
+module OpenSearch
+  module API
+    module MachineLearning
+      module Models
+          module Actions
+            module ParamsRegistry
+              extend self
+    
+              # A Mapping of all the actions to their list of valid params.
+              #
+              # @since 6.1.1
+              PARAMS = {}
+    
+              # Register an action with its list of valid params.
+              #
+              # @example Register the action.
+              #   ParamsRegistry.register(:benchmark, [ :verbose ])
+              #
+              # @param [ Symbol ] action The action to register.
+              # @param [ Array[Symbol] ] valid_params The list of valid params.
+              #
+              # @since 6.1.1
+              def register(action, valid_params)
+                PARAMS[action.to_sym] = valid_params
+              end
+    
+              # Get the list of valid params for a given action.
+              #
+              # @example Get the list of valid params.
+              #   ParamsRegistry.get(:benchmark)
+              #
+              # @param [ Symbol ] action The action.
+              #
+              # @return [ Array<Symbol> ] The list of valid params for the action.
+              #
+              # @since 6.1.1
+              def get(action)
+                PARAMS.fetch(action, [])
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/register.rb

@@ -0,0 +1,45 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [Hash] :body The model definition **Required**
+	        # @option arguments [Boolean] :deploy Whether to deploy the model after registering it. The deploy operation is performed by calling the [Deploy Model API](https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/deploy-model/). Default is `false`
+	        #
+	        # Example
+          # client.machine_learing_model.register(body: {
+          #	  "name": "huggingface/sentence-transformers/msmarco-distilbert-base-tas-b",
+          #	  "version": "1.0.1",
+          #	  "model_group_id": "Z1eQf4oB5Vm0Tdw8EIP2",
+          #	  "model_format": "TORCH_SCRIPT"
+          #	},
+          #	deploy: true 
+          #
+          # POST /_plugins/_ml/models/_register
+	        def register(arguments = {})
+	          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+	          
+	          arguments = arguments.clone
+            headers = arguments.delete(:headers) || {}
+	
+	          method = OpenSearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/_register"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	        # Register this action with its valid params when the module is loaded.
+	        #
+	        # @since 6.2.0
+	        ParamsRegistry.register(:register, %i[
+						deploy
+	        ].freeze)
+	      end
+	    end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/undeploy.rb

@@ -0,0 +1,31 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # POST /_plugins/_ml/models/<model_id>/_undeploy
+	        def undeploy(arguments = {})
+						raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+	          _id = arguments.delete(:id)
+	          arguments = arguments.clone
+            headers = arguments.delete(:headers) || {}
+	
+	          method = OpenSearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/#{Utils.__listify(_id)}/_undeploy"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+	          perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end