Sagemaker check (#3137)

* kaggle check

* add tests

* sagemaker

* changelog

* type check

* update test requirements

CHANGELOG.md

@@ -43,6 +43,7 @@ By [@maxaudron](https://github.com/maxaudron) in [PR 3075](https://github.com/gr
 - Ensure the Video component correctly resets the UI state whe a new video source is loaded and reduce choppiness of UI by [@pngwn](https://github.com/abidlabs) in [PR 3117](https://github.com/gradio-app/gradio/pull/3117)
 - Fixes loading private Spaces by [@abidlabs](https://github.com/abidlabs) in [PR 3068](https://github.com/gradio-app/gradio/pull/3068) 
 - Added a warning when attempting to launch an `Interface` via the `%%blocks` jupyter notebook magic command by [@freddyaboulton](https://github.com/freddyaboulton) in [PR 3126](https://github.com/gradio-app/gradio/pull/3126)
+- A share link will automatically be created when running on Sagemaker notebooks so that the front-end is properly displayed by [@abidlabs](https://github.com/abidlabs) in [PR 3137](https://github.com/gradio-app/gradio/pull/3137) 
 
 ## Documentation Changes:
 - Added a guide on the 4 kinds of Gradio Interfaces by [@yvrjsharma](https://github.com/yvrjsharma) and [@abidlabs](https://github.com/abidlabs) in [PR 3003](https://github.com/gradio-app/gradio/pull/3003) 

gradio/blocks.py

@@ -1394,6 +1394,8 @@ class Blocks(BlockContext):
             self.is_running = True
             self.is_colab = utils.colab_check()
             self.is_kaggle = utils.kaggle_check()
+            self.is_sagemaker = utils.sagemaker_check()
+
             self.protocol = (
                 "https"
                 if self.local_url.startswith("https") or self.is_colab
@@ -1412,13 +1414,29 @@ class Blocks(BlockContext):
                     raise ValueError("Cannot queue with encryption enabled.")
         utils.launch_counter()
 
-        self.share = (
-            share
-            if share is not None
-            else True
-            if (self.is_colab and self.enable_queue) or self.is_kaggle
-            else False
-        )
+        if share is None:
+            if self.is_colab and self.enable_queue:
+                if not quiet:
+                    print(
+                        "Setting queue=True in a Colab notebook requires sharing enabled. Setting `share=True` (you can turn this off by setting `share=False` in `launch()` explicitly).\n"
+                    )
+                self.share = True
+            elif self.is_kaggle:
+                if not quiet:
+                    print(
+                        "Kaggle notebooks require sharing enabled. Setting `share=True` (you can turn this off by setting `share=False` in `launch()` explicitly).\n"
+                    )
+                self.share = True
+            elif self.is_sagemaker:
+                if not quiet:
+                    print(
+                        "Sagemaker notebooks may require sharing enabled. Setting `share=True` (you can turn this off by setting `share=False` in `launch()` explicitly).\n"
+                    )
+                self.share = True
+            else:
+                self.share = False
+        else:
+            self.share = share
 
         # If running in a colab or not able to access localhost,
         # a shareable link must be created.

gradio/utils.py

@@ -195,6 +195,17 @@ def kaggle_check() -> bool:
     )
 
 
+def sagemaker_check() -> bool:
+    try:
+        import boto3  # type: ignore
+
+        client = boto3.client("sts")
+        response = client.get_caller_identity()
+        return "sagemaker" in response["Arn"].lower()
+    except:
+        return False
+
+
 def ipython_check() -> bool:
     """
     Check if interface is launching from iPython (not colab)

test/requirements.in

@@ -1,5 +1,6 @@
 # Don't forget to run bash scripts/create_test_requirements.sh from unix or wsl when you update this file.
 asyncio
+boto3
 IPython
 comet_ml
 coverage

test/requirements.txt

@@ -24,6 +24,8 @@ backcall==0.2.0
     # via ipython
 black==22.6.0
     # via -r requirements.in
+boto3==1.26.65    
+    # via -r requirements.in
 certifi==2022.6.15
     # via
     #   dulwich

test/test_utils.py

@@ -2,8 +2,10 @@ import copy
 import ipaddress
 import json
 import os
+import sys
 import unittest.mock as mock
 import warnings
+from unittest.mock import MagicMock
 
 import pytest
 import pytest_asyncio
@@ -32,6 +34,7 @@ from gradio.utils import (
     kaggle_check,
     launch_analytics,
     readme_to_html,
+    sagemaker_check,
     sanitize_list_for_csv,
     sanitize_value_for_csv,
     strip_invalid_filename_characters,
@@ -104,6 +107,22 @@ class TestUtils:
     def test_readme_to_html_correct_parse(self):
         readme_to_html("https://github.com/gradio-app/gradio/blob/master/README.md")
 
+    def test_sagemaker_check_false(self):
+        assert not sagemaker_check()
+
+    def test_sagemaker_check_false_if_boto3_not_installed(self):
+        with mock.patch.dict(sys.modules, {"boto3": None}, clear=True):
+            assert not sagemaker_check()
+
+    @mock.patch("boto3.session.Session.client")
+    def test_sagemaker_check_true(self, mock_client):
+        mock_client().get_caller_identity = MagicMock(
+            return_value={
+                "Arn": "arn:aws:sts::67364438:assumed-role/SageMaker-Datascients/SageMaker"
+            }
+        )
+        assert sagemaker_check()
+
     def test_kaggle_check_false(self):
         assert not kaggle_check()