{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SageMaker.Types.FinalHyperParameterTuningJobObjectiveMetric
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.SageMaker.Types.FinalHyperParameterTuningJobObjectiveMetric where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.SageMaker.Types.HyperParameterTuningJobObjectiveType

-- | Shows the final value for the objective metric for a training job that
-- was launched by a hyperparameter tuning job. You define the objective
-- metric in the @HyperParameterTuningJobObjective@ parameter of
-- HyperParameterTuningJobConfig.
--
-- /See:/ 'newFinalHyperParameterTuningJobObjectiveMetric' smart constructor.
data FinalHyperParameterTuningJobObjectiveMetric = FinalHyperParameterTuningJobObjectiveMetric'
  { -- | Whether to minimize or maximize the objective metric. Valid values are
    -- Minimize and Maximize.
    FinalHyperParameterTuningJobObjectiveMetric
-> Maybe HyperParameterTuningJobObjectiveType
type' :: Prelude.Maybe HyperParameterTuningJobObjectiveType,
    -- | The name of the objective metric.
    FinalHyperParameterTuningJobObjectiveMetric -> Text
metricName :: Prelude.Text,
    -- | The value of the objective metric.
    FinalHyperParameterTuningJobObjectiveMetric -> Double
value :: Prelude.Double
  }
  deriving (FinalHyperParameterTuningJobObjectiveMetric
-> FinalHyperParameterTuningJobObjectiveMetric -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FinalHyperParameterTuningJobObjectiveMetric
-> FinalHyperParameterTuningJobObjectiveMetric -> Bool
$c/= :: FinalHyperParameterTuningJobObjectiveMetric
-> FinalHyperParameterTuningJobObjectiveMetric -> Bool
== :: FinalHyperParameterTuningJobObjectiveMetric
-> FinalHyperParameterTuningJobObjectiveMetric -> Bool
$c== :: FinalHyperParameterTuningJobObjectiveMetric
-> FinalHyperParameterTuningJobObjectiveMetric -> Bool
Prelude.Eq, ReadPrec [FinalHyperParameterTuningJobObjectiveMetric]
ReadPrec FinalHyperParameterTuningJobObjectiveMetric
Int -> ReadS FinalHyperParameterTuningJobObjectiveMetric
ReadS [FinalHyperParameterTuningJobObjectiveMetric]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FinalHyperParameterTuningJobObjectiveMetric]
$creadListPrec :: ReadPrec [FinalHyperParameterTuningJobObjectiveMetric]
readPrec :: ReadPrec FinalHyperParameterTuningJobObjectiveMetric
$creadPrec :: ReadPrec FinalHyperParameterTuningJobObjectiveMetric
readList :: ReadS [FinalHyperParameterTuningJobObjectiveMetric]
$creadList :: ReadS [FinalHyperParameterTuningJobObjectiveMetric]
readsPrec :: Int -> ReadS FinalHyperParameterTuningJobObjectiveMetric
$creadsPrec :: Int -> ReadS FinalHyperParameterTuningJobObjectiveMetric
Prelude.Read, Int -> FinalHyperParameterTuningJobObjectiveMetric -> ShowS
[FinalHyperParameterTuningJobObjectiveMetric] -> ShowS
FinalHyperParameterTuningJobObjectiveMetric -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FinalHyperParameterTuningJobObjectiveMetric] -> ShowS
$cshowList :: [FinalHyperParameterTuningJobObjectiveMetric] -> ShowS
show :: FinalHyperParameterTuningJobObjectiveMetric -> String
$cshow :: FinalHyperParameterTuningJobObjectiveMetric -> String
showsPrec :: Int -> FinalHyperParameterTuningJobObjectiveMetric -> ShowS
$cshowsPrec :: Int -> FinalHyperParameterTuningJobObjectiveMetric -> ShowS
Prelude.Show, forall x.
Rep FinalHyperParameterTuningJobObjectiveMetric x
-> FinalHyperParameterTuningJobObjectiveMetric
forall x.
FinalHyperParameterTuningJobObjectiveMetric
-> Rep FinalHyperParameterTuningJobObjectiveMetric x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep FinalHyperParameterTuningJobObjectiveMetric x
-> FinalHyperParameterTuningJobObjectiveMetric
$cfrom :: forall x.
FinalHyperParameterTuningJobObjectiveMetric
-> Rep FinalHyperParameterTuningJobObjectiveMetric x
Prelude.Generic)

-- |
-- Create a value of 'FinalHyperParameterTuningJobObjectiveMetric' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'type'', 'finalHyperParameterTuningJobObjectiveMetric_type' - Whether to minimize or maximize the objective metric. Valid values are
-- Minimize and Maximize.
--
-- 'metricName', 'finalHyperParameterTuningJobObjectiveMetric_metricName' - The name of the objective metric.
--
-- 'value', 'finalHyperParameterTuningJobObjectiveMetric_value' - The value of the objective metric.
newFinalHyperParameterTuningJobObjectiveMetric ::
  -- | 'metricName'
  Prelude.Text ->
  -- | 'value'
  Prelude.Double ->
  FinalHyperParameterTuningJobObjectiveMetric
newFinalHyperParameterTuningJobObjectiveMetric :: Text -> Double -> FinalHyperParameterTuningJobObjectiveMetric
newFinalHyperParameterTuningJobObjectiveMetric
  Text
pMetricName_
  Double
