• Stars
    star
    7,240
  • Rank 5,077 (Top 0.2 %)
  • Language
    Python
  • License
    Other
  • Created over 1 year ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Large Language Model Text Generation Inference

Text Generation Inference

GitHub Repo stars License Swagger API documentation

architecture

A Rust, Python and gRPC server for text generation inference. Used in production at HuggingFace to power LLMs api-inference widgets.

Table of contents

Features

Optimized architectures

Other architectures are supported on a best effort basis using:

AutoModelForCausalLM.from_pretrained(<model>, device_map="auto")

or

AutoModelForSeq2SeqLM.from_pretrained(<model>, device_map="auto")

Get started

Docker

The easiest way of getting started is using the official Docker container:

model=bigscience/bloom-560m
num_shard=2
volume=$PWD/data # share a volume with the Docker container to avoid downloading weights every run

docker run --gpus all --shm-size 1g -p 8080:80 -v $volume:/data ghcr.io/huggingface/text-generation-inference:0.8 --model-id $model --num-shard $num_shard

Note: To use GPUs, you need to install the NVIDIA Container Toolkit. We also recommend using NVIDIA drivers with CUDA version 11.8 or higher.

To see all options to serve your models (in the code or in the cli:

text-generation-launcher --help

You can then query the model using either the /generate or /generate_stream routes:

curl 127.0.0.1:8080/generate \
    -X POST \
    -d '{"inputs":"What is Deep Learning?","parameters":{"max_new_tokens":17}}' \
    -H 'Content-Type: application/json'
curl 127.0.0.1:8080/generate_stream \
    -X POST \
    -d '{"inputs":"What is Deep Learning?","parameters":{"max_new_tokens":17}}' \
    -H 'Content-Type: application/json'

or from Python:

pip install text-generation
from text_generation import Client

client = Client("http://127.0.0.1:8080")
print(client.generate("What is Deep Learning?", max_new_tokens=17).generated_text)

text = ""
for response in client.generate_stream("What is Deep Learning?", max_new_tokens=17):
    if not response.token.special:
        text += response.token.text
print(text)

API documentation

You can consult the OpenAPI documentation of the text-generation-inference REST API using the /docs route. The Swagger UI is also available at: https://huggingface.github.io/text-generation-inference.

Distributed Tracing

text-generation-inference is instrumented with distributed tracing using OpenTelemetry. You can use this feature by setting the address to an OTLP collector with the --otlp-endpoint argument.

A note on Shared Memory (shm)

NCCL is a communication framework used by PyTorch to do distributed training/inference. text-generation-inference make use of NCCL to enable Tensor Parallelism to dramatically speed up inference for large language models.

In order to share data between the different devices of a NCCL group, NCCL might fall back to using the host memory if peer-to-peer using NVLink or PCI is not possible.

To allow the container to use 1G of Shared Memory and support SHM sharing, we add --shm-size 1g on the above command.

If you are running text-generation-inference inside Kubernetes. You can also add Shared Memory to the container by creating a volume with:

- name: shm
  emptyDir:
   medium: Memory
   sizeLimit: 1Gi

and mounting it to /dev/shm.

Finally, you can also disable SHM sharing by using the NCCL_SHM_DISABLE=1 environment variable. However, note that this will impact performance.

Local install

You can also opt to install text-generation-inference locally.

First install Rust and create a Python virtual environment with at least Python 3.9, e.g. using conda:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

conda create -n text-generation-inference python=3.9 
conda activate text-generation-inference

You may also need to install Protoc.

On Linux:

PROTOC_ZIP=protoc-21.12-linux-x86_64.zip
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v21.12/$PROTOC_ZIP
sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
rm -f $PROTOC_ZIP

On MacOS, using Homebrew:

brew install protobuf

Then run:

BUILD_EXTENSIONS=True make install # Install repository and HF/transformer fork with CUDA kernels
make run-bloom-560m

Note: on some machines, you may also need the OpenSSL libraries and gcc. On Linux machines, run:

sudo apt-get install libssl-dev gcc -y

CUDA Kernels

The custom CUDA kernels are only tested on NVIDIA A100s. If you have any installation or runtime issues, you can remove the kernels by using the BUILD_EXTENSIONS=False environment variable.

Be aware that the official Docker image has them enabled by default.

Run BLOOM

Download

It is advised to download the weights ahead of time with the following command:

make download-bloom

Run

make run-bloom # Requires 8xA100 80GB

Quantization

You can also quantize the weights with bitsandbytes to reduce the VRAM requirement:

make run-bloom-quantize # Requires 8xA100 40GB

Develop

make server-dev
make router-dev

Testing

# python
make python-server-tests
make python-client-tests
# or both server and client tests
make python-tests
# rust cargo tests
make rust-tests
# integration tests
make integration-tests

More Repositories

1

transformers

πŸ€— Transformers: State-of-the-art Machine Learning for Pytorch, TensorFlow, and JAX.
Python
124,150
star
2

pytorch-image-models

PyTorch image models, scripts, pretrained weights -- ResNet, ResNeXT, EfficientNet, NFNet, Vision Transformer (ViT), MobileNet-V3/V2, RegNet, DPN, CSPNet, Swin Transformer, MaxViT, CoAtNet, ConvNeXt, and more
Python
28,073
star
3

diffusers

πŸ€— Diffusers: State-of-the-art diffusion models for image and audio generation in PyTorch
Python
21,823
star
4

datasets

πŸ€— The largest hub of ready-to-use datasets for ML models with fast, easy-to-use and efficient data manipulation tools
Python
17,530
star
5

peft

πŸ€— PEFT: State-of-the-art Parameter-Efficient Fine-Tuning.
Python
13,148
star
6

candle

Minimalist ML framework for Rust
Rust
12,686
star
7

tokenizers

πŸ’₯ Fast State-of-the-Art Tokenizers optimized for Research and Production
Rust
8,286
star
8

trl

Train transformer language models with reinforcement learning.
Python
7,661
star
9

accelerate

πŸš€ A simple way to launch, train, and use PyTorch models on almost any device and distributed configuration, automatic mixed precision (including fp8), and easy-to-configure FSDP and DeepSpeed support
Python
6,878
star
10

chat-ui

Open source codebase powering the HuggingChat app
TypeScript
5,586
star
11

deep-rl-class

This repo contains the syllabus of the Hugging Face Deep Reinforcement Learning Course.
MDX
3,541
star
12

alignment-handbook

Robust recipes to align language models with human and AI preferences
Python
3,485
star
13

diffusion-models-class

Materials for the Hugging Face Diffusion Models Course
Jupyter Notebook
3,126
star
14

notebooks

Notebooks using the Hugging Face libraries πŸ€—
Jupyter Notebook
3,114
star
15

distil-whisper

Distilled variant of Whisper for speech recognition. 6x faster, 50% smaller, within 1% word error rate.
Python
2,964
star
16

neuralcoref

✨Fast Coreference Resolution in spaCy with Neural Networks
C
2,788
star
17

autotrain-advanced

πŸ€— AutoTrain Advanced
Python
2,759
star
18

knockknock

πŸšͺ✊Knock Knock: Get notified when your training ends with only two additional lines of code
Python
2,660
star
19

safetensors

Simple, safe way to store and distribute tensors
Python
2,347
star
20

swift-coreml-diffusers

Swift app demonstrating Core ML Stable Diffusion
Swift
2,329
star
21

optimum

πŸš€ Accelerate training and inference of πŸ€— Transformers and πŸ€— Diffusers with easy to use hardware optimization tools
Python
2,086
star
22

awesome-papers

Papers & presentation materials from Hugging Face's internal science day
1,996
star
23

blog

Public repo for HF blog posts
Jupyter Notebook
1,962
star
24

setfit

Efficient few-shot learning with Sentence Transformers
Jupyter Notebook
1,912
star
25

text-embeddings-inference

A blazing fast inference solution for text embeddings models
Rust
1,845
star
26

course

The Hugging Face course on Transformers
MDX
1,832
star
27

evaluate

πŸ€— Evaluate: A library for easily evaluating machine learning models and datasets.
Python
1,752
star
28

transfer-learning-conv-ai

πŸ¦„ State-of-the-Art Conversational AI with Transfer Learning
Python
1,654
star
29

swift-coreml-transformers

Swift Core ML 3 implementations of GPT-2, DistilGPT-2, BERT, and DistilBERT for Question answering. Other Transformers coming soon!
Swift
1,543
star
30

pytorch-openai-transformer-lm

πŸ₯A PyTorch implementation of OpenAI's finetuned transformer language model with a script to import the weights pre-trained by OpenAI
Python
1,464
star
31

huggingface_hub

All the open source things related to the Hugging Face Hub.
Python
1,311
star
32

Mongoku

πŸ”₯The Web-scale GUI for MongoDB
TypeScript
1,277
star
33

huggingface.js

Utilities to use the Hugging Face Hub API
TypeScript
1,186
star
34

hmtl

🌊HMTL: Hierarchical Multi-Task Learning - A State-of-the-Art neural network model for several NLP tasks based on PyTorch and AllenNLP
Python
1,181
star
35

gsplat.js

JavaScript Gaussian Splatting library.
TypeScript
1,114
star
36

llm-vscode

LLM powered development for VSCode
TypeScript
1,060
star
37

datatrove

Freeing data processing from scripting madness by providing a set of platform-agnostic customizable pipeline processing blocks.
Python
1,033
star
38

pytorch-pretrained-BigGAN

πŸ¦‹A PyTorch implementation of BigGAN with pretrained weights and conversion scripts.
Python
986
star
39

torchMoji

πŸ˜‡A pyTorch implementation of the DeepMoji model: state-of-the-art deep learning model for analyzing sentiment, emotion, sarcasm etc
Python
880
star
40

naacl_transfer_learning_tutorial

Repository of code for the tutorial on Transfer Learning in NLP held at NAACL 2019 in Minneapolis, MN, USA
Python
717
star
41

awesome-huggingface

πŸ€— A list of wonderful open-source projects & applications integrated with Hugging Face libraries.
698
star
42

optimum-nvidia

Python
680
star
43

nanotron

Minimalistic large language model 3D-parallelism training
Python
661
star
44

datasets-server

Lightweight web API for visualizing and exploring all types of datasets - computer vision, speech, text, and tabular - stored on the Hugging Face Hub
Python
594
star
45

transformers-bloom-inference

Fast Inference Solutions for BLOOM
Python
546
star
46

pytorch_block_sparse

Fast Block Sparse Matrices for Pytorch
C++
523
star
47

exporters

Export Hugging Face models to Core ML and TensorFlow Lite
Python
518
star
48

llm.nvim

LLM powered development for Neovim
Lua
507
star
49

cookbook

Open-source AI cookbook
Jupyter Notebook
471
star
50

node-question-answering

Fast and production-ready question answering in Node.js
TypeScript
459
star
51

swift-transformers

Swift Package to implement a transformers-like API in Swift
Swift
438
star
52

large_language_model_training_playbook

An open collection of implementation tips, tricks and resources for training large language models
Python
431
star
53

llm-ls

LSP server leveraging LLMs for code completion (and more?)
Rust
416
star
54

llm_training_handbook

An open collection of methodologies to help with successful training of large language models.
Python
385
star
55

tflite-android-transformers

DistilBERT / GPT-2 for on-device inference thanks to TensorFlow Lite with Android demo apps
Java
368
star
56

community-events

Place where folks can contribute to πŸ€— community events
Jupyter Notebook
368
star
57

nn_pruning

Prune a model while finetuning or training.
Jupyter Notebook
360
star
58

swift-chat

Mac app to demonstrate swift-transformers
Swift
346
star
59

speechbox

Python
328
star
60

100-times-faster-nlp

πŸš€100 Times Faster Natural Language Processing in Python - iPython notebook
HTML
325
star
61

education-toolkit

Educational materials for universities
Jupyter Notebook
307
star
62

optimum-intel

πŸ€— Optimum Intel: Accelerate inference with Intel optimization tools
Jupyter Notebook
295
star
63

controlnet_aux

Python
291
star
64

unity-api

C#
284
star
65

open-muse

Open reproduction of MUSE for fast text2image generation.
Python
284
star
66

datablations

Scaling Data-Constrained Language Models
Jupyter Notebook
270
star
67

audio-transformers-course

The Hugging Face Course on Transformers for Audio
MDX
247
star
68

hub-docs

Docs of the Hugging Face Hub
221
star
69

text-clustering

Easily embed, cluster and semantically label text datasets
Python
214
star
70

lighteval

LightEval is a lightweight LLM evaluation suite that Hugging Face has been using internally with the recently released LLM data processing library datatrove and LLM training library nanotron.
Python
208
star
71

quanto

A pytorch Quantization Toolkit
Python
201
star
72

simulate

🎒 Creating and sharing simulation environments for embodied and synthetic data research
Python
185
star
73

ratchet

A cross-platform browser ML framework.
Rust
184
star
74

hf_transfer

Rust
181
star
75

instruction-tuned-sd

Code for instruction-tuning Stable Diffusion.
Python
167
star
76

olm-datasets

Pipeline for pulling and processing online language model pretraining data from the web
Python
166
star
77

optimum-neuron

Easy, fast and very cheap training and inference on AWS Trainium and Inferentia chips.
Jupyter Notebook
163
star
78

optimum-benchmark

A unified multi-backend utility for benchmarking Transformers and Diffusers with full support of Optimum's hardware optimizations & quantization schemes.
Python
163
star
79

workshops

Materials for workshops on the Hugging Face ecosystem
Jupyter Notebook
143
star
80

OBELICS

Code used for the creation of OBELICS, an open, massive and curated collection of interleaved image-text web documents, containing 141M documents, 115B text tokens and 353M images.
Python
142
star
81

cosmopedia

Python
138
star
82

api-inference-community

Python
131
star
83

diffusion-fast

Faster generation with text-to-image diffusion models.
Python
127
star
84

sharp-transformers

A Unity plugin for using Transformers models in Unity.
C#
104
star
85

llm-swarm

Manage scalable open LLM inference endpoints in Slurm clusters
Python
104
star
86

competitions

Python
98
star
87

optimum-habana

Easy and lightning fast training of πŸ€— Transformers on Habana Gaudi processor (HPU)
Python
98
star
88

hf-hub

Rust client for the huggingface hub aiming for minimal subset of features over `huggingface-hub` python package
Rust
93
star
89

olm-training

Repo for training MLMs, CLMs, or T5-type models on the OLM pretraining data, but it should work with any hugging face text dataset.
Python
87
star
90

fuego

[WIP] A πŸ”₯ interface for running code in the cloud
Python
84
star
91

tune

Python
83
star
92

datasets-viewer

Viewer for the πŸ€— datasets library.
Python
82
star
93

optimum-graphcore

Blazing fast training of πŸ€— Transformers on Graphcore IPUs
Python
78
star
94

frp

FRP Fork
Go
73
star
95

paper-style-guide

71
star
96

block_movement_pruning

Block Sparse movement pruning
Python
70
star
97

data-measurements-tool

Developing tools to automatically analyze datasets
Python
69
star
98

amused

Python
68
star
99

doc-builder

The package used to build the documentation of our Hugging Face repos
Python
67
star
100

hfapi

Simple Python client for the Hugging Face Inference API
Python
66
star