The inference API

These docs refer to the PiPPy integration.

accelerate.prepare_pippy

< >

( model split_points = 'auto' no_split_module_classes = None example_args = () example_kwargs: Optional = None num_chunks = None )

Parameters

  • model (torch.nn.Module) — A model we want to split for pipeline-parallel inference
  • split_points (str, defaults to ‘auto’) — How to generate the split points and chunk the model across each GPU. ‘auto’ will find the best balanced split given any model.
  • no_split_module_classes (List[str]) — A list of class names for layers we don’t want to be split.
  • example_args (tuple of torch.Tensor) — The expected inputs for the model that uses order-based inputs. Recommended to use this method if possible.
  • example_kwargs (dict of torch.Tensor) — The expected inputs for the model that uses dictionary-based inputs. This is a highly limiting structure that requires the same keys be present at all inference calls. Not recommended unless the prior condition is true for all cases.
  • num_chunks (int) — The number of different stages the Pipeline will have. By default it will assign one chunk per GPU, but this can be tuned and played with. In general one should have num_chunks >= num_gpus.

Wraps model for PipelineParallelism