# HuggingFacePipeline

> **Class** in `langchain_huggingface`

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

HuggingFace Pipeline API.

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

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

## Signature

```python
HuggingFacePipeline()
```

## Description

**Example using from_model_id:**

```python
from langchain_huggingface import HuggingFacePipeline

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

**Example passing pipeline in directly:**

```python
from langchain_huggingface 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

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

---

[View source on GitHub](https://github.com/langchain-ai/langchain/blob/8fec4e7ceee2c368b068c49f9fed453276e210e7/libs/partners/huggingface/langchain_huggingface/llms/huggingface_pipeline.py#L37)