sdkagent

sagemaker-python-sdk API reference

400 public APIs from sagemaker-python-sdk (aws/sagemaker-python-sdk) — 270 classes, 49 functions, 81 methods. Signatures extracted by static analysis of the actual source.

Repository: aws/sagemaker-python-sdk

KindCount
Classes270
Functions49
Methods81

API list

classsagemaker-core.src.sagemaker.core.apiutils._base_types.ApiObject
A Python class representation of a boto API object.
funcsagemaker-core.src.sagemaker.core.apiutils._utils.default_session()
Create a default session.
classsagemaker-core.src.sagemaker.core.clarify.ImageConfig
Config object for handling images
classsagemaker-core.src.sagemaker.core.clarify.PDPConfig
Config class for Partial Dependence Plots (PDP).
classsagemaker-core.src.sagemaker.core.collection.Collection
Sets up an Amazon SageMaker Collection.
methodsagemaker-core.src.sagemaker.core.collection.Collection.create(collection_name:str, parent_collection_name:str=None)
Creates a Collection.
methodsagemaker-core.src.sagemaker.core.collection.Collection.delete(collections:List[str])
Deletes a list of Collections.
classsagemaker-core.src.sagemaker.core.common_utils.LogState
Placeholder docstring
classsagemaker-core.src.sagemaker.core.common_utils.ModelApprovalStatusEnum
Model package approval status enumerator
funcsagemaker-core.src.sagemaker.core.common_utils.camel_to_snake(camel_case_string:str) -> str
Converts camelCase to snake_case_string using a regex.
funcsagemaker-core.src.sagemaker.core.common_utils.create_paginator_config(max_items:int=None, page_size:int=None) -> Dict[str, int]
Placeholder docstring
funcsagemaker-core.src.sagemaker.core.common_utils.flatten_dict(d:Dict[str, Any], max_flatten_depth=None) -> Dict[str, Any]
Flatten a dictionary object.
funcsagemaker-core.src.sagemaker.core.common_utils.get_config_value(key_path, config)
Placeholder Docstring
funcsagemaker-core.src.sagemaker.core.common_utils.get_domain_for_region(region:str) -> str
Returns the domain for the given region.
funcsagemaker-core.src.sagemaker.core.common_utils.get_instance_type_family(instance_type:str) -> str
Return the family of the instance type.
funcsagemaker-core.src.sagemaker.core.common_utils.get_module(module_name)
Import a module.
funcsagemaker-core.src.sagemaker.core.common_utils.nested_set_dict(d:Dict[str, Any], keys:List[str], value:Any) -> None
Set a value to a sequence of nested keys.
funcsagemaker-core.src.sagemaker.core.common_utils.tag_exists(tag:TagsDict, curr_tags:Optional[Tags]) -> bool
Returns True if ``tag`` already exists.
funcsagemaker-core.src.sagemaker.core.common_utils.unflatten_dict(d:Dict[str, Any]) -> Dict[str, Any]
Unflatten dict-like object.
funcsagemaker-core.src.sagemaker.core.common_utils.unique_name_from_base(base, max_length=63)
Placeholder Docstring
funcsagemaker-core.src.sagemaker.core.config.config.load_local_mode_config() -> dict | None
Loads the local mode config file.
funcsagemaker-core.src.sagemaker.core.config.config.load_sagemaker_config(additional_config_paths:List[str]=None, s3_resource=None, repeat_log=False) -> dict
Loads config files and merges them.
classsagemaker-core.src.sagemaker.core.debugger.debugger.DetailedProfilerProcessingJobConfig
ProfilerRule like class.
classsagemaker-core.src.sagemaker.core.debugger.metrics_config.StepRange
Configuration for the range of steps to profile.
classsagemaker-core.src.sagemaker.core.deprecations.DeprecatedClass
Provides a warning for the class name.
classsagemaker-core.src.sagemaker.core.deserializers.base.TorchTensorDeserializer
Deserialize stream to torch.Tensor.
classsagemaker-core.src.sagemaker.core.enums.EndpointType
Types of endpoint
classsagemaker-core.src.sagemaker.core.enums.RoutingStrategy
Strategy for routing https traffics.
classsagemaker-core.src.sagemaker.core.enums.Tag
Enum class for tag keys to apply to models.
classsagemaker-core.src.sagemaker.core.experiments._api_types.TrialComponentArtifact
Trial component artifact.
classsagemaker-core.src.sagemaker.core.experiments._api_types.TrialComponentMetricSummary
Summary model of a trial component.
classsagemaker-core.src.sagemaker.core.experiments._api_types.TrialComponentStatus
Status of the trial component.
classsagemaker-core.src.sagemaker.core.experiments._api_types.TrialComponentSummary
Summary model of a trial component.
classsagemaker-core.src.sagemaker.core.experiments._api_types.TrialSummary
Summary model of a trial.
methodsagemaker-core.src.sagemaker.core.experiments.run.Run.experiment_config() -> dict
Get experiment config from run attributes.
classsagemaker-core.src.sagemaker.core.explainer.explainer_config.ExplainerConfig
A parameter to activate explainers.
classsagemaker-core.src.sagemaker.core.helper.session_helper.LogState
Placeholder docstring
methodsagemaker-core.src.sagemaker.core.helper.session_helper.Session.account_id() -> str
Get the AWS account id of the caller.
methodsagemaker-core.src.sagemaker.core.helper.session_helper.Session.boto_region_name()
Placeholder docstring
classsagemaker-core.src.sagemaker.core.inputs.ShuffleConfig
For configuring channel shuffling using a seed.
classsagemaker-core.src.sagemaker.core.jumpstart.configs.BaseConfig
BaseConfig
classsagemaker-core.src.sagemaker.core.jumpstart.configs.JumpStartConfig
Configuration Class for JumpStart.
classsagemaker-core.src.sagemaker.core.jumpstart.enums.HubContentCapability
Enum class for HubContent capabilities.
classsagemaker-core.src.sagemaker.core.jumpstart.enums.JumpStartConfigRankingName
Enum class for ranking of JumpStart config.
classsagemaker-core.src.sagemaker.core.jumpstart.enums.JumpStartModelType
Enum class for JumpStart model type.
classsagemaker-core.src.sagemaker.core.jumpstart.enums.JumpStartScriptScope
Enum class for JumpStart script scopes.
classsagemaker-core.src.sagemaker.core.jumpstart.enums.ModelFramework
Enum class for JumpStart model framework.
classsagemaker-core.src.sagemaker.core.jumpstart.enums.NamingConventionType
Enum class for naming conventions.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.And.eval() -> None
Evaluates operator.
classsagemaker-core.src.sagemaker.core.jumpstart.filters.BooleanValues
Enum class for boolean values.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Constant.eval() -> None
Evaluates constant
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Identity.eval() -> None
Evaluates operator.
classsagemaker-core.src.sagemaker.core.jumpstart.filters.ModelFilter
Data holder class to store model filters.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.ModelFilter.set_key(key:str) -> None
Sets the key for the model filter.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.ModelFilter.set_value(value:str) -> None
Sets the value for the model filter.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Not.eval() -> None
Evaluates operator.
classsagemaker-core.src.sagemaker.core.jumpstart.filters.Operand
Operand class for filtering JumpStart content.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Operand.eval() -> None
Evaluates operand.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Operand.resolved_value() -> BooleanValues
Getter method for resolved_value.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Operand.validate_operand(operand:Any) -> Any
Validate operand and return ``Operand`` object.
classsagemaker-core.src.sagemaker.core.jumpstart.filters.Operator
Operator class for filtering JumpStart content.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Operator.eval() -> None
Evaluates operator.
classsagemaker-core.src.sagemaker.core.jumpstart.filters.Or
Or operator class for filtering JumpStart content.
methodsagemaker-core.src.sagemaker.core.jumpstart.filters.Or.eval() -> None
Evaluates operator.
methodsagemaker-core.src.sagemaker.core.jumpstart.hub.hub.Hub.delete() -> None
Deletes this SageMaker Hub.
methodsagemaker-core.src.sagemaker.core.jumpstart.hub.hub.Hub.delete_model_reference(model_name:str) -> None
Deletes model reference from this SageMaker Hub.
methodsagemaker-core.src.sagemaker.core.jumpstart.hub.hub.Hub.describe(hub_name:Optional[str]=None) -> DescribeHubResponse
Returns descriptive information about the Hub
classsagemaker-core.src.sagemaker.core.jumpstart.hub.interfaces.EcrUri
Data class for ECR image uri.
classsagemaker-core.src.sagemaker.core.jumpstart.hub.interfaces.HubDataHolderType
Base class for many Hub API interfaces.
methodsagemaker-core.src.sagemaker.core.jumpstart.hub.interfaces.HubDataHolderType.to_json() -> Dict[str, Any]
Returns json representation of object.
classsagemaker-core.src.sagemaker.core.jumpstart.hub.interfaces.NotebookLocationUris
Data class for Notebook Location uri.
methodsagemaker-core.src.sagemaker.core.jumpstart.hub.interfaces.NotebookLocationUris.from_json(json_obj:str) -> None
Sets fields in object based on json.
classsagemaker-core.src.sagemaker.core.jumpstart.hub.types.S3ObjectLocation
Helper class for S3 object references.
methodsagemaker-core.src.sagemaker.core.jumpstart.hub.types.S3ObjectLocation.get_uri() -> str
Returns the s3 URI
classsagemaker-core.src.sagemaker.core.jumpstart.models.AccelerationConfigModel
AccelerationConfigModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.BenchmarkMetricModel
BenchmarkMetricModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.CapabilityEnum
CapabilityEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.CompressionTypeEnum
CompressionTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.ConfigSchemaModel
ConfigSchemaModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.ContextualHelpModel
ContextualHelpModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.DefaultPayloadsModel
DefaultPayloadsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.DemoNotebookModel
DemoNotebookModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.DependencyModel
DependencyModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.DependencyTypeEnum
DependencyTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.DiyWorkflowOverridesModel
DiyWorkflowOverridesModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingAdditionalDataSourceModel
HostingAdditionalDataSourceModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingArtifactCompressionTypeEnum
HostingArtifactCompressionTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingArtifactS3DataTypeEnum
HostingArtifactS3DataTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingComponentsModel
HostingComponentsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingEcrSpecsModel
HostingEcrSpecsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingInstanceTypeVariantsModel
HostingInstanceTypeVariantsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingResourceRequirementsModel
HostingResourceRequirementsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingVariantModel
HostingVariantModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HostingVariantPropertiesModel
HostingVariantPropertiesModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HubAccessConfigModel
HubAccessConfigModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HubContentDependencyModel
HubContentDependencyModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HyperparameterLowerModel
HyperparameterLowerModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.HyperparameterUpperModel
HyperparameterUpperModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.InferenceAmiVersionEnum
InferenceAmiVersionEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.InferenceEnvironmentVariablesModel
InferenceEnvironmentVariablesModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.ModelTypeEnum
ModelTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.NotebookLocationsModel
NotebookLocationsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.OutputKeysModel
OutputKeysModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.ProviderModel
ProviderModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.RankingSchemaModel
RankingSchemaModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.ResourceModel
ResourceModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.S3DataSourceModel
S3DataSourceModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.S3DataTypeEnum
S3DataTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.ScopeEnum
ScopeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.SpecModel
SpecModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingArtifactCompressionTypeEnum
TrainingArtifactCompressionTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingArtifactS3DataTypeEnum
TrainingArtifactS3DataTypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingComponentsModel
TrainingComponentsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingInstanceTypeVariantsModel
TrainingInstanceTypeVariantsModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingMetricModel
TrainingMetricModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingVariantModel
TrainingVariantModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.TrainingVarientPropertiesModel
TrainingVarientPropertiesModel
classsagemaker-core.src.sagemaker.core.jumpstart.models.TypeEnum
TypeEnum
classsagemaker-core.src.sagemaker.core.jumpstart.models.ValidatorEnum
ValidatorEnum
classsagemaker-core.src.sagemaker.core.jumpstart.types.BaseDeploymentConfigDataHolder
Base class for Deployment Config Data.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.BaseDeploymentConfigDataHolder.to_json() -> Dict[str, Any]
Represents ``This`` object as JSON.
classsagemaker-core.src.sagemaker.core.jumpstart.types.DeploymentArgs
Dataclass representing a Deployment Args.
classsagemaker-core.src.sagemaker.core.jumpstart.types.HubArnExtractedInfo
Data class for info extracted from Hub arn.
classsagemaker-core.src.sagemaker.core.jumpstart.types.HubContentType
Enum for Hub content objects.
classsagemaker-core.src.sagemaker.core.jumpstart.types.HubType
Enum for Hub objects.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartAdditionalDataSources
Data class of additional data sources.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartAdditionalDataSources.from_json(json_obj:Dict[str, Any]) -> None
Sets fields in object based on json.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartBenchmarkStat
Data class JumpStart benchmark stat.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartBenchmarkStat.from_json(json_obj:Dict[str, Any]) -> None
Sets fields in object based on json.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartCachedContentKey
Data class for the cached content keys.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartConfigComponent
Data class of JumpStart config component.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartConfigRanking
Data class JumpStart config ranking.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartConfigRanking.from_json(json_obj:Dict[str, Any]) -> None
Sets fields in object based on json.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartDataHolderType
Base class for many JumpStart types.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartECRSpecs
Data class for JumpStart ECR specs.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartECRSpecs.from_json(json_obj:Dict[str, Any]) -> None
Sets fields in object based on json.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartKwargs
Data class for JumpStart object kwargs.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartLaunchedRegionInfo
Data class for launched region info.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartMetadataConfig
Data class of JumpStart metadata config.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartModelHeader
Data class JumpStart model header.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartModelHeader.from_json(json_obj:Dict[str, str]) -> None
Sets fields in object based on json of header.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartModelSpecs
Data class JumpStart model specs.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartModelSpecs.from_json(json_obj:Dict[str, Any]) -> None
Sets fields in object based on json of header.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartPredictorSpecs
Data class for JumpStart Predictor specs.
methodsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartPredictorSpecs.from_json(json_obj:Optional[Dict[str, Any]]) -> None
Sets fields in object based on json.
classsagemaker-core.src.sagemaker.core.jumpstart.types.JumpStartVersionedModelId
Data class for versioned model IDs.
funcsagemaker-core.src.sagemaker.core.jumpstart.utils.get_formatted_eula_message_template(model_id:str, region:str, hosting_eula_key:str) -> str
Returns a formatted EULA message.
funcsagemaker-core.src.sagemaker.core.jumpstart.utils.get_sagemaker_version() -> str
Returns sagemaker library version.
funcsagemaker-core.src.sagemaker.core.jumpstart.utils.is_pipeline_variable(var:object) -> bool
Check if the variable is a pipeline variable
funcsagemaker-core.src.sagemaker.core.jumpstart.utils.parse_sagemaker_version() -> str
Returns sagemaker library version.
methodsagemaker-core.src.sagemaker.core.lambda_helper.Lambda.update()
Method to update a lambda function.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ActionSource
ActionSource.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ActionSummary
Summary model of an action.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ArtifactSource
ArtifactSource.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ArtifactSourceType
ArtifactSourceType.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ArtifactSummary
Summary model of an Artifact.
classsagemaker-core.src.sagemaker.core.lineage._api_types.AssociationSummary
Summary model of an association.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ContextSource
ContextSource.
classsagemaker-core.src.sagemaker.core.lineage._api_types.ContextSummary
Summary model of an context.
classsagemaker-core.src.sagemaker.core.lineage._api_types.UserContext
Summary model of a user context.
methodsagemaker-core.src.sagemaker.core.lineage.action.Action.delete(disassociate:bool=False)
Delete the action.
methodsagemaker-core.src.sagemaker.core.lineage.action.Action.save() -> 'Action'
Save the state of this Action to SageMaker.
methodsagemaker-core.src.sagemaker.core.lineage.action.Action.set_tag(tag=None)
Add a tag to the object.
methodsagemaker-core.src.sagemaker.core.lineage.action.Action.set_tags(tags=None)
Add tags to the object.
methodsagemaker-core.src.sagemaker.core.lineage.artifact.Artifact.delete(disassociate:bool=False)
Delete the artifact object.
methodsagemaker-core.src.sagemaker.core.lineage.artifact.Artifact.set_tag(tag=None)
Add a tag to the object.
methodsagemaker-core.src.sagemaker.core.lineage.artifact.Artifact.set_tags(tags=None)
Add tags to the object.
methodsagemaker-core.src.sagemaker.core.lineage.context.Context.delete(disassociate:bool=False)
Delete the context object.
methodsagemaker-core.src.sagemaker.core.lineage.context.Context.save() -> 'Context'
Save the state of this Context to SageMaker.
methodsagemaker-core.src.sagemaker.core.lineage.context.Context.set_tag(tag=None)
Add a tag to the object.
methodsagemaker-core.src.sagemaker.core.lineage.context.Context.set_tags(tags=None)
Add tags to the object.
classsagemaker-core.src.sagemaker.core.lineage.query.Edge
A connecting edge for a lineage graph.
classsagemaker-core.src.sagemaker.core.lineage.query.LineageFilter
A filter used in a lineage query.
classsagemaker-core.src.sagemaker.core.lineage.query.LineageQueryDirectionEnum
Enum of query filter directions.
classsagemaker-core.src.sagemaker.core.lineage.query.Vertex
A vertex for a lineage graph.
classsagemaker-core.src.sagemaker.core.local.data.BatchStrategy
Placeholder docstring
classsagemaker-core.src.sagemaker.core.local.data.DataSource
Placeholder docstring
classsagemaker-core.src.sagemaker.core.local.data.LineSplitter
Split records by new line.
classsagemaker-core.src.sagemaker.core.local.data.RecordIOSplitter
Split using Amazon Recordio.
classsagemaker-core.src.sagemaker.core.local.data.Splitter
Placeholder docstring
classsagemaker-core.src.sagemaker.core.local.local_session.LocalSession
A SageMaker ``Session`` class for Local Mode.
methodsagemaker-core.src.sagemaker.core.local.local_session.LocalSession.config(value:Dict | None)
Setter of the local mode config
classsagemaker-core.src.sagemaker.core.modules.configs.BaseConfig
BaseConfig
classsagemaker-core.src.sagemaker.core.modules.configs.Compute
Compute.
classsagemaker-core.src.sagemaker.core.modules.configs.InputData
InputData.
classsagemaker-core.src.sagemaker.core.modules.configs.Networking
Networking.
classsagemaker-core.src.sagemaker.core.modules.configs.SourceCode
SourceCode.
classsagemaker-core.src.sagemaker.core.modules.distributed.MPI
MPI.
methodsagemaker-core.src.sagemaker.core.modules.distributed.MPI.driver_dir() -> str
Directory containing the driver script.
methodsagemaker-core.src.sagemaker.core.modules.distributed.MPI.driver_script() -> str
Name of the driver script.
classsagemaker-core.src.sagemaker.core.modules.distributed.SMP
SMP.
classsagemaker-core.src.sagemaker.core.modules.distributed.Torchrun
Torchrun.
methodsagemaker-core.src.sagemaker.core.modules.distributed.Torchrun.driver_dir() -> str
Directory containing the driver script.
methodsagemaker-core.src.sagemaker.core.modules.distributed.Torchrun.driver_script() -> str
Name of the driver script.
funcsagemaker-core.src.sagemaker.core.modules.train.container_drivers.common.utils.get_python_executable() -> str
Get the python executable path.
funcsagemaker-core.src.sagemaker.core.modules.train.container_drivers.common.utils.safe_deserialize(data:Any) -> Any
Safely deserialize data from a JSON string.
classsagemaker-core.src.sagemaker.core.parameter.ParameterRange
Base class for representing parameter ranges.
methodsagemaker-core.src.sagemaker.core.parameter.ParameterRange.cast_to_type(value)
Placeholder docstring
classsagemaker-core.src.sagemaker.core.partner_app.auth_utils.PartnerAppAuthUtils
Partner App Auth Utils Class
classsagemaker-core.src.sagemaker.core.processing.Processor
Handles Amazon SageMaker Processing tasks.
methodsagemaker-core.src.sagemaker.core.remote_function.client.Future.cancel() -> bool
Cancel the function execution.
methodsagemaker-core.src.sagemaker.core.remote_function.client.Future.result(timeout:float=None) -> Any
Returns the SageMaker job result.
methodsagemaker-core.src.sagemaker.core.remote_function.client.Future.wait(timeout:int=None) -> None
Wait for the underlying SageMaker job to complete.
classsagemaker-core.src.sagemaker.core.remote_function.core.pipeline_variables.Context
Context for an execution.
classsagemaker-core.src.sagemaker.core.remote_function.core.serialization.CloudpickleSerializer
Serializer using cloudpickle.
methodsagemaker-core.src.sagemaker.core.remote_function.core.serialization.CloudpickleSerializer.serialize(obj:Any) -> bytes
Serializes data object and uploads it to S3.
classsagemaker-core.src.sagemaker.core.remote_function.job.LogState
Placeholder docstring
classsagemaker-core.src.sagemaker.core.remote_function.spark_config.SparkConfigUtils
Util class for spark configurations
classsagemaker-core.src.sagemaker.core.serializers.base.JSONSerializer
Serialize data to a JSON formatted string.
classsagemaker-core.src.sagemaker.core.serializers.base.SimpleBaseSerializer
Abstract base class for creation of new serializers.
classsagemaker-core.src.sagemaker.core.serializers.base.StringSerializer
Encode the string to utf-8 bytes.
funcsagemaker-core.src.sagemaker.core.serializers.utils.read_recordio(f)
Placeholder Docstring
classsagemaker-core.src.sagemaker.core.spark.processing.FileType
Enum of file type
classsagemaker-core.src.sagemaker.core.spark.processing.SparkConfigUtils
Util class for spark configurations
classsagemaker-core.src.sagemaker.core.telemetry.attribution.Attribution
Enumeration of known SDK attribution sources.
classsagemaker-core.src.sagemaker.core.telemetry.constants.Feature
Enumeration of feature names used in telemetry.
classsagemaker-core.src.sagemaker.core.telemetry.constants.Region
Telemetry: List of all supported AWS regions.
classsagemaker-core.src.sagemaker.core.telemetry.constants.Status
Enumeration of status values used in telemetry.
classsagemaker-core.src.sagemaker.core.training.configs.BaseConfig
BaseConfig
classsagemaker-core.src.sagemaker.core.training.configs.CheckpointConfig
CheckpointConfig.
classsagemaker-core.src.sagemaker.core.training.configs.Compute
Compute.
classsagemaker-core.src.sagemaker.core.training.configs.HyperPodCompute
HyperPodCompute.
classsagemaker-core.src.sagemaker.core.training.configs.InputData
InputData.
classsagemaker-core.src.sagemaker.core.training.configs.Networking
Networking.
classsagemaker-core.src.sagemaker.core.training.configs.OutputDataConfig
OutputDataConfig.
classsagemaker-core.src.sagemaker.core.training.configs.SourceCode
SourceCode.
classsagemaker-core.src.sagemaker.core.training.configs.TensorBoardOutputConfig
TensorBoardOutputConfig.
classsagemaker-core.src.sagemaker.core.training.constants.TrainingPlatform
Standardized training platform identifiers.
methodsagemaker-core.src.sagemaker.core.transformer.Transformer.wait(logs=True)
Placeholder docstring
classsagemaker-core.src.sagemaker.core.utilities.cache.LRUCache.Element
Class describes the values in the cache.
methodsagemaker-core.src.sagemaker.core.utilities.cache.LRUCache.clear() -> None
Deletes all elements from the cache.
methodsagemaker-core.src.sagemaker.core.utilities.cache.LRUCache.put(key:KeyType, value:Optional[ValType]=None) -> None
Adds key to cache using ``retrieval_function``.
classsagemaker-core.src.sagemaker.core.utilities.search_expression.BooleanOperator
Boolean search operation enum
classsagemaker-core.src.sagemaker.core.utilities.search_expression.Operator
Search operators
classsagemaker-core.src.sagemaker.core.utilities.search_expression.SearchObject
Search Object
classsagemaker-core.src.sagemaker.core.utils.exceptions.FailedStatusError
Raised when a resource enters a failed state.
classsagemaker-core.src.sagemaker.core.utils.exceptions.SageMakerCoreError
Base class for all exceptions in SageMaker Core
classsagemaker-core.src.sagemaker.core.utils.exceptions.TimeoutExceededError
Raised when a specified timeout is exceeded
classsagemaker-core.src.sagemaker.core.utils.exceptions.ValidationError
Raised when a validation error occurs.
classsagemaker-core.src.sagemaker.core.utils.exceptions.WaiterError
Raised when an error occurs while waiting.
funcsagemaker-core.src.sagemaker.core.utils.install_requirements.main()
CLI entry point.
classsagemaker-core.src.sagemaker.core.utils.utils.SageMakerClient
A singleton class for creating a SageMaker client.
classsagemaker-core.src.sagemaker.core.utils.utils.SingletonMeta
Singleton metaclass.
funcsagemaker-core.src.sagemaker.core.utils.utils.get_textual_rich_logger(name:str, log_level:str='INFO') -> logging.Logger
Get a logger with textual rich handler.
classsagemaker-core.src.sagemaker.core.workflow.conditions.Condition
Abstract Condition entity.
classsagemaker-core.src.sagemaker.core.workflow.conditions.ConditionEquals
A condition for equality comparisons.
classsagemaker-core.src.sagemaker.core.workflow.conditions.ConditionGreaterThan
A condition for greater than comparisons.
classsagemaker-core.src.sagemaker.core.workflow.conditions.ConditionIn
A condition to check membership.
classsagemaker-core.src.sagemaker.core.workflow.conditions.ConditionLessThan
A condition for less than comparisons.
classsagemaker-core.src.sagemaker.core.workflow.conditions.ConditionNot
A condition for negating another `Condition`.
classsagemaker-core.src.sagemaker.core.workflow.conditions.ConditionTypeEnum
Condition type enum.
classsagemaker-core.src.sagemaker.core.workflow.entities.Entity
Base object for workflow entities.
classsagemaker-core.src.sagemaker.core.workflow.execution_variables.ExecutionVariable
Pipeline execution variables for workflow.
classsagemaker-core.src.sagemaker.core.workflow.functions.Join
Join together properties.
classsagemaker-core.src.sagemaker.core.workflow.parameters.Parameter
Pipeline parameter for workflow.
classsagemaker-core.src.sagemaker.core.workflow.parameters.ParameterFloat
Float parameter for pipelines.
classsagemaker-core.src.sagemaker.core.workflow.parameters.ParameterInteger
Integer parameter for pipelines.
classsagemaker-core.src.sagemaker.core.workflow.parameters.ParameterString
String parameter for pipelines.
classsagemaker-core.src.sagemaker.core.workflow.parameters.ParameterTypeEnum
Parameter type enum.
classsagemaker-core.src.sagemaker.core.workflow.properties.Properties
Properties for use in workflow expressions.
classsagemaker-core.src.sagemaker.core.workflow.properties.PropertiesList
PropertiesList for use in workflow expressions.
classsagemaker-core.src.sagemaker.core.workflow.properties.PropertiesMap
PropertiesMap for use in workflow expressions.
classsagemaker-core.src.sagemaker.core.workflow.properties.PropertyFile
Provides a property file struct.
methodsagemaker-core.src.sagemaker.core.workflow.properties.PropertyFile.expr() -> Dict[str, str]
The expression dict for a `PropertyFile`.
funcsagemaker-core.src.sagemaker.core.workflow.utilities.hash_file(path:str) -> str
Get the SHA256 hash of a file.
funcsagemaker-core.src.sagemaker.core.workflow.utilities.hash_object(obj) -> str
Get the SHA256 hash of an object.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.dataset_builder.DatasetBuilder
DatasetBuilder definition.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_definition.CollectionTypeEnum
Collection types: List, Set, or Vector.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_definition.ListCollectionType
List collection type.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_definition.SetCollectionType
Set collection type.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_definition.VectorCollectionType
Vector collection type with dimension.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_processor._enums.FeatureProcessorMode
Enum of feature_processor modes.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_processor._udf_arg_provider.SparkArgProvider
Provides arguments to Spark UDFs.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_processor._validation.BaseDataSourceValidator
An Validator for BaseDataSource.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_processor._validation.InputOffsetValidator
An Validator for input offset.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_processor._validation.Validator
Base class for all validators.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_processor._validation.ValidatorChain
Executes a series of validators.
funcsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_utils.get_query_execution(session:Session, query_execution_id:str) -> Dict[str, Any]
Get execution status of an Athena query.
funcsagemaker-mlops.src.sagemaker.mlops.feature_store.feature_utils.upload_dataframe_to_s3(data_frame:DataFrame, output_path:str, session:Session, kms_key:str=None) -> tuple[str, str]
Upload DataFrame to S3 as CSV.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.DeletionModeEnum
Deletion modes for delete_record.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.ExpirationTimeResponseEnum
ExpiresAt response toggle.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.FilterOperatorEnum
Filter operators.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.OnlineStoreStorageTypeEnum
Storage types for online store.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.ResourceEnum
Resource types for search.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.SearchOperatorEnum
Search operators.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.SortOrderEnum
Sort orders.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.TableFormatEnum
Offline store table formats.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.TargetStoreEnum
Store types for put_record.
classsagemaker-mlops.src.sagemaker.mlops.feature_store.inputs.ThroughputModeEnum
Throughput modes for feature group.
classsagemaker-mlops.src.sagemaker.mlops.workflow._steps_compiler.CompiledStep
A compiled step.
classsagemaker-mlops.src.sagemaker.mlops.workflow._steps_compiler.StepsCompiler
Class used to compile steps.
classsagemaker-mlops.src.sagemaker.mlops.workflow.callback_step.CallbackOutput
Output for a callback step.
classsagemaker-mlops.src.sagemaker.mlops.workflow.callback_step.CallbackOutputTypeEnum
CallbackOutput type enum.
classsagemaker-mlops.src.sagemaker.mlops.workflow.callback_step.CallbackStep
Callback step for workflow.
classsagemaker-mlops.src.sagemaker.mlops.workflow.clarify_check_step.ClarifyCheckStep
ClarifyCheckStep step for workflow.
classsagemaker-mlops.src.sagemaker.mlops.workflow.emr_serverless_step.EMRServerlessJobConfig
Config for EMR Serverless job.
classsagemaker-mlops.src.sagemaker.mlops.workflow.emr_step.EMRStep
EMR step for workflow.
classsagemaker-mlops.src.sagemaker.mlops.workflow.emr_step.EMRStepConfig
Config for a Hadoop Jar step.
classsagemaker-mlops.src.sagemaker.mlops.workflow.fail_step.FailStep
`FailStep` for SageMaker Pipelines Workflows.
classsagemaker-mlops.src.sagemaker.mlops.workflow.lambda_step.LambdaOutput
Output for a lambdaback step.
classsagemaker-mlops.src.sagemaker.mlops.workflow.lambda_step.LambdaOutputTypeEnum
LambdaOutput type enum.
classsagemaker-mlops.src.sagemaker.mlops.workflow.lambda_step.LambdaStep
Lambda step for workflow.
classsagemaker-mlops.src.sagemaker.mlops.workflow.model_step.ModelStep
`ModelStep` for SageMaker Pipelines Workflows.
classsagemaker-mlops.src.sagemaker.mlops.workflow.pipeline.Pipeline
Pipeline for workflow.
methodsagemaker-mlops.src.sagemaker.mlops.workflow.pipeline.Pipeline.describe(pipeline_version_id:int=None) -> Dict[str, Any]
Describes a Pipeline in the Workflow service.
methodsagemaker-mlops.src.sagemaker.mlops.workflow.pipeline.Pipeline.list_executions(sort_by:str=None, sort_order:str=None, max_results:int=None, next_token:str=None) -> Dict[str, Any]
Lists a pipeline's executions.
methodsagemaker-mlops.src.sagemaker.mlops.workflow.pipeline.Pipeline.list_pipeline_versions(sort_order:str=None, max_results:int=None, next_token:str=None) -> str
Lists a pipeline's versions.
methodsagemaker-mlops.src.sagemaker.mlops.workflow.pipeline.Pipeline.update(role_arn:str=None, description:str=None, parallelism_config:ParallelismConfiguration=None) -> Dict[str, Any]
Updates a Pipeline in the Workflow service.
classsagemaker-mlops.src.sagemaker.mlops.workflow.pipeline.PipelineExecution
Encapsulates a pipeline execution instance.
classsagemaker-mlops.src.sagemaker.mlops.workflow.quality_check_step.DataQualityCheckConfig
Data Quality Check Config.
classsagemaker-mlops.src.sagemaker.mlops.workflow.quality_check_step.ModelQualityCheckConfig
Model Quality Check Config.
classsagemaker-mlops.src.sagemaker.mlops.workflow.quality_check_step.QualityCheckConfig
Quality Check Config.
classsagemaker-mlops.src.sagemaker.mlops.workflow.quality_check_step.QualityCheckStep
QualityCheck step for workflow.
classsagemaker-mlops.src.sagemaker.mlops.workflow.retry.SageMakerJobExceptionTypeEnum
SageMaker Job ExceptionType enum.
classsagemaker-mlops.src.sagemaker.mlops.workflow.retry.StepExceptionTypeEnum
Step ExceptionType enum.
classsagemaker-mlops.src.sagemaker.mlops.workflow.retry.StepRetryPolicy
RetryPolicy for a retryable step.
classsagemaker-mlops.src.sagemaker.mlops.workflow.step_collections.StepCollection
A wrapper of pipeline steps for workflow.
classsagemaker-mlops.src.sagemaker.mlops.workflow.steps.Step
Pipeline `Step` for SageMaker Pipelines Workflows.
methodsagemaker-mlops.src.sagemaker.mlops.workflow.steps.Step.step_only_arguments() -> RequestType
The arguments to this Step only.
classsagemaker-mlops.src.sagemaker.mlops.workflow.steps.StepTypeEnum
Enum of `Step` types.
classsagemaker-mlops.src.sagemaker.mlops.workflow.steps.TuningStep
`TuningStep` for SageMaker Pipelines Workflows.
methodsagemaker-mlops.src.sagemaker.mlops.workflow.triggers.Trigger.resolve_trigger_name(pipeline_name:str) -> str
Resolve the schedule name given a parent pipeline.
classsagemaker-serve.src.sagemaker.serve.ai_inference_recommender.secrets.Secret
A handle to a Secrets Manager secret.
methodsagemaker-serve.src.sagemaker.serve.ai_inference_recommender.workload.Workload.sonnet(**kwargs:Any) -> 'Workload'
Alias for :meth:`synthetic`.
classsagemaker-serve.src.sagemaker.serve.configs.Compute
Compute configuration for model deployment.
classsagemaker-serve.src.sagemaker.serve.configs.Network
Network configuration for model deployment.
funcsagemaker-serve.src.sagemaker.serve.detector.dependency_manager.capture_dependencies(dependencies:dict, work_dir:Path, capture_all:bool=False)
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickle_dependencies.get_all_files_for_installed_packages(packages:List[str])
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickle_dependencies.get_all_files_for_installed_packages_pip(packages:List[str])
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickle_dependencies.get_all_installed_packages()
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickle_dependencies.get_all_requirements(dest:Path)
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickle_dependencies.get_requirements_for_pkl_file(pkl_path:Path, dest:Path)
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickle_dependencies.map_package_names_to_files(package_names:List[str])
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.detector.pickler.save_sklearn(model_path:str, model:object) -> None
Save sklearn model using joblib serialization.
methodsagemaker-serve.src.sagemaker.serve.local_resources.LocalEndpoint.endpoint_status() -> str
Get endpoint status.
methodsagemaker-serve.src.sagemaker.serve.local_resources.LocalEndpoint.get(endpoint_name:str, local_session=None) -> Optional['LocalEndpoint']
Get existing local endpoint.
methodsagemaker-serve.src.sagemaker.serve.local_resources.LocalEndpoint.refresh() -> 'LocalEndpoint'
Refresh endpoint state.
methodsagemaker-serve.src.sagemaker.serve.local_resources.LocalEndpoint.update(endpoint_config_name:str) -> None
Update endpoint configuration.
classsagemaker-serve.src.sagemaker.serve.mode.function_pointers.Mode
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.djl_serving.server.LocalDJLServing
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.djl_serving.server.SageMakerDjlServing
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.in_process_model_server.in_process_server.InProcessServing
In Process Mode server instance
classsagemaker-serve.src.sagemaker.serve.model_server.multi_model_server.server.LocalMultiModelServer
Local Multi Model server instance
classsagemaker-serve.src.sagemaker.serve.model_server.smd.server.SageMakerSmdServer
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.tei.server.LocalTeiServing
LocalTeiServing class
classsagemaker-serve.src.sagemaker.serve.model_server.tei.server.SageMakerTeiServing
SageMakerTeiServing class
funcsagemaker-serve.src.sagemaker.serve.model_server.tensorflow_serving.prepare.prepare_for_tf_serving(model_path:str, shared_libs:List[str], dependencies:Dict[str, Any]) -> str
Prepares the model for serving.
classsagemaker-serve.src.sagemaker.serve.model_server.tensorflow_serving.server.LocalTensorflowServing
LocalTensorflowServing class.
classsagemaker-serve.src.sagemaker.serve.model_server.tensorflow_serving.server.SageMakerTensorflowServing
SageMakerTensorflowServing class.
classsagemaker-serve.src.sagemaker.serve.model_server.tgi.server.LocalTgiServing
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.tgi.server.SageMakerTgiServing
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.torchserve.server.LocalTorchServe
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.torchserve.server.SageMakerTorchServe
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.triton.model.TritonPythonModel
A class for Triton Python Backend
methodsagemaker-serve.src.sagemaker.serve.model_server.triton.model.TritonPythonModel.initialize(args:dict) -> None
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.triton.server.LocalTritonServer
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.model_server.triton.server.SageMakerTritonServer
Placeholder docstring
classsagemaker-serve.src.sagemaker.serve.serverless.model.LambdaModel
A model that can be deployed to Lambda.
funcsagemaker-serve.src.sagemaker.serve.utils.task.retrieve_local_schemas(task:str) -> Tuple[Any, Any]
Retrieves task sample inputs and outputs locally.
classsagemaker-serve.src.sagemaker.serve.utils.types.HardwareType
An enum for hardware type
classsagemaker-serve.src.sagemaker.serve.utils.types.ImageUriOption
Enum type for image uri options
classsagemaker-serve.src.sagemaker.serve.utils.types.ModelHub
Enum type for model hub source
classsagemaker-serve.src.sagemaker.serve.utils.types.ModelServer
An enum for model server
funcsagemaker-serve.src.sagemaker.serve.utils.uploader.upload(sagemaker_session:Session, model_dir:str, bucket:str, key_prefix:str) -> str
Wrapper function of method upload
funcsagemaker-serve.src.sagemaker.serve.validations.check_image_and_hardware_type.detect_hardware_type_of_instance(instance_type:str) -> HardwareType
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.validations.check_image_and_hardware_type.detect_torchserve_image_hardware_type(image_uri:str) -> HardwareType
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.validations.check_image_and_hardware_type.detect_triton_image_hardware_type(image_uri:str) -> HardwareType
Placeholder docstring
funcsagemaker-serve.src.sagemaker.serve.validations.check_integrity.compute_hash(buffer:bytes) -> str
Compute SHA-256 hash of the given buffer.
classsagemaker-train.src.sagemaker.ai_registry.air_constants.HubContentStatus
HubContent status enum.
classsagemaker-train.src.sagemaker.ai_registry.air_hub_entity.AIRHubEntity
Base entity for AI Registry Hub content.
methodsagemaker-train.src.sagemaker.ai_registry.air_hub_entity.AIRHubEntity.delete(version:Optional[str]=None) -> bool
Delete this entity instance.
methodsagemaker-train.src.sagemaker.ai_registry.air_hub_entity.AIRHubEntity.delete_by_name(name:str, version:Optional[str]=None) -> bool
Delete entity by name and version.
methodsagemaker-train.src.sagemaker.ai_registry.air_hub_entity.AIRHubEntity.get_versions() -> List
List all versions of this entity.
methodsagemaker-train.src.sagemaker.ai_registry.air_hub_entity.AIRHubEntity.list(max_results:Optional[int]=None, next_token:Optional[str]=None) -> List
List all entities of this type.
methodsagemaker-train.src.sagemaker.ai_registry.air_hub_entity.AIRHubEntity.refresh() -> None
Refresh entity status from hub content.
classsagemaker-train.src.sagemaker.ai_registry.dataset.DataSet
Dataset entity for AI Registry.
methodsagemaker-train.src.sagemaker.ai_registry.dataset.DataSet.create_version(source:str, customization_technique:Optional[CustomizationTechnique]=None) -> bool
Create a new version of this dataset.
methodsagemaker-train.src.sagemaker.ai_registry.dataset.DataSet.get(name:str, sagemaker_session=None) -> 'DataSet'
Get dataset by name.
methodsagemaker-train.src.sagemaker.ai_registry.dataset.DataSet.get_versions() -> List['DataSet']
List all versions of this dataset.
methodsagemaker-train.src.sagemaker.ai_registry.dataset.DataSet.split(source:str, train_split_ratio:float=0.8) -> Tuple['DataSet', 'DataSet']
Split dataset into train and validation sets.
classsagemaker-train.src.sagemaker.ai_registry.dataset_utils.CustomizationTechnique
Customization technique for dataset.
classsagemaker-train.src.sagemaker.ai_registry.dataset_utils.DataSetHubContentDocument
Hub content document for dataset.
methodsagemaker-train.src.sagemaker.ai_registry.dataset_utils.DataSetHubContentDocument.to_json() -> str
Convert to JSON string.
classsagemaker-train.src.sagemaker.ai_registry.dataset_utils.DataSetMethod
Enum for DataSet method types.
funcsagemaker-train.src.sagemaker.ai_registry.dataset_validation.detect_dataset_type(record:Dict[str, Any]) -> Optional[str]
Auto-detect dataset type from record format.
funcsagemaker-train.src.sagemaker.ai_registry.dataset_validation.load_jsonl(path:str) -> List[Dict[str, Any]]
Load JSONL file and return list of dictionaries.
funcsagemaker-train.src.sagemaker.ai_registry.dataset_validation.normalize_rlvr_row(record:Dict[str, Any]) -> Dict[str, Any]
Converts a row into the standard RLVR format.
funcsagemaker-train.src.sagemaker.ai_registry.dataset_validation.validate_dpo(rows:Iterable[Dict[str, Any]]) -> None
Validate DPO dataset format.
funcsagemaker-train.src.sagemaker.ai_registry.dataset_validation.validate_rlvr(rows:Iterable[Dict[str, Any]]) -> None
Validate RLVR dataset format.
funcsagemaker-train.src.sagemaker.ai_registry.dataset_validation.validate_sft(rows:Iterable[Dict[str, Any]]) -> None
Validate SFT dataset format.
classsagemaker-train.src.sagemaker.ai_registry.evaluator.Evaluator
Evaluator entity for AI Registry.
methodsagemaker-train.src.sagemaker.ai_registry.evaluator.Evaluator.create_version(source:str) -> bool
Create a new version of this evaluator.
methodsagemaker-train.src.sagemaker.ai_registry.evaluator.Evaluator.get(name:str, sagemaker_session=None) -> 'Evaluator'
Get evaluator by name.
methodsagemaker-train.src.sagemaker.ai_registry.evaluator.Evaluator.get_versions() -> List['Evaluator']
List all versions of this evaluator.
classsagemaker-train.src.sagemaker.ai_registry.evaluator.EvaluatorMethod
Enum for Evaluator method types.
funcsagemaker-train.src.sagemaker.ai_registry.utils.base32_encode(data:bytes, padding:bool=True) -> str
Encode bytes using RFC4648 base32 hex alphabet.
classsagemaker-train.src.sagemaker.train.aws_batch.exception.MissingRequiredArgument
Define MissingRequiredArgument exception.
classsagemaker-train.src.sagemaker.train.aws_batch.exception.NoTrainingJob
Define NoTrainingJob Exception.
classsagemaker-train.src.sagemaker.train.common.CustomizationTechnique
Customization techniques for fine-tuning.
classsagemaker-train.src.sagemaker.train.common.TrainingType
Training types for fine-tuning.

About this data

These signatures were extracted from the public source of aws/sagemaker-python-sdk using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries