Skip to content

feat: tagging jumpstart models #2

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

Open
wants to merge 9 commits into
base: feat/script_mode_for_model_class
Choose a base branch
from

Conversation

evakravi
Copy link
Owner

Issue #, if available:

Description of changes:

Testing done:

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 backword 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.

@evakravi evakravi force-pushed the feat/tagging-jumpstart-models branch from 0ee6065 to 15f730f Compare January 19, 2022 16:04
Copy link

@JGuinegagne JGuinegagne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few comments:

  • tag names
  • edge case handling



class JumpStartTag(str, Enum):
"""Enum class for tags to apply to JumpStart models."""

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that the tag key? If yes, can you update the docstring to make it clear please?

inference_script_uri: Optional[str],
) -> List[Dict[str, str]]:
"""Adds tags for JumpStart models. Returns original tags for non-JumpStart
models.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

"""Add custom tags to JumpStart models, return the updated tags.

No-op if this is not a JumpStart model related resource.

...
"""

{
constants.JumpStartTag.INFERENCE_SCRIPT_URI.value: inference_script_uri,
}
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is an edge case, but could you check that these tags do not already exist, and not add them if that's the case? You would get a validation error if you tried to add two tags with the same key.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea

JumpStartTag.INFERENCE_MODEL_URI.value: inference_model_uri,
},
{JumpStartTag.INFERENCE_SCRIPT_URI.value: inference_script_uri},
]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please add a unit test for the edge case where these tag keys are requested by the customer?

"""Enum class for tags to apply to JumpStart models."""

INFERENCE_MODEL_URI = "jumpstart-inference-model-uri"
INFERENCE_SCRIPT_URI = "jumpstart-inference-script-uri"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you use something like: aws-jumpstart- or aws-smjs- prefix to make it clear this was added by AWS?

System tags look like aws: so I would like to be close to this, even though these are not system tags (see tagging).

@evakravi evakravi force-pushed the feat/tagging-jumpstart-models branch from 2f3efa2 to 5cba331 Compare January 21, 2022 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants