google-api-client 0.34.0 → 0.35.0

data/generated/google/apis/ml_v1/classes.rb

@@ -294,6 +294,87 @@ module Google
         end
       end
       
+      # Request for explanations to be issued against a trained model.
+      class GoogleCloudMlV1ExplainRequest
+        include Google::Apis::Core::Hashable
+      
+        # Message that represents an arbitrary HTTP body. It should only be used for
+        # payload formats that can't be represented as JSON, such as raw binary or
+        # an HTML page.
+        # This message can be used both in streaming and non-streaming API methods in
+        # the request as well as the response.
+        # It can be used as a top-level request field, which is convenient if one
+        # wants to extract parameters from either the URL or HTTP template into the
+        # request fields and also want access to the raw HTTP body.
+        # Example:
+        # message GetResourceRequest `
+        # // A unique request id.
+        # string request_id = 1;
+        # // The raw HTTP body is bound to this field.
+        # google.api.HttpBody http_body = 2;
+        # `
+        # service ResourceService `
+        # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
+        # rpc UpdateResource(google.api.HttpBody) returns
+        # (google.protobuf.Empty);
+        # `
+        # Example with streaming methods:
+        # service CaldavService `
+        # rpc GetCalendar(stream google.api.HttpBody)
+        # returns (stream google.api.HttpBody);
+        # rpc UpdateCalendar(stream google.api.HttpBody)
+        # returns (stream google.api.HttpBody);
+        # `
+        # Use of this type only changes how the request and response bodies are
+        # handled, all other features will continue to work unchanged.
+        # Corresponds to the JSON property `httpBody`
+        # @return [Google::Apis::MlV1::GoogleApiHttpBody]
+        attr_accessor :http_body
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @http_body = args[:http_body] if args.key?(:http_body)
+        end
+      end
+      
+      # Message holding configuration options for explaining model predictions.
+      # Currently, the only supported mechanism to explain a model's prediction is
+      # through attributing its output back to its inputs which is essentially a
+      # credit assignment task. We support multiple attribution methods, some
+      # specific to particular frameworks like Tensorflow and XGBoost.
+      # Next idx: 7.
+      class GoogleCloudMlV1ExplanationConfig
+        include Google::Apis::Core::Hashable
+      
+        # Attributes credit by computing the Aumann-Shapley value taking advantage
+        # of the model's fully differentiable structure. Refer to this paper for
+        # more details: http://proceedings.mlr.press/v70/sundararajan17a.html
+        # Corresponds to the JSON property `integratedGradientsAttribution`
+        # @return [Google::Apis::MlV1::GoogleCloudMlV1IntegratedGradientsAttribution]
+        attr_accessor :integrated_gradients_attribution
+      
+        # An attribution method that approximates Shapley values for features that
+        # contribute to the label being predicted. A sampling strategy is used to
+        # approximate the value rather than considering all subsets of features.
+        # Corresponds to the JSON property `sampledShapleyAttribution`
+        # @return [Google::Apis::MlV1::GoogleCloudMlV1SampledShapleyAttribution]
+        attr_accessor :sampled_shapley_attribution
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @integrated_gradients_attribution = args[:integrated_gradients_attribution] if args.key?(:integrated_gradients_attribution)
+          @sampled_shapley_attribution = args[:sampled_shapley_attribution] if args.key?(:sampled_shapley_attribution)
+        end
+      end
+      
       # Returns service account information associated with a project.
       class GoogleCloudMlV1GetConfigResponse
         include Google::Apis::Core::Hashable
@@ -490,6 +571,29 @@ module Google
         end
       end
       
+      # Attributes credit by computing the Aumann-Shapley value taking advantage
+      # of the model's fully differentiable structure. Refer to this paper for
+      # more details: http://proceedings.mlr.press/v70/sundararajan17a.html
+      class GoogleCloudMlV1IntegratedGradientsAttribution
+        include Google::Apis::Core::Hashable
+      
+        # Number of steps for approximating the path integral.
+        # A good value to start is 50 and gradually increase until the
+        # sum to diff property is met within the desired error range.
+        # Corresponds to the JSON property `numIntegralSteps`
+        # @return [Fixnum]
+        attr_accessor :num_integral_steps
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @num_integral_steps = args[:num_integral_steps] if args.key?(:num_integral_steps)
+        end
+      end
+      
       # Represents a training or prediction job.
       class GoogleCloudMlV1Job
         include Google::Apis::Core::Hashable
@@ -1284,6 +1388,28 @@ module Google
         end
       end
       
+      # An attribution method that approximates Shapley values for features that
+      # contribute to the label being predicted. A sampling strategy is used to
+      # approximate the value rather than considering all subsets of features.
+      class GoogleCloudMlV1SampledShapleyAttribution
+        include Google::Apis::Core::Hashable
+      
+        # The number of feature permutations to consider when approximating the
+        # shapley values.
+        # Corresponds to the JSON property `numPaths`
+        # @return [Fixnum]
+        attr_accessor :num_paths
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @num_paths = args[:num_paths] if args.key?(:num_paths)
+        end
+      end
+      
       # Request message for the SetDefaultVersion request.
       class GoogleCloudMlV1SetDefaultVersionRequest
         include Google::Apis::Core::Hashable
@@ -1331,92 +1457,10 @@ module Google
         attr_accessor :master_config
       
         # Optional. Specifies the type of virtual machine to use for your training
-        # job's master worker.
+        # job's master worker. You must specify this field when `scaleTier` is set to
+        # `CUSTOM`.
+        # You can use certain Compute Engine machine types directly in this field.
         # The following types are supported:
-        # <dl>
-        # <dt>standard</dt>
-        # <dd>
-        # A basic machine configuration suitable for training simple models with
-        # small to moderate datasets.
-        # </dd>
-        # <dt>large_model</dt>
-        # <dd>
-        # A machine with a lot of memory, specially suited for parameter servers
-        # when your model is large (having many hidden layers or layers with very
-        # large numbers of nodes).
-        # </dd>
-        # <dt>complex_model_s</dt>
-        # <dd>
-        # A machine suitable for the master and workers of the cluster when your
-        # model requires more computation than the standard machine can handle
-        # satisfactorily.
-        # </dd>
-        # <dt>complex_model_m</dt>
-        # <dd>
-        # A machine with roughly twice the number of cores and roughly double the
-        # memory of <i>complex_model_s</i>.
-        # </dd>
-        # <dt>complex_model_l</dt>
-        # <dd>
-        # A machine with roughly twice the number of cores and roughly double the
-        # memory of <i>complex_model_m</i>.
-        # </dd>
-        # <dt>standard_gpu</dt>
-        # <dd>
-        # A machine equivalent to <i>standard</i> that
-        # also includes a single NVIDIA Tesla K80 GPU. See more about
-        # <a href="/ml-engine/docs/tensorflow/using-gpus">using GPUs to
-        # train your model</a>.
-        # </dd>
-        # <dt>complex_model_m_gpu</dt>
-        # <dd>
-        # A machine equivalent to <i>complex_model_m</i> that also includes
-        # four NVIDIA Tesla K80 GPUs.
-        # </dd>
-        # <dt>complex_model_l_gpu</dt>
-        # <dd>
-        # A machine equivalent to <i>complex_model_l</i> that also includes
-        # eight NVIDIA Tesla K80 GPUs.
-        # </dd>
-        # <dt>standard_p100</dt>
-        # <dd>
-        # A machine equivalent to <i>standard</i> that
-        # also includes a single NVIDIA Tesla P100 GPU.
-        # </dd>
-        # <dt>complex_model_m_p100</dt>
-        # <dd>
-        # A machine equivalent to <i>complex_model_m</i> that also includes
-        # four NVIDIA Tesla P100 GPUs.
-        # </dd>
-        # <dt>standard_v100</dt>
-        # <dd>
-        # A machine equivalent to <i>standard</i> that
-        # also includes a single NVIDIA Tesla V100 GPU.
-        # </dd>
-        # <dt>large_model_v100</dt>
-        # <dd>
-        # A machine equivalent to <i>large_model</i> that
-        # also includes a single NVIDIA Tesla V100 GPU.
-        # </dd>
-        # <dt>complex_model_m_v100</dt>
-        # <dd>
-        # A machine equivalent to <i>complex_model_m</i> that
-        # also includes four NVIDIA Tesla V100 GPUs.
-        # </dd>
-        # <dt>complex_model_l_v100</dt>
-        # <dd>
-        # A machine equivalent to <i>complex_model_l</i> that
-        # also includes eight NVIDIA Tesla V100 GPUs.
-        # </dd>
-        # <dt>cloud_tpu</dt>
-        # <dd>
-        # A TPU VM including one Cloud TPU. See more about
-        # <a href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to train
-        # your model</a>.
-        # </dd>
-        # </dl>
-        # You may also use certain Compute Engine machine types directly in this
-        # field. The following types are supported:
         # - `n1-standard-4`
         # - `n1-standard-8`
         # - `n1-standard-16`
@@ -1434,9 +1478,29 @@ module Google
         # - `n1-highcpu-32`
         # - `n1-highcpu-64`
         # - `n1-highcpu-96`
-        # See more about [using Compute Engine machine
-        # types](/ml-engine/docs/tensorflow/machine-types#compute-engine-machine-types).
-        # You must set this value when `scaleTier` is set to `CUSTOM`.
+        # Learn more about [using Compute Engine machine
+        # types](/ml-engine/docs/machine-types#compute-engine-machine-types).
+        # Alternatively, you can use the following legacy machine types:
+        # - `standard`
+        # - `large_model`
+        # - `complex_model_s`
+        # - `complex_model_m`
+        # - `complex_model_l`
+        # - `standard_gpu`
+        # - `complex_model_m_gpu`
+        # - `complex_model_l_gpu`
+        # - `standard_p100`
+        # - `complex_model_m_p100`
+        # - `standard_v100`
+        # - `large_model_v100`
+        # - `complex_model_m_v100`
+        # - `complex_model_l_v100`
+        # Learn more about [using legacy machine
+        # types](/ml-engine/docs/machine-types#legacy-machine-types).
+        # Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
+        # field. Learn more about the [special configuration options for training
+        # with
+        # TPUs](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine).
         # Corresponds to the JSON property `masterType`
         # @return [String]
         attr_accessor :master_type
@@ -1468,8 +1532,8 @@ module Google
         # The supported values are the same as those described in the entry for
         # `master_type`.
         # This value must be consistent with the category of machine type that
-        # `masterType` uses. In other words, both must be AI Platform machine
-        # types or both must be Compute Engine machine types.
+        # `masterType` uses. In other words, both must be Compute Engine machine
+        # types or both must be legacy machine types.
         # This value must be present when `scaleTier` is set to `CUSTOM` and
         # `parameter_server_count` is greater than zero.
         # Corresponds to the JSON property `parameterServerType`
@@ -1539,8 +1603,8 @@ module Google
         # The supported values are the same as those described in the entry for
         # `masterType`.
         # This value must be consistent with the category of machine type that
-        # `masterType` uses. In other words, both must be AI Platform machine
-        # types or both must be Compute Engine machine types.
+        # `masterType` uses. In other words, both must be Compute Engine machine
+        # types or both must be legacy machine types.
         # If you use `cloud_tpu` for this value, see special instructions for
         # [configuring a custom TPU
         # machine](/ml-engine/docs/tensorflow/using-tpus#
@@ -1707,6 +1771,16 @@ module Google
         # @return [String]
         attr_accessor :etag
       
+        # Message holding configuration options for explaining model predictions.
+        # Currently, the only supported mechanism to explain a model's prediction is
+        # through attributing its output back to its inputs which is essentially a
+        # credit assignment task. We support multiple attribution methods, some
+        # specific to particular frameworks like Tensorflow and XGBoost.
+        # Next idx: 7.
+        # Corresponds to the JSON property `explanationConfig`
+        # @return [Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig]
+        attr_accessor :explanation_config
+      
         # Optional. The machine learning framework AI Platform uses to train
         # this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`,
         # `XGBOOST`. If you do not specify a framework, AI Platform
@@ -1903,6 +1977,7 @@ module Google
           @description = args[:description] if args.key?(:description)
           @error_message = args[:error_message] if args.key?(:error_message)
           @etag = args[:etag] if args.key?(:etag)
+          @explanation_config = args[:explanation_config] if args.key?(:explanation_config)
           @framework = args[:framework] if args.key?(:framework)
           @is_default = args[:is_default] if args.key?(:is_default)
           @labels = args[:labels] if args.key?(:labels)
@@ -2158,8 +2233,8 @@ module Google
         # ensure that their change will be applied to the same version of the policy.
         # If no `etag` is provided in the call to `setIamPolicy`, then the existing
         # policy is overwritten. Due to blind-set semantics of an etag-less policy,
-        # 'setIamPolicy' will not fail even if either of incoming or stored policy
-        # does not meet the version requirements.
+        # 'setIamPolicy' will not fail even if the incoming policy version does not
+        # meet the requirements for modifying the stored policy.
         # Corresponds to the JSON property `etag`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -2170,11 +2245,12 @@ module Google
         # rejected.
         # Operations affecting conditional bindings must specify version 3. This can
         # be either setting a conditional policy, modifying a conditional binding,
