feature: Add Framework Version support for PyTorch compilation (Neo)

Author: Prateek Chauhan

src/sagemaker/image_uri_config/neo-pytorch.json

@@ -2,14 +2,73 @@
     "processors": ["cpu", "gpu"],
     "scope": ["inference"],
     "version_aliases": {
-        "0.4.0": "1.4.0",
-        "1.0.0": "1.4.0",
-        "1.1.0": "1.4.0",
-        "1.2.0": "1.4.0",
-        "1.3.0": "1.4.0"
+        "0.4.0": "1.4",
+        "1.0.0": "1.4",
+        "1.1.0": "1.4",
+        "1.2.0": "1.4",
+        "1.3.0": "1.4",
+        "1.4.0": "1.4"
     },
     "versions": {
-        "1.4.0": {
+        "1.4": {
+            "py_versions": ["py3"],
+            "registries": {
+                "af-south-1": "774647643957",
+                "ap-east-1": "110948597952",
+                "ap-northeast-1": "941853720454",
+                "ap-northeast-2": "151534178276",
+                "ap-south-1": "763008648453",
+                "ap-southeast-1": "324986816169",
+                "ap-southeast-2": "355873309152",
+                "ca-central-1": "464438896020",
+                "cn-north-1": "472730292857",
+                "cn-northwest-1": "474822919863",
+                "eu-central-1": "746233611703",
+                "eu-north-1": "601324751636",
+                "eu-south-1": "966458181534",
+                "eu-west-1": "802834080501",
+                "eu-west-2": "205493899709",
+                "eu-west-3": "254080097072",
+                "me-south-1": "836785723513",
+                "sa-east-1": "756306329178",
+                "us-east-1": "785573368785",
+                "us-east-2": "007439368137",
+                "us-gov-west-1": "263933020539",
+                "us-west-1": "710691900526",
+                "us-west-2": "301217895009"
+            },
+            "repository": "sagemaker-inference-pytorch"
+        },
+        "1.5": {
+            "py_versions": ["py3"],
+            "registries": {
+                "af-south-1": "774647643957",
+                "ap-east-1": "110948597952",
+                "ap-northeast-1": "941853720454",
+                "ap-northeast-2": "151534178276",
+                "ap-south-1": "763008648453",
+                "ap-southeast-1": "324986816169",
+                "ap-southeast-2": "355873309152",
+                "ca-central-1": "464438896020",
+                "cn-north-1": "472730292857",
+                "cn-northwest-1": "474822919863",
+                "eu-central-1": "746233611703",
+                "eu-north-1": "601324751636",
+                "eu-south-1": "966458181534",
+                "eu-west-1": "802834080501",
+                "eu-west-2": "205493899709",
+                "eu-west-3": "254080097072",
+                "me-south-1": "836785723513",
+                "sa-east-1": "756306329178",
+                "us-east-1": "785573368785",
+                "us-east-2": "007439368137",
+                "us-gov-west-1": "263933020539",
+                "us-west-1": "710691900526",
+                "us-west-2": "301217895009"
+            },
+            "repository": "sagemaker-inference-pytorch"
+        },
+        "1.6": {
             "py_versions": ["py3"],
             "registries": {
                 "af-south-1": "774647643957",

src/sagemaker/model.py

@@ -398,6 +398,7 @@ def _compilation_job_config(
         target_platform_arch=None,
         target_platform_accelerator=None,
         compiler_options=None,
+        framework_version=None,
     ):
         """Placeholder Docstring"""
         input_model_config = {
@@ -407,6 +408,9 @@ def _compilation_job_config(
             else input_shape,
             "Framework": framework.upper(),
         }
+        if framework.upper() == "PYTORCH" and framework_version is not None:
+            input_model_config["FrameworkVersion"] = utils.get_short_version(framework_version)
+
         role = self.sagemaker_session.expand_role(role)
         output_model_config = {
             "S3OutputLocation": output_path,
@@ -572,7 +576,8 @@ def compile(
             framework (str): The framework that is used to train the original
                 model. Allowed values: 'mxnet', 'tensorflow', 'keras', 'pytorch',
                 'onnx', 'xgboost'
-            framework_version (str):
+            framework_version (str):The version of framework, for example:
+                '1.5' for PyTorch
             target_platform_os (str): Target Platform OS, for example: 'LINUX'.
                 For allowed strings see
                 https://docs.aws.amazon.com/sagemaker/latest/dg/API_OutputConfig.html.
@@ -613,6 +618,7 @@ def compile(
         framework_version = framework_version or self._get_framework_version()
 
         self._init_sagemaker_session_if_does_not_exist(target_instance_family)
+
         config = self._compilation_job_config(
             target_instance_family,
             input_shape,
@@ -626,6 +632,7 @@ def compile(
             target_platform_arch,
             target_platform_accelerator,
             compiler_options,
+            framework_version,
         )
         self.sagemaker_session.compile_model(**config)
         job_status = self.sagemaker_session.wait_for_compilation_job(job_name)

tests/unit/sagemaker/model/test_neo.py

@@ -269,3 +269,58 @@ def test_deploy_add_compiled_model_suffix_to_endpoint_name_from_model_name(sagem
 
     model.deploy(1, "ml.c4.xlarge")
     assert model.endpoint_name.startswith("{}-ml-c4".format(model_name))
+
+
+@patch("sagemaker.session.Session")
+def test_compile_with_framework_version_15(session):
+    session.return_value.boto_region_name = REGION
+
+    model = _create_model()
+    model.compile(
+        target_instance_family="ml_c4",
+        input_shape={"data": [1, 3, 1024, 1024]},
+        output_path="s3://output",
+        role="role",
+        framework="pytorch",
+        framework_version="1.5",
+        job_name="compile-model",
+    )
+
+    assert "1.5" in model.image_uri
+
+
+@patch("sagemaker.session.Session")
+def test_compile_with_framework_version_16(session):
+    session.return_value.boto_region_name = REGION
+
+    model = _create_model()
+    model.compile(
+        target_instance_family="ml_c4",
+        input_shape={"data": [1, 3, 1024, 1024]},
+        output_path="s3://output",
+        role="role",
+        framework="pytorch",
+        framework_version="1.6",
+        job_name="compile-model",
+    )
+
+    assert "1.6" in model.image_uri
+
+
+@patch("sagemaker.session.Session")
+def test_compile_validates_framework_version(session):
+    session.return_value.boto_region_name = REGION
+
+    model = _create_model()
+    with pytest.raises(ValueError) as e:
+        model.compile(
+            target_instance_family="ml_c4",
+            input_shape={"data": [1, 3, 1024, 1024]},
+            output_path="s3://output",
+            role="role",
+            framework="pytorch",
+            framework_version="1.6.1",
+            job_name="compile-model",
+        )
+
+    assert "Unsupported neo-pytorch version: 1.6.1." in str(e)