Man pages for DyfanJones/sagemaker-r-local
Sagemaker core classes, methods and functions

add_jumpstart_tagsAdd custom tags to JumpStart models, return the updated tags.
add_single_jumpstart_tagAdds "tag_key" to "curr_tags" if "uri" corresponds to a...
AndAnd operator class for filtering JumpStart content.
ApiObjectA Python class representation of a boto API object.
base_from_nameExtract the base name of the resource name (for use with...
base_name_from_imageExtract the base name of the image to use as the 'algorithm...
BatchStrategyBatchStrategy class
BooleanValuesEnum class for boolean values.
build_dictReturn a dict of key and value pair if value is not None,...
cls_helpHelper function to return help documentation for sagemaker R6...
common_variablesCore variables
CompilationInputCompilationInput
ConstantConstant operator class for filtering JumpStart content.
container_defCreate a definition for executing a container as part of a...
copy_directory_structureCreates intermediate directory structure for relative_path.
CreateModelInputCreateModelInput
create_tar_fileCreate a tar file containing all the source_files
DataSourceDataSource class
deprecated_functionWrap a function with a deprecation warning.
DeprecatedJumpStartModelErrorException raised when trying to access a JumpStart model...
dot-append_project_tagsAppends the project tag to the list of tags, if it exists.
dot-aws_partitionGiven a region name (ex: "cn-north-1"), return the...
dot-download_files_under_prefixDownload all S3 files which match the given prefix
dot-generate_jumpstart_model_versionsGenerate models for JumpStart, and optionally apply filters...
dot-JumpStartModelsAccessorJumpStartModelsAccessor class
dot-pull_imageInvokes the docker pull command for the given image.
dot-region_supports_debuggerReturns boolean indicating whether the region supports Amazon...
dot-region_supports_profilerReturns bool indicating whether region supports Amazon...
dot-SageMakerContainerHandle the lifecycle and configuration of a local container...
dot-SageMakerSettingsSageMakerSettings class
dot-validate_payload_sizeCheck if a payload is within the size in MB threshold.
dot-validate_smdataparallel_argsCheck if request is using unsupported arguments.
download_fileDownload a Single File from S3 into a local path
download_file_from_urlDownload a Single File from S3 into a local path
download_folderDownload a folder from S3 to a local path
ElementClass describes the values in the cache.
EnumCreate Enum "like" environments
evaluate_filter_expressionEvaluates model filter with cached model spec value, returns...
extract_framework_task_modelParse the model ID, return a tuple framework, task,...
file_inputAmazon SageMaker channel configuration for FILE data sources,...
FileSystemInputAmazon SageMaker channel configurations for file system data...
FilterOperatorsEnum class for filter operators for JumpStart models.
format_classFormat of R6 classes
framework_name_from_imageExtract the framework and Python version from the image name.
framework_version_from_tagExtract the framework version from the image tag.
get_batch_strategy_instanceReturn an Instance of...
get_config_valuePlaceholder
get_data_source_instanceReturn an Instance of...
get_execution_roleReturn the role ARN whose credentials are used to call the...
get_formatted_manifestReturns formatted manifest dictionary from raw manifest.
get_jumpstart_base_name_if_jumpstart_modelReturn default JumpStart base name if a URI belongs to...
get_jumpstart_content_bucketReturns regionalized content bucket name for JumpStart.
get_jumpstart_launched_regions_messageReturns formatted string indicating where JumpStart is...
get_model_package_argsGet arguments for create_model_package method.
get_model_urlRetrieve web url describing pretrained model.
get_mp_parametersGet the model parallelism parameters provided by the user.
get_sagemaker_versionReturns sagemaker library version.
get_short_versionReturn short version in the format of x.x
get_splitter_instanceReturn an Instance of :class:'sagemaker.local.data.Splitter'.
get_tag_valueReturn the value of a tag whose key matches the given...
git_clone_repoClone Sagemaker repositories by calling git
HyperparameterValidationModePossible modes for validating hyperparameters.
IdentityIdentity operator class for filtering JumpStart content.
ImageUrisImageUris Class
initProtoBufInitialise ProtoBuf
is_jumpstart_model_inputDetermines if 'model_id' and 'version' input are for...
is_jumpstart_model_uriReturns True if URI corresponds to a JumpStart-hosted model.
islistemptyCheck if list is empty
is_list_namedCheck if list is named
is.s3_urivalidation check of s3 uri
IsSubR6ClassChecks is R6 is a sub class
is_tarfileCheck if file is tar archived or not.
JumpStartCachedS3ContentKeyJumpStartCachedS3ContentKey class
JumpStartCachedS3ContentValueJumpStartCachedS3ContentValue class
JumpStartDataHolderTypeBase class for many JumpStart types.
JumpStartECRSpecsData class for JumpStart ECR specs.
JumpStartEnvironmentVariableJumpStartEnvironmentVariable class
JumpStartHyperparameterJumpStartHyperparameter class
JumpStartHyperparametersErrorException raised for bad hyperparameters of a JumpStart...
JumpStartLaunchedRegionInfoData class for launched region info.
JumpStartModelHeaderData class JumpStart model header.
JumpStartModelsCacheClass that implements a cache for JumpStart models manifests...
JumpStartModelSpecsJumpStartModelSpecs class
JumpStartS3FileTypeType of files published in JumpStart S3 distribution buckets.
JumpStartScriptScopeEnum class for JumpStart script scopes.
JumpStartTagEnum class for tag keys to apply to JumpStart models.
JumpStartVersionedModelIdJumpStartVersionedModelId class
LineSplitterSplit records by new line.
list_jumpstart_frameworksList frameworks for JumpStart, and optionally apply filters...
list_jumpstart_scriptsList scripts for JumpStart, and optionally apply filters to...
list_jumpstart_tasksList tasks for JumpStart, and optionally apply filters to...
LocalFileDataSourceLocalFileDataSource class
LocalSagemakerClientA SageMakerClient that implements the API calls locally.
LocalSagemakerRuntimeClientA SageMaker Runtime client that calls a local endpoint only.
LocalSessionA SageMaker "Session" class for Local Mode.
log_streamFormat logging streams from aws cloud watch
LRUCacheClass that implements LRU cache with expiring items.
model_code_key_prefixReturns the s3 key prefix for uploading code during model...
ModelFilterData holder class to store model filters.
ModelFrameworkEnum class for JumpStart model framework.
move_to_destinationMove source to destination.
MultiRecordStrategyFeed multiple records at a time for batch inference.
name_from_baseAppend a timestamp to the provided string.
name_from_imageCreate a training job name based on the image name and a...
NoneSplitterNoneSplitter class
NotNot operator class for filtering JumpStart content.
OperandOperand class for filtering JumpStart content.
OperatorOperator class for filtering JumpStart content.
OrOr operator class for filtering JumpStart content.
parse_filter_stringParse filter string and return a serialized "ModelFilter"...
parse_s3split s3 uri
parse_sagemaker_versionReturns sagemaker library version. This should only be called...
PawsFunctionsPawsFunctions class
PawsSessionPawsSession Class create connection to AWS utilizing paws.
pipeline_container_defCreate a definition for executing a pipeline of containers as...
pkg_methodGet methods from other packages
production_variantCreate a production variant description suitable for use in a...
python_deprecation_warningRaise warning for deprecated python versions
read_records_ioread_records_io
RecordRecord class
RecordIOSplitterSplit using Amazon Recordio.
recursive_copyA wrapper around distutils.dir_util.copy_tree.
regional_hostnameGet the AWS endpoint specific for the given region.
remove_argChecks if the deprecated argument is populated.
removed_kwargsChecks if the deprecated argument is in kwargs
removed_warningRaise a warning for a no-op in sagemaker>=2
renamed_kwargsChecks if the deprecated argument is in kwargs
renamed_warningRaise a warning for a rename in sagemaker>=2
repack_modelUnpack model tarball and creates a new model tarball with the...
retriesRetries until max retry count is reached.
retry_api_callIf api call fails retry call
rsplitSplit string from the right
S3DataSourceDefines a data source given by a bucket and S3 prefix.
S3DownloaderS3Downloader
s3_path_joinCreates S3 uri paths
S3UploaderS3Uploader Class
sagemaker.core-packager6 sagemaker: this is just a placeholder
SagemakerErrorSagemakerError
sagemaker_log_layoutSet format for SageMaker
sagemaker_short_timestampReturn a timestamp that is relatively short in length
sagemaker_timestampReturn a timestamp with millisecond precision.
secondary_training_status_changedReturns true if training job's secondary status message has...
secondary_training_status_messageReturns a string contains last modified time and the...
SessionSagemaker Session Class
ShuffleConfigShuffleConfig Class
SingleRecordStrategyFeed a single record at a time for batch inference.
SpecialSupportedFilterKeysEnum class for special supported filter keys.
split_strsplit string
SplitterSplitter class
sts_regional_endpointGet the AWS STS endpoint specific for the given region.
tag_key_in_arrayReturns True if "tag_key" is in the "tag_array".
tar_and_upload_dirPackage source files and uploads a compress tar file to S3.
TrainingInputCreate a definition for input data used by an SageMaker...
TransformInputTransformInput
unique_name_from_baseCreate a unique name from base str
update_inference_tags_with_jumpstart_training_tagsUpdates the tags for the "sagemaker.model.Model.deploy"...
UploadedCodesagemaker.fw_utils.UserCode: An object containing the S3...
validate_hyperparametersValidate hyperparameters for JumpStart models.
validate_mp_configValidate the configuration dictionary for model parallelism.
validate_smdistributedCheck if smdistributed strategy is correctly invoked by the...
validate_source_dirValidate that the source directory exists and it contains the...
validate_version_or_image_argsChecks if version or image arguments are specified.
VariableScopePossible value of the "scope" attribute for a hyperparameter...
VariableTypesPossible types for hyperparameters and environment variables.
verify_model_region_and_return_specsVerifies that an acceptable model_id, version, scope, and...
vpc_configuration_envVpc Configuration environment list
vpc_from_listExtracts subnets and security group ids as lists from a...
vpc_sanitizeChecks VpcConfig
vpc_to_listConvert subnet and security groups in to vpc list
VulnerableJumpStartModelErrorException raised when trying to access a JumpStart model...
warn_if_parameter_server_with_multi_gpuWarn the user that training will not fully leverage all the...
write_binWrite large raw connections in chunks
write_matrix_to_dense_tensorwrite_matrix_to_dense_tensor
write_spmatrix_to_sparse_tensorwrite_spmatrix_to_sparse_tensor
DyfanJones/sagemaker-r-local documentation built on June 14, 2022, 10:32 p.m.