Skip to content

Commit 38549f7

Browse files
Merge branch 'master' into lzao/debugger-rule-removal
2 parents 864d4c9 + e749dbe commit 38549f7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+7154
-118
lines changed

doc/amazon_sagemaker_model_building_pipeline.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,52 @@ Example:
362362
prefix=model_prefix
363363
)
364364
365+
AutoMLStep
366+
`````````````
367+
Referable Property List:
368+
369+
- `DescribeAutoMLJob`_
370+
- `BestCandidateProperties.ModelInsightsJsonReportPath`_
371+
- `BestCandidateProperties.ExplainabilityJsonReportPath`_
372+
373+
.. _DescribeAutoMLJob: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob
374+
.. _BestCandidateProperties.ModelInsightsJsonReportPath: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CandidateArtifactLocations.html#sagemaker-Type-CandidateArtifactLocations-ModelInsights
375+
.. _BestCandidateProperties.ExplainabilityJsonReportPath: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CandidateArtifactLocations.html#sagemaker-Type-CandidateArtifactLocations-Explainability
376+
377+
Example:
378+
379+
.. code-block:: python
380+
381+
step_automl = AutoMLStep(...)
382+
383+
auto_ml_model = step_automl.get_best_model(<role>)
384+
385+
model_metrics = ModelMetrics(
386+
model_statistics=MetricsSource(
387+
s3_uri=auto_ml_step.properties.BestCandidateProperties.ModelInsightsJsonReportPath,
388+
content_type="application/json",
389+
),
390+
explainability=MetricsSource(
391+
s3_uri=auto_ml_step.properties.BestCandidateProperties.ExplainabilityJsonReportPath,
392+
content_type="application/json",
393+
)
394+
)
395+
396+
step_args_register_model = auto_ml_model.register(
397+
content_types=["text/csv"],
398+
response_types=["text/csv"],
399+
inference_instances=["ml.t2.medium", "ml.m5.large"],
400+
transform_instances=["ml.m5.large"],
401+
model_package_group_name="My model package group name",
402+
approval_status="PendingManualApproval",
403+
model_metrics=model_metrics,
404+
)
405+
406+
step_register_model = ModelStep(
407+
name="auto-ml-model-register",
408+
step_args=step_args_register_model,
409+
)
410+
365411
CreateModelStep
366412
````````````````
367413
Referable Property List:

doc/api/governance/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
###############
2+
Governance APIs
3+
###############
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
:glob:
8+
9+
*

doc/api/governance/model_card.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Amazon SageMaker Model Cards
2+
----------------------------
3+
4+
For more information about using model cards with the SageMaker Python SDK,
5+
see `Amazon SageMaker Model Cards <https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html>`__ in the *Amazon SageMaker Developer Guide*.
6+
7+
.. currentmodule:: sagemaker.model_card
8+
9+
.. autoclass:: AdditionalInformation
10+
:show-inheritance:
11+
12+
.. autoclass:: Environment
13+
:show-inheritance:
14+
15+
.. autoclass:: EvaluationJob
16+
:show-inheritance:
17+
18+
.. autoclass:: Function
19+
:show-inheritance:
20+
21+
.. autoclass:: IntendedUses
22+
:show-inheritance:
23+
24+
.. autoclass:: Metric
25+
:show-inheritance:
26+
27+
.. autoclass:: MetricGroup
28+
:show-inheritance:
29+
30+
.. autoclass:: ModelCard
31+
:show-inheritance:
32+
33+
.. autoclass:: ModelOverview
34+
:show-inheritance:
35+
36+
.. autoclass:: ObjectiveFunction
37+
:show-inheritance:
38+
39+
.. autoclass:: TrainingDetails
40+
:show-inheritance:
41+
42+
.. autoclass:: TrainingJobDetails
43+
:show-inheritance:

doc/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ The SageMaker Python SDK consists of a variety classes for preparing data, train
1111
training/index
1212
training/distributed
1313
inference/index
14+
governance/index
1415
utility/index

doc/workflows/pipelines/sagemaker.workflow.pipelines.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,5 @@ Steps
168168
.. autoclass:: sagemaker.workflow.clarify_check_step.ClarifyCheckStep
169169

170170
.. autoclass:: sagemaker.workflow.fail_step.FailStep
171+
172+
.. autoclass:: sagemaker.workflow.automl_step.AutoMLStep

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def read_requirements(filename):
4848
# Declare minimal set for installation
4949
required_packages = [
5050
"attrs>=20.3.0,<23",
51-
"boto3>=1.20.21,<2.0",
51+
"boto3>=1.26.20,<2.0",
5252
"google-pasta",
5353
"numpy>=1.9.0,<2.0",
5454
"protobuf>=3.1,<4.0",

0 commit comments

Comments
 (0)