# HuggingFacePipeline

> **Class** in `langchain_community`

📖 [View in docs](https://reference.langchain.com/python/langchain-community/llms/huggingface_pipeline/HuggingFacePipeline)

HuggingFace Pipeline API.

To use, you should have the ``transformers`` python package installed.

Only supports `text-generation`, `text2text-generation`, `summarization` and
`translation`  for now.

## Signature

```python
HuggingFacePipeline()
```

## Description

**Example using from_model_id:**

.. code-block:: python

from langchain_community.llms import HuggingFacePipeline
hf = HuggingFacePipeline.from_model_id(
    model_id="gpt2",
    task="text-generation",
    pipeline_kwargs={"max_new_tokens": 10},
)

Example passing pipeline in directly:
.. code-block:: python

    from langchain_community.llms import HuggingFacePipeline
    from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline

    model_id = "gpt2"
    tokenizer = AutoTokenizer.from_pretrained(model_id)
    model = AutoModelForCausalLM.from_pretrained(model_id)
    pipe = pipeline(
        "text-generation", model=model, tokenizer=tokenizer, max_new_tokens=10
    )
    hf = HuggingFacePipeline(pipeline=pipe)

## Extends

- `BaseLLM`

## Properties

- `pipeline`
- `model_id`
- `model_kwargs`
- `pipeline_kwargs`
- `batch_size`
- `model_config`

## Methods

- [`from_model_id()`](https://reference.langchain.com/python/langchain-community/llms/huggingface_pipeline/HuggingFacePipeline/from_model_id)

## ⚠️ Deprecated

Deprecated since version 0.0.37.

---

[View source on GitHub](https://github.com/langchain-ai/langchain-community/blob/a6a6079511ac8a5c1293337f88096b8641562e77/libs/community/langchain_community/llms/huggingface_pipeline.py#L26)