pValue_ =
    FinalHyperParameterTuningJobObjectiveMetric'
      { $sel:type':FinalHyperParameterTuningJobObjectiveMetric' :: Maybe HyperParameterTuningJobObjectiveType
type' =
          forall a. Maybe a
Prelude.Nothing,
        $sel:metricName:FinalHyperParameterTuningJobObjectiveMetric' :: Text
metricName = Text
pMetricName_,
        $sel:value:FinalHyperParameterTuningJobObjectiveMetric' :: Double
value = Double
pValue_
      }

-- | Whether to minimize or maximize the objective metric. Valid values are
-- Minimize and Maximize.
finalHyperParameterTuningJobObjectiveMetric_type :: Lens.Lens' FinalHyperParameterTuningJobObjectiveMetric (Prelude.Maybe HyperParameterTuningJobObjectiveType)
finalHyperParameterTuningJobObjectiveMetric_type :: Lens'
  FinalHyperParameterTuningJobObjectiveMetric
  (Maybe HyperParameterTuningJobObjectiveType)
finalHyperParameterTuningJobObjectiveMetric_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FinalHyperParameterTuningJobObjectiveMetric' {Maybe HyperParameterTuningJobObjectiveType
type' :: Maybe HyperParameterTuningJobObjectiveType
$sel:type':FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric
-> Maybe HyperParameterTuningJobObjectiveType
type'} -> Maybe HyperParameterTuningJobObjectiveType
type') (\s :: FinalHyperParameterTuningJobObjectiveMetric
s@FinalHyperParameterTuningJobObjectiveMetric' {} Maybe HyperParameterTuningJobObjectiveType
a -> FinalHyperParameterTuningJobObjectiveMetric
s {$sel:type':FinalHyperParameterTuningJobObjectiveMetric' :: Maybe HyperParameterTuningJobObjectiveType
type' = Maybe HyperParameterTuningJobObjectiveType
a} :: FinalHyperParameterTuningJobObjectiveMetric)

-- | The name of the objective metric.
finalHyperParameterTuningJobObjectiveMetric_metricName :: Lens.Lens' FinalHyperParameterTuningJobObjectiveMetric Prelude.Text
finalHyperParameterTuningJobObjectiveMetric_metricName :: Lens' FinalHyperParameterTuningJobObjectiveMetric Text
finalHyperParameterTuningJobObjectiveMetric_metricName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FinalHyperParameterTuningJobObjectiveMetric' {Text
metricName :: Text
$sel:metricName:FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric -> Text
metricName} -> Text
metricName) (\s :: FinalHyperParameterTuningJobObjectiveMetric
s@FinalHyperParameterTuningJobObjectiveMetric' {} Text
a -> FinalHyperParameterTuningJobObjectiveMetric
s {$sel:metricName:FinalHyperParameterTuningJobObjectiveMetric' :: Text
metricName = Text
a} :: FinalHyperParameterTuningJobObjectiveMetric)

-- | The value of the objective metric.
finalHyperParameterTuningJobObjectiveMetric_value :: Lens.Lens' FinalHyperParameterTuningJobObjectiveMetric Prelude.Double
finalHyperParameterTuningJobObjectiveMetric_value :: Lens' FinalHyperParameterTuningJobObjectiveMetric Double
finalHyperParameterTuningJobObjectiveMetric_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FinalHyperParameterTuningJobObjectiveMetric' {Double
value :: Double
$sel:value:FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric -> Double
value} -> Double
value) (\s :: FinalHyperParameterTuningJobObjectiveMetric
s@FinalHyperParameterTuningJobObjectiveMetric' {} Double
a -> FinalHyperParameterTuningJobObjectiveMetric
s {$sel:value:FinalHyperParameterTuningJobObjectiveMetric' :: Double
value = Double
a} :: FinalHyperParameterTuningJobObjectiveMetric)

instance
  Data.FromJSON
    FinalHyperParameterTuningJobObjectiveMetric
  where
  parseJSON :: Value -> Parser FinalHyperParameterTuningJobObjectiveMetric
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"FinalHyperParameterTuningJobObjectiveMetric"
      ( \Object
x ->
          Maybe HyperParameterTuningJobObjectiveType
-> Text -> Double -> FinalHyperParameterTuningJobObjectiveMetric
FinalHyperParameterTuningJobObjectiveMetric'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Type")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MetricName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Value")
      )

instance
  Prelude.Hashable
    FinalHyperParameterTuningJobObjectiveMetric
  where
  hashWithSalt :: Int -> FinalHyperParameterTuningJobObjectiveMetric -> Int
hashWithSalt
    Int
_salt
    FinalHyperParameterTuningJobObjectiveMetric' {Double
Maybe HyperParameterTuningJobObjectiveType
Text
value :: Double
metricName :: Text
type' :: Maybe HyperParameterTuningJobObjectiveType
$sel:value:FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric -> Double
$sel:metricName:FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric -> Text
$sel:type':FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric
-> Maybe HyperParameterTuningJobObjectiveType
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe HyperParameterTuningJobObjectiveType
type'
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
metricName
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Double
value

instance
  Prelude.NFData
    FinalHyperParameterTuningJobObjectiveMetric
  where
  rnf :: FinalHyperParameterTuningJobObjectiveMetric -> ()
rnf FinalHyperParameterTuningJobObjectiveMetric' {Double
Maybe HyperParameterTuningJobObjectiveType
Text
value :: Double
metricName :: Text
type' :: Maybe HyperParameterTuningJobObjectiveType
$sel:value:FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric -> Double
$sel:metricName:FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric -> Text
$sel:type':FinalHyperParameterTuningJobObjectiveMetric' :: FinalHyperParameterTuningJobObjectiveMetric
-> Maybe HyperParameterTuningJobObjectiveType
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe HyperParameterTuningJobObjectiveType
type'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
metricName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Double
value