Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add support for MetricDefinitions in ModelTrainer and update docs #5040

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

benieric
Copy link
Contributor

@benieric benieric commented Feb 14, 2025

Issue #, if available:
Addresses: #5018

Description of changes:

  • Updated pydocs
  • Adding support for MetricDefinitions following existing .with_xxx pattern

Enable usage like below:

  from sagemaker.modules.train import ModelTrainer
  from sagemaker.modules.configs import MetricDefinition

  metric_definitions = [
      MetricDefinition(
          name="loss",
          regex="Loss: (.*?);",
      )
  ]

  model_trainer = ModelTrainer(
      ...
  ).with_metric_definitions(metric_definitions)

Also added pydocs with example code

Testing done:

  • Added unit tests and tested end to end for sanity
  • Tested pydocs generates correctly
image

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)
  • If adding any dependency in requirements.txt files, I have spell checked and ensured they exist in PyPi

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

@benieric benieric requested a review from a team as a code owner February 14, 2025 05:47
@benieric benieric added Pending information do-not-merge Use when PR needs to be marked as do not merge labels Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge Use when PR needs to be marked as do not merge Pending information
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant