google_api_language

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.Language.V1.Model.XPSVisualization do
  @moduledoc """
  Visualization configurations for image explanation.

  ## Attributes

  *   `clipPercentLowerbound` (*type:* `number()`, *default:* `nil`) - Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
  *   `clipPercentUpperbound` (*type:* `number()`, *default:* `nil`) - Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
  *   `colorMap` (*type:* `String.t`, *default:* `nil`) - The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
  *   `overlayType` (*type:* `String.t`, *default:* `nil`) - How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
  *   `polarity` (*type:* `String.t`, *default:* `nil`) - Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
  *   `type` (*type:* `String.t`, *default:* `nil`) - Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :clipPercentLowerbound => number() | nil,
          :clipPercentUpperbound => number() | nil,
          :colorMap => String.t() | nil,
          :overlayType => String.t() | nil,
          :polarity => String.t() | nil,
          :type => String.t() | nil
        }

  field(:clipPercentLowerbound)
  field(:clipPercentUpperbound)
  field(:colorMap)
  field(:overlayType)
  field(:polarity)
  field(:type)
end

defimpl Poison.Decoder, for: GoogleApi.Language.V1.Model.XPSVisualization do
  def decode(value, options) do
    GoogleApi.Language.V1.Model.XPSVisualization.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Language.V1.Model.XPSVisualization do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end