2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
2 changes: 1 addition & 1 deletion src/sagemaker/serve/builder/model_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ class ModelBuilder(Triton, DJL, JumpStart, TGI, Transformers, TensorflowServing,
in order for model builder to build the artifacts correctly (according
to the model server). Possible values for this argument are
``TORCHSERVE``, ``MMS``, ``TENSORFLOW_SERVING``, ``DJL_SERVING``,
``TRITON``, and``TGI``.
``TRITON``,``TGI``, and ``TEI``.
model_metadata (Optional[Dict[str, Any]): Dictionary used to override model metadata.
Currently, ``HF_TASK`` is overridable for HuggingFace model. HF_TASK should be set for
new models without task metadata in the Hub, adding unsupported task types will throw
Expand Down
18 changes: 10 additions & 8 deletions src/sagemaker/serve/builder/tei_builder.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@
_get_nb_instance,
)
from sagemaker.serve.model_server.tgi.prepare import _create_dir_structure
from sagemaker.serve.utils.predictors import TgiLocalModePredictor
from sagemaker.serve.utils.predictors import TeiLocalModePredictor
from sagemaker.serve.utils.types import ModelServer
from sagemaker.serve.mode.function_pointers import Mode
from sagemaker.serve.utils.telemetry_logger import _capture_telemetry
Expand DownExpand Up@@ -74,16 +74,16 @@ def _prepare_for_mode(self):
def _get_client_translators(self):
"""Placeholder docstring"""

def _set_to_tgi(self):
def _set_to_tei(self):
"""Placeholder docstring"""
if self.model_server != ModelServer.TGI:
if self.model_server != ModelServer.TEI:
messaging = (
"HuggingFace Model ID support on model server: "
f"{self.model_server} is not currently supported. "
f"Defaulting to {ModelServer.TGI}"
f"Defaulting to {ModelServer.TEI}"
)
logger.warning(messaging)
self.model_server = ModelServer.TGI
self.model_server = ModelServer.TEI

def _create_tei_model(self, **kwargs) -> Type[Model]:
"""Placeholder docstring"""
Expand DownExpand Up@@ -142,7 +142,7 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if self.mode == Mode.LOCAL_CONTAINER:
timeout = kwargs.get("model_data_download_timeout")

predictor = TgiLocalModePredictor(
predictor = TeiLocalModePredictor(
self.modes[str(Mode.LOCAL_CONTAINER)], serializer, deserializer
)

Expand DownExpand Up@@ -180,7 +180,9 @@ def _tei_model_builder_deploy_wrapper(self, *args, **kwargs) -> Type[PredictorBa
if "endpoint_logging" not in kwargs:
kwargs["endpoint_logging"] = True

if not self.nb_instance_type and "instance_type" not in kwargs:
if self.nb_instance_type and "instance_type" not in kwargs:
kwargs.update({"instance_type": self.nb_instance_type})
elif not self.nb_instance_type and "instance_type" not in kwargs:
raise ValueError(
"Instance type must be provided when deploying " "to SageMaker Endpoint mode."
)
Expand DownExpand Up@@ -216,7 +218,7 @@ def _build_for_tei(self):
"""Placeholder docstring"""
self.secret_key = None

self._set_to_tgi()
self._set_to_tei()

self.pysdk_model = self._build_for_hf_tei()
return self.pysdk_model
15 changes: 15 additions & 0 deletions src/sagemaker/serve/mode/local_container_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@
from sagemaker.serve.model_server.djl_serving.server import LocalDJLServing
from sagemaker.serve.model_server.triton.server import LocalTritonServer
from sagemaker.serve.model_server.tgi.server import LocalTgiServing
from sagemaker.serve.model_server.tei.server import LocalTeiServing
from sagemaker.serve.model_server.multi_model_server.server import LocalMultiModelServer
from sagemaker.session import Session

Expand DownExpand Up@@ -69,6 +70,7 @@ def __init__(
self.container = None
self.secret_key = None
self._ping_container = None
self._invoke_serving = None

def load(self, model_path: str = None):
"""Placeholder docstring"""
Expand DownExpand Up@@ -156,6 +158,19 @@ def create_server(
env_vars=env_vars if env_vars else self.env_vars,
)
self._ping_container = self._tensorflow_serving_deep_ping
elif self.model_server == ModelServer.TEI:
tei_serving = LocalTeiServing()
tei_serving._start_tei_serving(
client=self.client,
image=image,
model_path=model_path if model_path else self.model_path,
secret_key=secret_key,
env_vars=env_vars if env_vars else self.env_vars,
)
tei_serving.schema_builder = self.schema_builder
self.container = tei_serving.container
self._ping_container = tei_serving._tei_deep_ping
self._invoke_serving = tei_serving._invoke_tei_serving

# allow some time for container to be ready
time.sleep(10)
Expand Down
27 changes: 21 additions & 6 deletions src/sagemaker/serve/mode/sagemaker_endpoint_mode.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
import logging
from typing import Type

from sagemaker.serve.model_server.tei.server import SageMakerTeiServing
from sagemaker.serve.model_server.tensorflow_serving.server import SageMakerTensorflowServing
from sagemaker.session import Session
from sagemaker.serve.utils.types import ModelServer
Expand DownExpand Up@@ -37,6 +38,8 @@ def __init__(self, inference_spec: Type[InferenceSpec], model_server: ModelServe
self.inference_spec = inference_spec
self.model_server = model_server

self._tei_serving = SageMakerTeiServing()

def load(self, model_path: str):
"""Placeholder docstring"""
path = Path(model_path)
Expand DownExpand Up@@ -66,8 +69,9 @@ def prepare(
+ "session to be created or supply `sagemaker_session` into @serve.invoke."
) from e

upload_artifacts = None
if self.model_server == ModelServer.TORCHSERVE:
return self._upload_torchserve_artifacts(
upload_artifacts = self._upload_torchserve_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -76,7 +80,7 @@ def prepare(
)

if self.model_server == ModelServer.TRITON:
return self._upload_triton_artifacts(
upload_artifacts = self._upload_triton_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
Expand All@@ -85,15 +89,15 @@ def prepare(
)

if self.model_server == ModelServer.DJL_SERVING:
return self._upload_djl_artifacts(
upload_artifacts = self._upload_djl_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TGI:
return self._upload_tgi_artifacts(
upload_artifacts = self._upload_tgi_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
Expand All@@ -102,20 +106,31 @@ def prepare(
)

if self.model_server == ModelServer.MMS:
return self._upload_server_artifacts(
upload_artifacts = self._upload_server_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TENSORFLOW_SERVING:
return self._upload_tensorflow_serving_artifacts(
upload_artifacts = self._upload_tensorflow_serving_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
secret_key=secret_key,
s3_model_data_url=s3_model_data_url,
image=image,
)

if self.model_server == ModelServer.TEI:
upload_artifacts = self._tei_serving._upload_tei_artifacts(
model_path=model_path,
sagemaker_session=sagemaker_session,
s3_model_data_url=s3_model_data_url,
image=image,
)

if upload_artifacts:
return upload_artifacts

raise ValueError("%s model server is not supported" % self.model_server)
Empty file.
160 changes: 160 additions & 0 deletions src/sagemaker/serve/model_server/tei/server.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
"""Module for Local TEI Serving"""

from __future__ import absolute_import

import requests
import logging
from pathlib import Path
from docker.types import DeviceRequest
from sagemaker import Session, fw_utils
from sagemaker.serve.utils.exceptions import LocalModelInvocationException
from sagemaker.base_predictor import PredictorBase
from sagemaker.s3_utils import determine_bucket_and_prefix, parse_s3_url, s3_path_join
from sagemaker.s3 import S3Uploader
from sagemaker.local.utils import get_docker_host


MODE_DIR_BINDING = "/opt/ml/model/"
_SHM_SIZE = "2G"
_DEFAULT_ENV_VARS = {
"TRANSFORMERS_CACHE": "/opt/ml/model/",
"HUGGINGFACE_HUB_CACHE": "/opt/ml/model/",
}

logger = logging.getLogger(__name__)


class LocalTeiServing:
"""LocalTeiServing class"""

def _start_tei_serving(
self, client: object, image: str, model_path: str, secret_key: str, env_vars: dict
):
"""Starts a local tei serving container.

Args:
client: Docker client
image: Image to use
model_path: Path to the model
secret_key: Secret key to use for authentication
env_vars: Environment variables to set
"""
if env_vars and secret_key:
env_vars["SAGEMAKER_SERVE_SECRET_KEY"] = secret_key

self.container = client.containers.run(
image,
shm_size=_SHM_SIZE,
device_requests=[DeviceRequest(count=-1, capabilities=[["gpu"]])],
network_mode="host",
detach=True,
auto_remove=True,
volumes={
Path(model_path).joinpath("code"): {
"bind": MODE_DIR_BINDING,
"mode": "rw",
},
},
environment=_update_env_vars(env_vars),
)

def _invoke_tei_serving(self, request: object, content_type: str, accept: str):
"""Invokes a local tei serving container.

Args:
request: Request to send
content_type: Content type to use
accept: Accept to use
"""
try:
response = requests.post(
f"http://{get_docker_host()}:8080/invocations",
data=request,
headers={"Content-Type": content_type, "Accept": accept},
timeout=600,
)
response.raise_for_status()
return response.content
except Exception as e:
raise Exception("Unable to send request to the local container server") from e

def _tei_deep_ping(self, predictor: PredictorBase):
"""Checks if the local tei serving container is up and running.

If the container is not up and running, it will raise an exception.
"""
response = None
try:
response = predictor.predict(self.schema_builder.sample_input)
return (True, response)
# pylint: disable=broad-except
except Exception as e:
if "422 Client Error: Unprocessable Entity for url" in str(e):
raise LocalModelInvocationException(str(e))
return (False, response)

return (True, response)


class SageMakerTeiServing:
"""SageMakerTeiServing class"""

def _upload_tei_artifacts(
self,
model_path: str,
sagemaker_session: Session,
s3_model_data_url: str = None,
image: str = None,
env_vars: dict = None,
):
"""Uploads the model artifacts to S3.

Args:
model_path: Path to the model
sagemaker_session: SageMaker session
s3_model_data_url: S3 model data URL
image: Image to use
env_vars: Environment variables to set
"""
if s3_model_data_url:
bucket, key_prefix = parse_s3_url(url=s3_model_data_url)
else:
bucket, key_prefix = None, None

code_key_prefix = fw_utils.model_code_key_prefix(key_prefix, None, image)

bucket, code_key_prefix = determine_bucket_and_prefix(
bucket=bucket, key_prefix=code_key_prefix, sagemaker_session=sagemaker_session
)

code_dir = Path(model_path).joinpath("code")

s3_location = s3_path_join("s3://", bucket, code_key_prefix, "code")

logger.debug("Uploading TEI Model Resources uncompressed to: %s", s3_location)

model_data_url = S3Uploader.upload(
str(code_dir),
s3_location,
None,
sagemaker_session,
)

model_data = {
"S3DataSource": {
"CompressionType": "None",
"S3DataType": "S3Prefix",
"S3Uri": model_data_url + "/",
}
}

return (model_data, _update_env_vars(env_vars))


def _update_env_vars(env_vars: dict) -> dict:
"""Placeholder docstring"""
updated_env_vars = {}
updated_env_vars.update(_DEFAULT_ENV_VARS)
if env_vars:
updated_env_vars.update(env_vars)
return updated_env_vars
Loading