« blib/lib/Paws/SageMaker/DatasetDefinition.pm
↑ Summary
blib/lib/Paws/SageMaker/DebugRuleConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::DebugHookConfig; | ||
| 3 | use Moose; | ||
| 4 | has CollectionConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::CollectionConfiguration]'); | ||
| 5 | has HookParameters => (is => 'ro', isa => 'Paws::SageMaker::HookParameters'); | ||
| 6 | has LocalPath => (is => 'ro', isa => 'Str'); | ||
| 7 | has S3OutputPath => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::SageMaker::DebugHookConfig | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::SageMaker::DebugHookConfig object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { CollectionConfigurations => $value, ..., S3OutputPath => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::DebugHookConfig object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->CollectionConfigurations | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Configuration information for the Debugger hook parameters, metric and | ||
| 40 | tensor collections, and storage paths. To learn more about how to | ||
| 41 | configure the C<DebugHookConfig> parameter, see Use the SageMaker and | ||
| 42 | Debugger Configuration API Operations to Create, Update, and Debug Your | ||
| 43 | Training Job | ||
| 44 | (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 CollectionConfigurations => ArrayRef[L<Paws::SageMaker::CollectionConfiguration>] | ||
| 50 | |||
| 51 | Configuration information for Debugger tensor collections. To learn | ||
| 52 | more about how to configure the C<CollectionConfiguration> parameter, | ||
| 53 | see Use the SageMaker and Debugger Configuration API Operations to | ||
| 54 | Create, Update, and Debug Your Training Job | ||
| 55 | (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). | ||
| 56 | |||
| 57 | |||
| 58 | =head2 HookParameters => L<Paws::SageMaker::HookParameters> | ||
| 59 | |||
| 60 | Configuration information for the Debugger hook parameters. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 LocalPath => Str | ||
| 64 | |||
| 65 | Path to local storage location for metrics and tensors. Defaults to | ||
| 66 | C</opt/ml/output/tensors/>. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> S3OutputPath => Str | ||
| 70 | |||
| 71 | Path to Amazon S3 storage location for metrics and tensors. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |