#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# pytype: skip-file
import logging
from collections import defaultdict
from typing import Any
from typing import Callable
from typing import Dict
from typing import Iterable
from typing import Optional
from typing import Sequence
from typing import Union
import torch
from apache_beam.io.filesystems import FileSystems
from apache_beam.ml.inference.base import ModelHandler
from apache_beam.ml.inference.base import PredictionResult
from apache_beam.utils.annotations import experimental
__all__ = [
'PytorchModelHandlerTensor',
'PytorchModelHandlerKeyedTensor',
]
TensorInferenceFn = Callable[
[Sequence[torch.Tensor], torch.nn.Module, str, Optional[Dict[str, Any]]],
Iterable[PredictionResult]]
KeyedTensorInferenceFn = Callable[[
Sequence[Dict[str, torch.Tensor]],
torch.nn.Module,
str,
Optional[Dict[str, Any]]
],
Iterable[PredictionResult]]
def _load_model(
model_class: torch.nn.Module, state_dict_path, device, **model_params):
model = model_class(**model_params)
if device == torch.device('cuda') and not torch.cuda.is_available():
logging.warning(
"Model handler specified a 'GPU' device, but GPUs are not available. " \
"Switching to CPU.")
device = torch.device('cpu')
file = FileSystems.open(state_dict_path, 'rb')
try:
logging.info(
"Loading state_dict_path %s onto a %s device", state_dict_path, device)
state_dict = torch.load(file, map_location=device)
except RuntimeError as e:
if device == torch.device('cuda'):
message = "Loading the model onto a GPU device failed due to an " \
f"exception:\n{e}\nAttempting to load onto a CPU device instead."
logging.warning(message)
return _load_model(
model_class, state_dict_path, torch.device('cpu'), **model_params)
else:
raise e
model.load_state_dict(state_dict)
model.to(device)
model.eval()
logging.info("Finished loading PyTorch model.")
return (model, device)
def _convert_to_device(examples: torch.Tensor, device) -> torch.Tensor:
"""
Converts samples to a style matching given device.
**NOTE:** A user may pass in device='GPU' but if GPU is not detected in the
environment it must be converted back to CPU.
"""
if examples.device != device:
examples = examples.to(device)
return examples
def _convert_to_result(
batch: Iterable, predictions: Union[Iterable, Dict[Any, Iterable]]
) -> Iterable[PredictionResult]:
if isinstance(predictions, dict):
# Go from one dictionary of type: {key_type1: Iterable<val_type1>,
# key_type2: Iterable<val_type2>, ...} where each Iterable is of
# length batch_size, to a list of dictionaries:
# [{key_type1: value_type1, key_type2: value_type2}]
predictions_per_tensor = [
dict(zip(predictions.keys(), v)) for v in zip(*predictions.values())
]
return [
PredictionResult(x, y) for x, y in zip(batch, predictions_per_tensor)
]
return [PredictionResult(x, y) for x, y in zip(batch, predictions)]
def default_tensor_inference_fn(
batch: Sequence[torch.Tensor],
model: torch.nn.Module,
device: str,
inference_args: Optional[Dict[str,
Any]] = None) -> Iterable[PredictionResult]:
# torch.no_grad() mitigates GPU memory issues
# https://github.com/apache/beam/issues/22811
with torch.no_grad():
batched_tensors = torch.stack(batch)
batched_tensors = _convert_to_device(batched_tensors, device)
predictions = model(batched_tensors, **inference_args)
return _convert_to_result(batch, predictions)
def make_tensor_model_fn(model_fn: str) -> TensorInferenceFn:
"""
Produces a TensorInferenceFn that uses a method of the model other that
the forward() method.
Args:
model_fn: A string name of the method to be used. This is accessed through
getattr(model, model_fn)
"""
def attr_fn(
batch: Sequence[torch.Tensor],
model: torch.nn.Module,
device: str,
inference_args: Optional[Dict[str, Any]] = None
) -> Iterable[PredictionResult]:
with torch.no_grad():
batched_tensors = torch.stack(batch)
batched_tensors = _convert_to_device(batched_tensors, device)
pred_fn = getattr(model, model_fn)
predictions = pred_fn(batched_tensors, **inference_args)
return _convert_to_result(batch, predictions)
return attr_fn
[docs]class PytorchModelHandlerTensor(ModelHandler[torch.Tensor,
PredictionResult,
torch.nn.Module]):
def __init__(
self,
state_dict_path: str,
model_class: Callable[..., torch.nn.Module],
model_params: Dict[str, Any],
device: str = 'CPU',
*,
inference_fn: TensorInferenceFn = default_tensor_inference_fn):
"""Implementation of the ModelHandler interface for PyTorch.
Example Usage::
pcoll | RunInference(PytorchModelHandlerTensor(state_dict_path="my_uri"))
See https://pytorch.org/tutorials/beginner/saving_loading_models.html
for details
Args:
state_dict_path: path to the saved dictionary of the model state.
model_class: class of the Pytorch model that defines the model
structure.
model_params: A dictionary of arguments required to instantiate the model
class.
device: the device on which you wish to run the model. If
``device = GPU`` then a GPU device will be used if it is available.
Otherwise, it will be CPU.
inference_fn: the inference function to use during RunInference.
default=_default_tensor_inference_fn
**Supported Versions:** RunInference APIs in Apache Beam have been tested
with PyTorch 1.9 and 1.10.
"""
self._state_dict_path = state_dict_path
if device == 'GPU':
logging.info("Device is set to CUDA")
self._device = torch.device('cuda')
else:
logging.info("Device is set to CPU")
self._device = torch.device('cpu')
self._model_class = model_class
self._model_params = model_params
self._inference_fn = inference_fn
[docs] def load_model(self) -> torch.nn.Module:
"""Loads and initializes a Pytorch model for processing."""
model, device = _load_model(
self._model_class,
self._state_dict_path,
self._device,
**self._model_params)
self._device = device
return model
[docs] def run_inference(
self,
batch: Sequence[torch.Tensor],
model: torch.nn.Module,
inference_args: Optional[Dict[str, Any]] = None
) -> Iterable[PredictionResult]:
"""
Runs inferences on a batch of Tensors and returns an Iterable of
Tensor Predictions.
This method stacks the list of Tensors in a vectorized format to optimize
the inference call.
Args:
batch: A sequence of Tensors. These Tensors should be batchable, as this
method will call `torch.stack()` and pass in batched Tensors with
dimensions (batch_size, n_features, etc.) into the model's forward()
function.
model: A PyTorch model.
inference_args: Non-batchable arguments required as inputs to the model's
forward() function. Unlike Tensors in `batch`, these parameters will
not be dynamically batched
Returns:
An Iterable of type PredictionResult.
"""
inference_args = {} if not inference_args else inference_args
return self._inference_fn(batch, model, self._device, inference_args)
[docs] def get_num_bytes(self, batch: Sequence[torch.Tensor]) -> int:
"""
Returns:
The number of bytes of data for a batch of Tensors.
"""
return sum((el.element_size() for tensor in batch for el in tensor))
[docs] def get_metrics_namespace(self) -> str:
"""
Returns:
A namespace for metrics collected by the RunInference transform.
"""
return 'BeamML_PyTorch'
[docs] def validate_inference_args(self, inference_args: Optional[Dict[str, Any]]):
pass
def default_keyed_tensor_inference_fn(
batch: Sequence[Dict[str, torch.Tensor]],
model: torch.nn.Module,
device: str,
inference_args: Optional[Dict[str,
Any]] = None) -> Iterable[PredictionResult]:
# If elements in `batch` are provided as a dictionaries from key to Tensors,
# then iterate through the batch list, and group Tensors to the same key
key_to_tensor_list = defaultdict(list)
# torch.no_grad() mitigates GPU memory issues
# https://github.com/apache/beam/issues/22811
with torch.no_grad():
for example in batch:
for key, tensor in example.items():
key_to_tensor_list[key].append(tensor)
key_to_batched_tensors = {}
for key in key_to_tensor_list:
batched_tensors = torch.stack(key_to_tensor_list[key])
batched_tensors = _convert_to_device(batched_tensors, device)
key_to_batched_tensors[key] = batched_tensors
predictions = model(**key_to_batched_tensors, **inference_args)
return _convert_to_result(batch, predictions)
def make_keyed_tensor_model_fn(model_fn: str) -> KeyedTensorInferenceFn:
"""
Produces a KeyedTensorInferenceFn that uses a method of the model other that
the forward() method.
Args:
model_fn: A string name of the method to be used. This is accessed through
getattr(model, model_fn)
"""
def attr_fn(
batch: Sequence[torch.Tensor],
model: torch.nn.Module,
device: str,
inference_args: Optional[Dict[str, Any]] = None
) -> Iterable[PredictionResult]:
# If elements in `batch` are provided as a dictionaries from key to Tensors,
# then iterate through the batch list, and group Tensors to the same key
key_to_tensor_list = defaultdict(list)
# torch.no_grad() mitigates GPU memory issues
# https://github.com/apache/beam/issues/22811
with torch.no_grad():
for example in batch:
for key, tensor in example.items():
key_to_tensor_list[key].append(tensor)
key_to_batched_tensors = {}
for key in key_to_tensor_list:
batched_tensors = torch.stack(key_to_tensor_list[key])
batched_tensors = _convert_to_device(batched_tensors, device)
key_to_batched_tensors[key] = batched_tensors
pred_fn = getattr(model, model_fn)
predictions = pred_fn(**key_to_batched_tensors, **inference_args)
return _convert_to_result(batch, predictions)
return attr_fn
[docs]@experimental(extra_message="No backwards-compatibility guarantees.")
class PytorchModelHandlerKeyedTensor(ModelHandler[Dict[str, torch.Tensor],
PredictionResult,
torch.nn.Module]):
def __init__(
self,
state_dict_path: str,
model_class: Callable[..., torch.nn.Module],
model_params: Dict[str, Any],
device: str = 'CPU',
*,
inference_fn: KeyedTensorInferenceFn = default_keyed_tensor_inference_fn):
"""Implementation of the ModelHandler interface for PyTorch.
Example Usage::
pcoll | RunInference(
PytorchModelHandlerKeyedTensor(state_dict_path="my_uri"))
**NOTE:** This API and its implementation are under development and
do not provide backward compatibility guarantees.
See https://pytorch.org/tutorials/beginner/saving_loading_models.html
for details
Args:
state_dict_path: path to the saved dictionary of the model state.
model_class: class of the Pytorch model that defines the model
structure.
model_params: A dictionary of arguments required to instantiate the model
class.
device: the device on which you wish to run the model. If
``device = GPU`` then a GPU device will be used if it is available.
Otherwise, it will be CPU.
inference_fn: the function to invoke on run_inference.
default = default_keyed_tensor_inference_fn
**Supported Versions:** RunInference APIs in Apache Beam have been tested
with PyTorch 1.9 and 1.10.
"""
self._state_dict_path = state_dict_path
if device == 'GPU':
logging.info("Device is set to CUDA")
self._device = torch.device('cuda')
else:
logging.info("Device is set to CPU")
self._device = torch.device('cpu')
self._model_class = model_class
self._model_params = model_params
self._inference_fn = inference_fn
[docs] def load_model(self) -> torch.nn.Module:
"""Loads and initializes a Pytorch model for processing."""
model, device = _load_model(
self._model_class,
self._state_dict_path,
self._device,
**self._model_params)
self._device = device
return model
[docs] def run_inference(
self,
batch: Sequence[Dict[str, torch.Tensor]],
model: torch.nn.Module,
inference_args: Optional[Dict[str, Any]] = None
) -> Iterable[PredictionResult]:
"""
Runs inferences on a batch of Keyed Tensors and returns an Iterable of
Tensor Predictions.
For the same key across all examples, this will stack all Tensors values
in a vectorized format to optimize the inference call.
Args:
batch: A sequence of keyed Tensors. These Tensors should be batchable,
as this method will call `torch.stack()` and pass in batched Tensors
with dimensions (batch_size, n_features, etc.) into the model's
forward() function.
model: A PyTorch model.
inference_args: Non-batchable arguments required as inputs to the model's
forward() function. Unlike Tensors in `batch`, these parameters will
not be dynamically batched
Returns:
An Iterable of type PredictionResult.
"""
inference_args = {} if not inference_args else inference_args
return self._inference_fn(batch, model, self._device, inference_args)
[docs] def get_num_bytes(self, batch: Sequence[torch.Tensor]) -> int:
"""
Returns:
The number of bytes of data for a batch of Dict of Tensors.
"""
# If elements in `batch` are provided as a dictionaries from key to Tensors
return sum(
(el.element_size() for tensor in batch for el in tensor.values()))
[docs] def get_metrics_namespace(self) -> str:
"""
Returns:
A namespace for metrics collected by the RunInference transform.
"""
return 'BeamML_PyTorch'
[docs] def validate_inference_args(self, inference_args: Optional[Dict[str, Any]]):
pass