feature: Add business details and hyper parameters fields and update test_model_card.py #3639

Andywangnn · 2023-02-07T00:20:16Z

Issue #, if available:

Description of changes:
feature: add business details and hyper parameters fields to python SDK.

Testing done:
Passed unit test for test_model_card.py by running export IGNORE_COVERAGE=- ; tox -- -s -vv tests/unit/test_model_card.py ; unset IGNORE_COVERAGE

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

I have read the CONTRIBUTING doc
I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the Python SDK team
I used the commit message format described in CONTRIBUTING
I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

I have added tests that prove my fix is effective or that my feature works (if appropriate)
I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
I have checked that my tests are not configured for a specific region or account (if appropriate)
I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

src/sagemaker/model_card/model_card.py

Zhenshan-Jin · 2023-02-07T00:49:34Z

tests/unit/test_model_card.py

@@ -866,6 +891,14 @@ def __init__(self, attr1):  # pylint: disable=C0116
    ):
        ExampleClass(attr1=IntendedUses())

+    with pytest.raises(


I don't think we need this lines. The goal of this test is to see if _IsModelCardObject descriptor working as expected and not specific to IntendedUses class

I don't think we need this lines. The goal of this test is to see if _IsModelCardObject descriptor working as expected and not specific to IntendedUses class

make sense, will remove those lines for business details

Zhenshan-Jin · 2023-02-07T00:53:36Z

tests/unit/test_model_card.py

@@ -1047,6 +1080,7 @@ def test_training_details_autodiscovery_from_model_overview_autopilot(
    )

    assert len(training_details.training_job_details.training_metrics) == 0
+    assert len(training_details.training_job_details.hyper_parameters) == 0


You will need to check if hyper parameter is part of return of sagemaker_client.search API. and update SEARCH_TRAINING_JOB_EXAMPLE and SEARCH_TRAINING_JOB_AUTOPILOT_EXAMPLE accordingly

please comment your fix if any

tests/unit/test_model_card.py

Zhenshan-Jin · 2023-02-08T20:31:20Z

Where is the code to parse the hyper_parameters?

tests/unit/test_model_card.py

src/sagemaker/model_card/model_card.py

tests/unit/test_model_card.py

…test_model_card.py

vikas0203

/bot run all

sagemaker-bot · 2023-02-09T19:15:34Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: 2f8bf92
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

codecov-commenter · 2023-02-09T19:17:30Z

Codecov Report

Merging #3639 (2f8bf92) into master (8d2c16b) will decrease coverage by 0.79%.
The diff coverage is 95.23%.

@@            Coverage Diff             @@
##           master    #3639      +/-   ##
==========================================
- Coverage   89.59%   88.80%   -0.79%     
==========================================
  Files         968      227     -741     
  Lines       90084    22299   -67785     
==========================================
- Hits        80707    19803   -60904     
+ Misses       9377     2496    -6881

Impacted Files	Coverage Δ
src/sagemaker/model_card/__init__.py	`100.00% <ø> (ø)`
src/sagemaker/model_card/model_card.py	`93.12% <94.73%> (ø)`
src/sagemaker/model_card/schema_constraints.py	`100.00% <100.00%> (ø)`
...y37/lib/python3.7/site-packages/sagemaker/tuner.py
...hon3.7/site-packages/sagemaker/sklearn/__init__.py
.../sagemaker/cli/compatibility/v2/modifiers/serde.py
...9/site-packages/sagemaker/model_card/model_card.py
...n3.8/site-packages/sagemaker/pytorch/processing.py
...hon3.10/site-packages/sagemaker/jumpstart/enums.py
...-packages/sagemaker/experiments/trial_component.py
... and 1188 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

sagemaker-bot · 2023-02-09T19:19:01Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: 2f8bf92
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2023-02-09T19:22:39Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-slow-tests
Commit ID: 2f8bf92
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2023-02-09T19:41:25Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 2f8bf92
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2023-02-10T00:11:36Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: 2f8bf92
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

vikas0203

/bot run pr

sagemaker-bot · 2023-02-10T04:28:33Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: 2f8bf92
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

…test_model_card.py (aws#3639) Co-authored-by: Haonian Wang <[email protected]>

Andywangnn requested a review from a team as a code owner February 7, 2023 00:20

Andywangnn requested review from vikas0203 and removed request for a team February 7, 2023 00:20

Zhenshan-Jin self-requested a review February 7, 2023 00:42

Zhenshan-Jin reviewed Feb 7, 2023

View reviewed changes

Andywangnn force-pushed the mainline branch from 7d3b2b5 to 0e4f21d Compare February 8, 2023 18:57

Andywangnn changed the title ~~Add business details and hyper parameters fields and update test_model_card.py~~ feature: Add business details and hyper parameters fields and update test_model_card.py Feb 8, 2023

Andywangnn force-pushed the mainline branch 2 times, most recently from a28fb14 to 96dd74e Compare February 8, 2023 19:52

Zhenshan-Jin reviewed Feb 8, 2023

View reviewed changes

tests/unit/test_model_card.py Outdated Show resolved Hide resolved

Zhenshan-Jin reviewed Feb 8, 2023

View reviewed changes

tests/unit/test_model_card.py Outdated Show resolved Hide resolved

Andywangnn force-pushed the mainline branch from 870d8b1 to 38862db Compare February 8, 2023 23:55

Zhenshan-Jin reviewed Feb 9, 2023

View reviewed changes

src/sagemaker/model_card/model_card.py Outdated Show resolved Hide resolved

tests/unit/test_model_card.py Outdated Show resolved Hide resolved

tests/unit/test_model_card.py Outdated Show resolved Hide resolved

feature: Add business details and hyper parameters fields and update …

2f8bf92

…test_model_card.py

Andywangnn force-pushed the mainline branch from 9e79a4d to 2f8bf92 Compare February 9, 2023 00:35

Zhenshan-Jin approved these changes Feb 9, 2023

View reviewed changes

knikure assigned vikas0203 Feb 9, 2023

vikas0203 reviewed Feb 9, 2023

View reviewed changes

vikas0203 reviewed Feb 10, 2023

View reviewed changes

vikas0203 approved these changes Feb 10, 2023

View reviewed changes

vikas0203 merged commit 2bcd643 into aws:master Feb 10, 2023

JoseJuan98 pushed a commit to JoseJuan98/sagemaker-python-sdk that referenced this pull request Mar 4, 2023

feature: Add business details and hyper parameters fields and update …

b6a9f0e

…test_model_card.py (aws#3639) Co-authored-by: Haonian Wang <[email protected]>

nmadan pushed a commit to nmadan/sagemaker-python-sdk that referenced this pull request Apr 18, 2023

feature: Add business details and hyper parameters fields and update …

5cba9a6

…test_model_card.py (aws#3639) Co-authored-by: Haonian Wang <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Add business details and hyper parameters fields and update test_model_card.py #3639

feature: Add business details and hyper parameters fields and update test_model_card.py #3639

Andywangnn commented Feb 7, 2023

Zhenshan-Jin Feb 7, 2023

Andywangnn Feb 7, 2023

Zhenshan-Jin Feb 7, 2023

Zhenshan-Jin Feb 8, 2023

Zhenshan-Jin commented Feb 8, 2023

vikas0203 left a comment

sagemaker-bot commented Feb 9, 2023

codecov-commenter commented Feb 9, 2023 •

edited

Loading

sagemaker-bot commented Feb 9, 2023

sagemaker-bot commented Feb 9, 2023

sagemaker-bot commented Feb 9, 2023

sagemaker-bot commented Feb 10, 2023

vikas0203 left a comment

sagemaker-bot commented Feb 10, 2023

feature: Add business details and hyper parameters fields and update test_model_card.py #3639

feature: Add business details and hyper parameters fields and update test_model_card.py #3639

Conversation

Andywangnn commented Feb 7, 2023

Merge Checklist

General

Tests

Zhenshan-Jin Feb 7, 2023

Choose a reason for hiding this comment

Andywangnn Feb 7, 2023

Choose a reason for hiding this comment

Zhenshan-Jin Feb 7, 2023

Choose a reason for hiding this comment

Zhenshan-Jin Feb 8, 2023

Choose a reason for hiding this comment

Zhenshan-Jin commented Feb 8, 2023

vikas0203 left a comment

Choose a reason for hiding this comment

sagemaker-bot commented Feb 9, 2023

AWS CodeBuild CI Report

codecov-commenter commented Feb 9, 2023 • edited Loading

Codecov Report

sagemaker-bot commented Feb 9, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Feb 9, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Feb 9, 2023

AWS CodeBuild CI Report

sagemaker-bot commented Feb 10, 2023

AWS CodeBuild CI Report

vikas0203 left a comment

Choose a reason for hiding this comment

sagemaker-bot commented Feb 10, 2023

AWS CodeBuild CI Report

codecov-commenter commented Feb 9, 2023 •

edited

Loading