text-generation-inference/backends/neuron/README.md

# Text-generation-inference - Neuron backend for AWS Trainium and inferentia2

## Description

This is the TGI backend for AWS Neuron Trainium and Inferentia family of chips.

This backend is composed of:
- the AWS Neuron SDK,
- the legacy v2 TGI launcher and router,
- a neuron specific inference server for text-generation.

## Usage

Please refer to the official [documentation](https://huggingface.co/docs/text-generation-inference/backends/neuron).

## Build your own image

The simplest way to build TGI with the neuron backend is to use the provided `Makefile`:

```shell
$ make -C backends/neuron image
```

Alternatively, you can build the image directly from the top directory using a command similar to the one defined
in the `Makefile` under the `image` target.
Add Neuron backend (#3033) * feat: add neuron backend * feat(neuron): add server standalone installation * feat(neuron): add server and integration tests * fix(neuron): increase ulimit when building image The base image used to compile the rust components seems to have a low ulimit for opened files, which leads to errors during compilation. * test(neuron): merge integration tests and fixtures * test: add --neuron option * review: do not use latest tag * review: remove ureq pinned version * review: --privileged should be the exception * feat: add neuron case to build ci * fix(neuron): export models from container in test fixtures The neuron tests require models to have been previously exported and cached on the hub. This is done automatically by the neuron.model fixture the first time the tests are ran for a specific version. This fixture used to export the models using optimum-neuron directly, but this package is not necessarily present on the system. Instead, it is now done through the neuron TGI itself, since it contains all the tools required to export the models. Note that since the CI runs docker in docker (dind) it does not seem possible to share a volume between the CI container and the container used to export the model. For that reason, a specific image with a modified entrypoint is built on-the-fly when a model export is required. * refactor: remove sagemaker entry-point The SageMaker image is built differently anyway. * fix(neuron): avoid using Levenshtein * test(neuron): use smaller llama model * feat(neuron): avoid installing CUDA in image * test(neuron): no error anymore when requesting too many tokens * ci: doing a precompilation step (with a different token). * test(neuron): avoid using image sha when exporting models We now manually evaluate the apparent hash of the neuron backend by combining the hash of the neuron backend directory and Dockerfile. This new hash is used to identify exported neuron models instead of the image sha. This has two benefits: - it changes less frequently (only hwen the neuron backend changes), which means less neuron models being pushed to the hub, - it can be evaluated locally, meaning that running the tests once locally will export the models before the CI uses them. * test(neuron): added a small script to prune test models --------- Co-authored-by: drbh <david.richard.holtz@gmail.com> Co-authored-by: Nicolas Patry <patry.nicolas@protonmail.com> 2025-02-24 08:10:05 +00:00			`# Text-generation-inference - Neuron backend for AWS Trainium and inferentia2`

			`## Description`

			`This is the TGI backend for AWS Neuron Trainium and Inferentia family of chips.`

			`This backend is composed of:`
			`- the AWS Neuron SDK,`
			`- the legacy v2 TGI launcher and router,`
			`- a neuron specific inference server for text-generation.`

			`## Usage`

			`Please refer to the official [documentation](https://huggingface.co/docs/text-generation-inference/backends/neuron).`

			`## Build your own image`

			The simplest way to build TGI with the neuron backend is to use the provided `Makefile`:

			```shell
			`$ make -C backends/neuron image`
			```

			`Alternatively, you can build the image directly from the top directory using a command similar to the one defined`
			in the `Makefile` under the `image` target.