Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.ProfilerConfig

Description

Documentation

data ProfilerConfig Source #

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

See: newProfilerConfig smart constructor.

Constructors

ProfilerConfig'

Fields

disableProfiler :: Maybe Bool
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
profilingIntervalInMilliseconds :: Maybe Integer
A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
profilingParameters :: Maybe (HashMap Text Text)
Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
s3OutputPath :: Maybe Text
Path to Amazon S3 storage location for system and framework metrics.

Instances

Instances details

FromJSON ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods parseJSON :: Value -> Parser ProfilerConfig # parseJSONList :: Value -> Parser [ProfilerConfig] #
ToJSON ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods toJSON :: ProfilerConfig -> Value # toEncoding :: ProfilerConfig -> Encoding # toJSONList :: [ProfilerConfig] -> Value # toEncodingList :: [ProfilerConfig] -> Encoding #
Generic ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Associated Types type Rep ProfilerConfig :: Type -> Type # Methods from :: ProfilerConfig -> Rep ProfilerConfig x # to :: Rep ProfilerConfig x -> ProfilerConfig #
Read ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods readsPrec :: Int -> ReadS ProfilerConfig # readList :: ReadS [ProfilerConfig] # readPrec :: ReadPrec ProfilerConfig # readListPrec :: ReadPrec [ProfilerConfig] #
Show ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods showsPrec :: Int -> ProfilerConfig -> ShowS # show :: ProfilerConfig -> String # showList :: [ProfilerConfig] -> ShowS #
NFData ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods rnf :: ProfilerConfig -> () #
Eq ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods (==) :: ProfilerConfig -> ProfilerConfig -> Bool # (/=) :: ProfilerConfig -> ProfilerConfig -> Bool #
Hashable ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig Methods hashWithSalt :: Int -> ProfilerConfig -> Int # hash :: ProfilerConfig -> Int #
type Rep ProfilerConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.ProfilerConfig type Rep ProfilerConfig = D1 ('MetaData "ProfilerConfig" "Amazonka.SageMaker.Types.ProfilerConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ProfilerConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disableProfiler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "profilingIntervalInMilliseconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "profilingParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "s3OutputPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newProfilerConfig :: ProfilerConfig Source #

Create a value of ProfilerConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:disableProfiler:ProfilerConfig', profilerConfig_disableProfiler - Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

$sel:profilingIntervalInMilliseconds:ProfilerConfig', profilerConfig_profilingIntervalInMilliseconds - A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

$sel:profilingParameters:ProfilerConfig', profilerConfig_profilingParameters - Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

$sel:s3OutputPath:ProfilerConfig', profilerConfig_s3OutputPath - Path to Amazon S3 storage location for system and framework metrics.

profilerConfig_disableProfiler :: Lens' ProfilerConfig (Maybe Bool) Source #

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

profilerConfig_profilingIntervalInMilliseconds :: Lens' ProfilerConfig (Maybe Integer) Source #

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

profilerConfig_profilingParameters :: Lens' ProfilerConfig (Maybe (HashMap Text Text)) Source #

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

profilerConfig_s3OutputPath :: Lens' ProfilerConfig (Maybe Text) Source #

Path to Amazon S3 storage location for system and framework metrics.