{-# 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.HyperParameterTuningJobObjective
-- 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.HyperParameterTuningJobObjective 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

-- | Defines the objective metric for a hyperparameter tuning job.
-- Hyperparameter tuning uses the value of this metric to evaluate the
-- training jobs it launches, and returns the training job that results in
-- either the highest or lowest value for this metric, depending on the
-- value you specify for the @Type@ parameter.
--
-- /See:/ 'newHyperParameterTuningJobObjective' smart constructor.
data HyperParameterTuningJobObjective = HyperParameterTuningJobObjective'
  { -- | Whether to minimize or maximize the objective metric.
    HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjectiveType
type' :: HyperParameterTuningJobObjectiveType,
    -- | The name of the metric to use for the objective metric.
    HyperParameterTuningJobObjective -> Text
metricName :: Prelude.Text
  }
  deriving (HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjective -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjective -> Bool
$c/= :: HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjective -> Bool
== :: HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjective -> Bool
$c== :: HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjective -> Bool
Prelude.Eq, ReadPrec [HyperParameterTuningJobObjective]
ReadPrec HyperParameterTuningJobObjective
Int -> ReadS HyperParameterTuningJobObjective
ReadS [HyperParameterTuningJobObjective]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HyperParameterTuningJobObjective]
$creadListPrec :: ReadPrec [HyperParameterTuningJobObjective]
readPrec :: ReadPrec HyperParameterTuningJobObjective
$creadPrec :: ReadPrec HyperParameterTuningJobObjective
readList :: ReadS [HyperParameterTuningJobObjective]
$creadList :: ReadS [HyperParameterTuningJobObjective]
readsPrec :: Int -> ReadS HyperParameterTuningJobObjective
$creadsPrec :: Int -> ReadS HyperParameterTuningJobObjective
Prelude.Read, Int -> HyperParameterTuningJobObjective -> ShowS
[HyperParameterTuningJobObjective] -> ShowS
HyperParameterTuningJobObjective -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HyperParameterTuningJobObjective] -> ShowS
$cshowList :: [HyperParameterTuningJobObjective] -> ShowS
show :: HyperParameterTuningJobObjective -> String
$cshow :: HyperParameterTuningJobObjective -> String
showsPrec :: Int -> HyperParameterTuningJobObjective -> ShowS
$cshowsPrec :: Int -> HyperParameterTuningJobObjective -> ShowS
Prelude.Show, forall x.
Rep HyperParameterTuningJobObjective x
-> HyperParameterTuningJobObjective
forall x.
HyperParameterTuningJobObjective
-> Rep HyperParameterTuningJobObjective x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep HyperParameterTuningJobObjective x
-> HyperParameterTuningJobObjective
$cfrom :: forall x.
HyperParameterTuningJobObjective
-> Rep HyperParameterTuningJobObjective x
Prelude.Generic)

-- |
-- Create a value of 'HyperParameterTuningJobObjective' 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'', 'hyperParameterTuningJobObjective_type' - Whether to minimize or maximize the objective metric.
--
-- 'metricName', 'hyperParameterTuningJobObjective_metricName' - The name of the metric to use for the objective metric.
newHyperParameterTuningJobObjective ::
  -- | 'type''
  HyperParameterTuningJobObjectiveType ->
  -- | 'metricName'
  Prelude.Text ->
  HyperParameterTuningJobObjective
newHyperParameterTuningJobObjective :: HyperParameterTuningJobObjectiveType
-> Text -> HyperParameterTuningJobObjective
newHyperParameterTuningJobObjective
  HyperParameterTuningJobObjectiveType
pType_
  Text
pMetricName_ =
    HyperParameterTuningJobObjective'
      { $sel:type':HyperParameterTuningJobObjective' :: HyperParameterTuningJobObjectiveType
type' = HyperParameterTuningJobObjectiveType
pType_,
        $sel:metricName:HyperParameterTuningJobObjective' :: Text
metricName = Text
pMetricName_
      }

-- | Whether to minimize or maximize the objective metric.
hyperParameterTuningJobObjective_type :: Lens.Lens' HyperParameterTuningJobObjective HyperParameterTuningJobObjectiveType
hyperParameterTuningJobObjective_type :: Lens'
  HyperParameterTuningJobObjective
  HyperParameterTuningJobObjectiveType
hyperParameterTuningJobObjective_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HyperParameterTuningJobObjective' {HyperParameterTuningJobObjectiveType
type' :: HyperParameterTuningJobObjectiveType
$sel:type':HyperParameterTuningJobObjective' :: HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjectiveType
type'} -> HyperParameterTuningJobObjectiveType
type') (\s :: HyperParameterTuningJobObjective
s@HyperParameterTuningJobObjective' {} HyperParameterTuningJobObjectiveType
a -> HyperParameterTuningJobObjective
s {$sel:type':HyperParameterTuningJobObjective' :: HyperParameterTuningJobObjectiveType
type' = HyperParameterTuningJobObjectiveType
a} :: HyperParameterTuningJobObjective)

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

instance
  Data.FromJSON
    HyperParameterTuningJobObjective
  where
  parseJSON :: Value -> Parser HyperParameterTuningJobObjective
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"HyperParameterTuningJobObjective"
      ( \Object
x ->
          HyperParameterTuningJobObjectiveType
-> Text -> HyperParameterTuningJobObjective
HyperParameterTuningJobObjective'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser 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")
      )

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

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

instance Data.ToJSON HyperParameterTuningJobObjective where
  toJSON :: HyperParameterTuningJobObjective -> Value
toJSON HyperParameterTuningJobObjective' {Text
HyperParameterTuningJobObjectiveType
metricName :: Text
type' :: HyperParameterTuningJobObjectiveType
$sel:metricName:HyperParameterTuningJobObjective' :: HyperParameterTuningJobObjective -> Text
$sel:type':HyperParameterTuningJobObjective' :: HyperParameterTuningJobObjective
-> HyperParameterTuningJobObjectiveType
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Type" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= HyperParameterTuningJobObjectiveType
type'),
            forall a. a -> Maybe a
Prelude.Just (Key
"MetricName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
metricName)
          ]
      )