Docs /Templates/ sinapsis-huggingface-transformers

SummarizationTransformers

sinapsis-huggingface-transformersTransformersmodelsaudiospeechtext-to-speech

Python template · sinapsis_huggingface_transformers.templates.summarization_transformers

Overview

Template for text summarization using a Hugging Face Transformers pipeline.

This class provides a reusable framework for summarizing text using a pre-trained Hugging Face model.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-huggingface-transformers==1.0.0
uv pip install sinapsis-huggingface-transformers==1.0.0
uv add sinapsis-huggingface-transformers==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

seed
int | None
Optional
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
model_path
typing.Literal['facebook/bart-large-cnn', 'google/pegasus-xsum', 'Falconsai/text_summarization', 'facebook/bart-large-xsum']
Optional
Default: "facebook/bart-large-cnn"
torch_dtype
typing.Literal['float16', 'float32']
Optional
Default: "float16"
model_cache_dir
str
Optional
Default: "/home/ariel/.cache/sinapsis"
pipeline_kwargs
PipelineKwargs
Optional
Default: null
deviceRequired
typing.Literal['cuda', 'cpu']
Required
Default: null
torch_dtype
typing.Literal['float16', 'float32', 'auto']
Optional
Default: "float16"
inference_kwargs

Task-specific parameters for the summarization pipeline, such as `clean_up_tokenization_spaces`.

SummarizationInferenceKwargs
Optional
Default: null
return_text

Whether or not to include the decoded texts in the outputs.

bool | None
Optional
Default: true
return_tensors

Whether or not to include the tensors of predictions.

bool | None
Optional
Default: false
generate_kwargs
dict[str, typing.Any] | None
Optional
Default: null
clean_up_tokenization_spaces

Whether or not to clean up the potential extra spaces.

bool | None
Optional
Default: false

Configuration example

Example from the Python docstring:

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: SummarizationTransformers
  class_name: SummarizationTransformers
  template_input: InputTemplate
  attributes:
    model_path: '/path/to/model'
    model_cache_dir: /path/to/cache/dir
    device: 'cuda'
    torch_dtype: float16
    inference_kwargs:
        min_length: 5
        max_length: 20
Show schema-based configuration skeleton
yaml
templates:
  - template_name: "SummarizationTransformers"
    class_name: "SummarizationTransformers"
    attributes:
      seed: null
      model_path: "facebook/bart-large-cnn"
      torch_dtype: "float16"
      model_cache_dir: "/home/ariel/.cache/sinapsis"
      pipeline_kwargs:
        device: "<required>"
        torch_dtype: "float16"
      inference_kwargs:
        return_text: true
        return_tensors: false
        generate_kwargs: null
        clean_up_tokenization_spaces: false

Inheritance

Immediate parent: sinapsis_huggingface_transformers.templates.base_transformers.TransformersBase

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.