-        # or removing a conditional binding from the stored conditional policy.
+        # or removing a binding (conditional or unconditional) from the stored
+        # conditional policy.
         # Operations on non-conditional policies may specify any valid value or
         # leave the field unset.
-        # If no etag is provided in the call to `setIamPolicy`, any version
-        # compliance checks on the incoming and/or stored policy is skipped.
+        # If no etag is provided in the call to `setIamPolicy`, version compliance
+        # checks against the stored policy is skipped.
         # Corresponds to the JSON property `version`
         # @return [Fixnum]
         attr_accessor :version

data/generated/google/apis/ml_v1/representations.rb

@@ -70,6 +70,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudMlV1ExplainRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudMlV1ExplanationConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudMlV1GetConfigResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -88,6 +100,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudMlV1IntegratedGradientsAttribution
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudMlV1Job
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -178,6 +196,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudMlV1SampledShapleyAttribution
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudMlV1SetDefaultVersionRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -337,6 +361,24 @@ module Google
         end
       end
       
+      class GoogleCloudMlV1ExplainRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :http_body, as: 'httpBody', class: Google::Apis::MlV1::GoogleApiHttpBody, decorator: Google::Apis::MlV1::GoogleApiHttpBody::Representation
+      
+        end
+      end
+      
+      class GoogleCloudMlV1ExplanationConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :integrated_gradients_attribution, as: 'integratedGradientsAttribution', class: Google::Apis::MlV1::GoogleCloudMlV1IntegratedGradientsAttribution, decorator: Google::Apis::MlV1::GoogleCloudMlV1IntegratedGradientsAttribution::Representation
+      
+          property :sampled_shapley_attribution, as: 'sampledShapleyAttribution', class: Google::Apis::MlV1::GoogleCloudMlV1SampledShapleyAttribution, decorator: Google::Apis::MlV1::GoogleCloudMlV1SampledShapleyAttribution::Representation
+      
+        end
+      end
+      
       class GoogleCloudMlV1GetConfigResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -381,6 +423,13 @@ module Google
         end
       end
       
+      class GoogleCloudMlV1IntegratedGradientsAttribution
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :num_integral_steps, as: 'numIntegralSteps'
+        end
+      end
+      
       class GoogleCloudMlV1Job
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -553,6 +602,13 @@ module Google
         end
       end
       
+      class GoogleCloudMlV1SampledShapleyAttribution
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :num_paths, as: 'numPaths'
+        end
+      end
+      
       class GoogleCloudMlV1SetDefaultVersionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -614,6 +670,8 @@ module Google
           property :description, as: 'description'
           property :error_message, as: 'errorMessage'
           property :etag, :base64 => true, as: 'etag'
+          property :explanation_config, as: 'explanationConfig', class: Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig, decorator: Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig::Representation
+      
           property :framework, as: 'framework'
           property :is_default, as: 'isDefault'
           hash :labels, as: 'labels'

data/generated/google/apis/ml_v1/service.rb

@@ -47,6 +47,43 @@ module Google
           @batch_path = 'batch'
         end
         
+        # Performs explanation on the data in the request.
+        # AI Platform implements a custom `explain` verb on top of an HTTP POST
+        # method. <p>For details of the request and response format, see the **guide
+        # to the [explain request format](/ml-engine/docs/v1/explain-request)**.
+        # @param [String] name
+        #   Required. The resource name of a model or a version.
+        #   Authorization: requires the `predict` permission on the specified resource.
+        # @param [Google::Apis::MlV1::GoogleCloudMlV1ExplainRequest] google_cloud_ml_v1__explain_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::MlV1::GoogleApiHttpBody] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MlV1::GoogleApiHttpBody]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def explain_project(name, google_cloud_ml_v1__explain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:explain', options)
+          command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1ExplainRequest::Representation
+          command.request_object = google_cloud_ml_v1__explain_request_object
+          command.response_representation = Google::Apis::MlV1::GoogleApiHttpBody::Representation
+          command.response_class = Google::Apis::MlV1::GoogleApiHttpBody
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Get the service account information associated with your project. You need
         # this information in order to grant the service account permissions for
         # the Google Cloud Storage location where you put your model training code

data/generated/google/apis/ml_v1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://cloud.google.com/ml/
     module MlV1
       VERSION = 'V1'
-      REVISION = '20191025'
+      REVISION = '20191112'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'