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

-- | This structure specifies how to split the data into train and validation
-- datasets. The validation and training datasets must contain the same
-- headers. The validation dataset must be less than 2 GB in size.
--
-- /See:/ 'newAutoMLDataSplitConfig' smart constructor.
data AutoMLDataSplitConfig = AutoMLDataSplitConfig'
  { -- | The validation fraction (optional) is a float that specifies the portion
    -- of the training dataset to be used for validation. The default value is
    -- 0.2, and values must be greater than 0 and less than 1. We recommend
    -- setting this value to be less than 0.5.
    AutoMLDataSplitConfig -> Maybe Double
validationFraction :: Prelude.Maybe Prelude.Double
  }
  deriving (AutoMLDataSplitConfig -> AutoMLDataSplitConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AutoMLDataSplitConfig -> AutoMLDataSplitConfig -> Bool
$c/= :: AutoMLDataSplitConfig -> AutoMLDataSplitConfig -> Bool
== :: AutoMLDataSplitConfig -> AutoMLDataSplitConfig -> Bool
$c== :: AutoMLDataSplitConfig -> AutoMLDataSplitConfig -> Bool
Prelude.Eq, ReadPrec [AutoMLDataSplitConfig]
ReadPrec AutoMLDataSplitConfig
Int -> ReadS AutoMLDataSplitConfig
ReadS [AutoMLDataSplitConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AutoMLDataSplitConfig]
$creadListPrec :: ReadPrec [AutoMLDataSplitConfig]
readPrec :: ReadPrec AutoMLDataSplitConfig
$creadPrec :: ReadPrec AutoMLDataSplitConfig
readList :: ReadS [AutoMLDataSplitConfig]
$creadList :: ReadS [AutoMLDataSplitConfig]
readsPrec :: Int -> ReadS AutoMLDataSplitConfig
$creadsPrec :: Int -> ReadS AutoMLDataSplitConfig
Prelude.Read, Int -> AutoMLDataSplitConfig -> ShowS
[AutoMLDataSplitConfig] -> ShowS
AutoMLDataSplitConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AutoMLDataSplitConfig] -> ShowS
$cshowList :: [AutoMLDataSplitConfig] -> ShowS
show :: AutoMLDataSplitConfig -> String
$cshow :: AutoMLDataSplitConfig -> String
showsPrec :: Int -> AutoMLDataSplitConfig -> ShowS
$cshowsPrec :: Int -> AutoMLDataSplitConfig -> ShowS
Prelude.Show, forall x. Rep AutoMLDataSplitConfig x -> AutoMLDataSplitConfig
forall x. AutoMLDataSplitConfig -> Rep AutoMLDataSplitConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AutoMLDataSplitConfig x -> AutoMLDataSplitConfig
$cfrom :: forall x. AutoMLDataSplitConfig -> Rep AutoMLDataSplitConfig x
Prelude.Generic)

-- |
-- Create a value of 'AutoMLDataSplitConfig' 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:
--
-- 'validationFraction', 'autoMLDataSplitConfig_validationFraction' - The validation fraction (optional) is a float that specifies the portion
-- of the training dataset to be used for validation. The default value is
-- 0.2, and values must be greater than 0 and less than 1. We recommend
-- setting this value to be less than 0.5.
newAutoMLDataSplitConfig ::
  AutoMLDataSplitConfig
newAutoMLDataSplitConfig :: AutoMLDataSplitConfig
newAutoMLDataSplitConfig =
  AutoMLDataSplitConfig'
    { $sel:validationFraction:AutoMLDataSplitConfig' :: Maybe Double
validationFraction =
        forall a. Maybe a
Prelude.Nothing
    }

-- | The validation fraction (optional) is a float that specifies the portion
-- of the training dataset to be used for validation. The default value is
-- 0.2, and values must be greater than 0 and less than 1. We recommend
-- setting this value to be less than 0.5.
autoMLDataSplitConfig_validationFraction :: Lens.Lens' AutoMLDataSplitConfig (Prelude.Maybe Prelude.Double)
autoMLDataSplitConfig_validationFraction :: Lens' AutoMLDataSplitConfig (Maybe Double)
autoMLDataSplitConfig_validationFraction = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AutoMLDataSplitConfig' {Maybe Double
validationFraction :: Maybe Double
$sel:validationFraction:AutoMLDataSplitConfig' :: AutoMLDataSplitConfig -> Maybe Double
validationFraction} -> Maybe Double
validationFraction) (\s :: AutoMLDataSplitConfig
s@AutoMLDataSplitConfig' {} Maybe Double
a -> AutoMLDataSplitConfig
s {$sel:validationFraction:AutoMLDataSplitConfig' :: Maybe Double
validationFraction = Maybe Double
a} :: AutoMLDataSplitConfig)

instance Data.FromJSON AutoMLDataSplitConfig where
  parseJSON :: Value -> Parser AutoMLDataSplitConfig
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AutoMLDataSplitConfig"
      ( \Object
x ->
          Maybe Double -> AutoMLDataSplitConfig
AutoMLDataSplitConfig'
            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
"ValidationFraction")
      )

instance Prelude.Hashable AutoMLDataSplitConfig where
  hashWithSalt :: Int -> AutoMLDataSplitConfig -> Int
hashWithSalt Int
_salt AutoMLDataSplitConfig' {Maybe Double
validationFraction :: Maybe Double
$sel:validationFraction:AutoMLDataSplitConfig' :: AutoMLDataSplitConfig -> Maybe Double
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
validationFraction

instance Prelude.NFData AutoMLDataSplitConfig where
  rnf :: AutoMLDataSplitConfig -> ()
rnf AutoMLDataSplitConfig' {Maybe Double
validationFraction :: Maybe Double
$sel:validationFraction:AutoMLDataSplitConfig' :: AutoMLDataSplitConfig -> Maybe Double
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
validationFraction

instance Data.ToJSON AutoMLDataSplitConfig where
  toJSON :: AutoMLDataSplitConfig -> Value
toJSON AutoMLDataSplitConfig' {Maybe Double
validationFraction :: Maybe Double
$sel:validationFraction:AutoMLDataSplitConfig' :: AutoMLDataSplitConfig -> Maybe Double
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ValidationFraction" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Double
validationFraction
          ]
      )