> This page is for version v0.25.0.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo/guardrails/latest/llms.txt
> - v0.25.0: https://docs.nvidia.com/nemo/guardrails/v0.25.0/llms.txt
> - v0.24.1: https://docs.nvidia.com/nemo/guardrails/v0.24.1/llms.txt
> - v0.24.0: https://docs.nvidia.com/nemo/guardrails/v0.24.0/llms.txt
> - v0.23.0: https://docs.nvidia.com/nemo/guardrails/v0.23.0/llms.txt
> - v0.22.0: https://docs.nvidia.com/nemo/guardrails/v0.22.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/guardrails/llms.txt.

# nemoguardrails.integrations.langchain.providers.huggingface

## Submodules

* **[`nemoguardrails.integrations.langchain.providers.huggingface.pipeline`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/integrations/langchain/providers/huggingface/pipeline)**
* **[`nemoguardrails.integrations.langchain.providers.huggingface.streamers`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/integrations/langchain/providers/huggingface/streamers)**

## Package Contents

### Classes

| Name                                                                                                                                   | Description                                                                 |
| -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [`AsyncTextIteratorStreamer`](#nemoguardrails-integrations-langchain-providers-huggingface-streamers-AsyncTextIteratorStreamer)        | Simple async implementation for HuggingFace Transformers streamers.         |
| [`HuggingFacePipelineCompatible`](#nemoguardrails-integrations-langchain-providers-huggingface-pipeline-HuggingFacePipelineCompatible) | Hackish way to add backward-compatibility functions to the Langchain class. |

### API

```python
class nemoguardrails.integrations.langchain.providers.huggingface.AsyncTextIteratorStreamer(
    tokenizer: transformers.AutoTokenizer,
    skip_prompt: bool = False,
    decode_kwargs = {}
)
```

**Bases:** [TextStreamer](#nemoguardrails-integrations-langchain-providers-huggingface-streamers-TextStreamer)

Simple async implementation for HuggingFace Transformers streamers.

This follows closely how transformers.generation.streamers.TextIteratorStreamer works,
with minor modifications to make it async.

**`loop`** `Optional[AbstractEventLoop] = None`

---

**`text_queue`** `Queue[str] = asyncio.Queue()`

---

```python
nemoguardrails.integrations.langchain.providers.huggingface.AsyncTextIteratorStreamer.__aiter__()
```

```python
nemoguardrails.integrations.langchain.providers.huggingface.AsyncTextIteratorStreamer.__anext__()
```

async

```python
nemoguardrails.integrations.langchain.providers.huggingface.AsyncTextIteratorStreamer.on_finalized_text(
    text: str,
    stream_end: bool = False
)
```

Put the new text in the queue. If the stream is ending, also put a stop signal in the queue.

```python
class nemoguardrails.integrations.langchain.providers.huggingface.HuggingFacePipelineCompatible()
```

**Bases:** `HuggingFacePipeline`

Hackish way to add backward-compatibility functions to the Langchain class.
TODO: Planning to add this fix directly to Langchain repo.

```python
nemoguardrails.integrations.langchain.providers.huggingface.HuggingFacePipelineCompatible._acall(
    prompt: str,
    stop: typing.Optional[typing.List[str]] = None,
    run_manager: typing.Optional[langchain_core.callbacks.manager.AsyncCallbackManagerForLLMRun] = None,
    kwargs: typing.Any = {}
) -> str
```

async

Hackish way to add async support

```python
nemoguardrails.integrations.langchain.providers.huggingface.HuggingFacePipelineCompatible._call(
    prompt: str,
    stop: typing.Optional[typing.List[str]] = None,
    run_manager: typing.Optional[langchain_core.callbacks.manager.CallbackManagerForLLMRun] = None,
    kwargs: typing.Any = {}
) -> str
```

Hackish way to perform a single llm call since Langchain dropped support