• Stars
    star
    145
  • Rank 249,882 (Top 5 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 3 years ago
  • Updated about 2 months ago

Reviews

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

Repository Details

This repositories enable third-party libraries integrated with huggingface_hub to create their own docker so that the widgets on the hub can work as the transformers one do.

The hardware to run the API will be provided by Hugging Face for now.

The docker_images/common folder is intended to be a starter point for all new libs that want to be integrated.

Adding a new container from a new lib.

  1. Copy the docker_images/common folder into your library's name docker_images/example.

  2. Edit:

    • docker_images/example/requirements.txt
    • docker_images/example/app/main.py
    • docker_images/example/app/pipelines/{task_name}.py

    to implement the desired functionality. All required code is marked with IMPLEMENT_THIS markup.

  3. Remove:

    • Any pipeline files in docker_images/example/app/pipelines/ that are not used.
    • Any tests associated with deleted pipelines in docker_images/example/tests.
    • Any imports of the pipelines you deleted from docker_images/example/app/pipelines/__init__.py
  4. Feel free to customize anything required by your lib everywhere you want. The only real requirements, are to honor the HTTP endpoints, in the same fashion as the common folder for all your supported tasks.

  5. Edit example/tests/test_api.py to add TESTABLE_MODELS.

  6. Pass the test suite pytest -sv --rootdir docker_images/example/ docker_images/example/

  7. Submit your PR and enjoy !

Going the full way

Doing the first 7 steps is good enough to get started, however in the process you can anticipate some problems corrections early on. Maintainers will help you along the way if you don't feel confident to follow those steps yourself

  1. Test your creation within a docker
./manage.py docker MY_MODEL

should work and responds on port 8000. curl -X POST -d "test" http://localhost:8000 for instance if the pipeline deals with simple text.

If it doesn't work out of the box and/or docker is slow for some reason you can test locally (using your local python environment) with :

./manage.py start MY_MODEL

  1. Test your docker uses cache properly.

When doing subsequent docker launch with the same model_id, the docker should start up very fast and not redownload the whole model file. If you see the model/repo being downloaded over and over, it means the cache is not being used correctly. You can edit the docker_images/{framework}/Dockerfile and add an environment variable (by default it assumes HUGGINGFACE_HUB_CACHE), or your code directly to put the model files in the /data folder.

  1. Add a docker test.

Edit the tests/test_dockers.py file to add a new test with your new framework in it (def test_{framework}(self): for instance). As a basic you should have 1 line per task in this test function with a real working model on the hub. Those tests are relatively slow but will check automatically that correct errors are replied by your API and that the cache works properly. To run those tests your can simply do:

RUN_DOCKER_TESTS=1 pytest -sv tests/test_dockers.py::DockerImageTests::test_{framework}

Modifying files within api-inference-community/{routes,validation,..}.py.

If you ever come across a bug within api-inference-community/ package or want to update it the development process is slightly more involved.

  • First, make sure you need to change this package, each framework is very autonomous so if your code can get away by being standalone go that way first as it's much simpler.
  • If you can make the change only in api-inference-community without depending on it that's also a great option. Make sure to add the proper tests to your PR.
  • Finally, the best way to go is to develop locally using manage.py command:
  • Do the necessary modifications within api-inference-community first.
  • Install it locally in your environment with pip install -e .
  • Install your package dependencies locally.
  • Run your webserver locally: ./manage.py start --framework example --task audio-source-separation --model-id MY_MODEL
  • When everything is working, you will need to split your PR in two, 1 for the api-inference-community part. The second one will be for your package specific modifications and will only land once the api-inference-community tag has landed.
  • This workflow is still work in progress, don't hesitate to ask questions to maintainers.

Another similar command ./manage.py docker --framework example --task audio-source-separation --model-id MY_MODEL Will launch the server, but this time in a protected, controlled docker environment making sure the behavior will be exactly the one in the API.

Available tasks

  • Automatic speech recognition: Input is a file, output is a dict of understood words being said within the file
  • Text generation: Input is a text, output is a dict of generated text
  • Image recognition: Input is an image, output is a dict of generated text
  • Question answering: Input is a question + some context, output is a dict containing necessary information to locate the answer to the question within the context.
  • Audio source separation: Input is some audio, and the output is n audio files that sum up to the original audio but contain individual sources of sound (either speakers or instruments for instant).
  • Token classification: Input is some text, and the output is a list of entities mentioned in the text. Entities can be anything remarkable like locations, organisations, persons, times etc...
  • Text to speech: Input is some text, and the output is an audio file saying the text...
  • Sentence Similarity: Input is some sentence and a list of reference sentences, and the list of similarity scores.

More Repositories

1

transformers

๐Ÿค— Transformers: State-of-the-art Machine Learning for Pytorch, TensorFlow, and JAX.
Python
128,386
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 and FLAX.
Python
23,394
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
14,585
star
6

candle

Minimalist ML framework for Rust
Rust
14,110
star
7

tokenizers

๐Ÿ’ฅ Fast State-of-the-Art Tokenizers optimized for Research and Production
Rust
8,645
star
8

trl

Train transformer language models with reinforcement learning.
Python
8,483
star
9

text-generation-inference

Large Language Model Text Generation Inference
Python
8,197
star
10

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
7,306
star
11

chat-ui

Open source codebase powering the HuggingChat app
TypeScript
6,584
star
12

lerobot

๐Ÿค— LeRobot: End-to-end Learning for Real-World Robotics in Pytorch
Python
4,284
star
13

alignment-handbook

Robust recipes to align language models with human and AI preferences
Python
4,118
star
14

deep-rl-class

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

notebooks

Notebooks using the Hugging Face libraries ๐Ÿค—
Jupyter Notebook
3,329
star
16

distil-whisper

Distilled variant of Whisper for speech recognition. 6x faster, 50% smaller, within 1% word error rate.
Python
3,286
star
17

autotrain-advanced

๐Ÿค— AutoTrain Advanced
Python
3,283
star
18

diffusion-models-class

Materials for the Hugging Face Diffusion Models Course
Jupyter Notebook
3,280
star
19

neuralcoref

โœจFast Coreference Resolution in spaCy with Neural Networks
C
2,819
star
20

parler-tts

Inference and training library for high-quality TTS models.
Python
2,735
star
21

knockknock

๐ŸšชโœŠKnock Knock: Get notified when your training ends with only two additional lines of code
Python
2,682
star
22

safetensors

Simple, safe way to store and distribute tensors
Python
2,572
star
23

swift-coreml-diffusers

Swift app demonstrating Core ML Stable Diffusion
Swift
2,406
star
24

optimum

๐Ÿš€ Accelerate training and inference of ๐Ÿค— Transformers and ๐Ÿค— Diffusers with easy to use hardware optimization tools
Python
2,290
star
25

text-embeddings-inference

A blazing fast inference solution for text embeddings models
Rust
2,201
star
26

blog

Public repo for HF blog posts
Jupyter Notebook
2,136
star
27

setfit

Efficient few-shot learning with Sentence Transformers
Jupyter Notebook
2,060
star
28

course

The Hugging Face course on Transformers
MDX
2,005
star
29

awesome-papers

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

evaluate

๐Ÿค— Evaluate: A library for easily evaluating machine learning models and datasets.
Python
1,825
star
31

datatrove

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

transfer-learning-conv-ai

๐Ÿฆ„ State-of-the-Art Conversational AI with Transfer Learning
Python
1,654
star
33

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
34

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
35

cookbook

Open-source AI cookbook
Jupyter Notebook
1,416
star
36

huggingface_hub

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

Mongoku

๐Ÿ”ฅThe Web-scale GUI for MongoDB
TypeScript
1,300
star
38

huggingface.js

Utilities to use the Hugging Face Hub API
TypeScript
1,277
star
39

gsplat.js

JavaScript Gaussian Splatting library.
TypeScript
1,233
star
40

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,185
star
41

llm-vscode

LLM powered development for VSCode
TypeScript
1,160
star
42

pytorch-pretrained-BigGAN

๐Ÿฆ‹A PyTorch implementation of BigGAN with pretrained weights and conversion scripts.
Python
986
star
43

nanotron

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

torchMoji

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

optimum-nvidia

Python
839
star
46

awesome-huggingface

๐Ÿค— A list of wonderful open-source projects & applications integrated with Hugging Face libraries.
821
star
47

naacl_transfer_learning_tutorial

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

dataset-viewer

Lightweight web API for visualizing and exploring any dataset - computer vision, speech, text, and tabular - stored on the Hugging Face Hub
Python
640
star
49

optimum-quanto

A pytorch quantization backend for optimum
Python
620
star
50

llm.nvim

LLM powered development for Neovim
Lua
607
star
51

exporters

Export Hugging Face models to Core ML and TensorFlow Lite
Python
559
star
52

transformers-bloom-inference

Fast Inference Solutions for BLOOM
Python
551
star
53

swift-transformers

Swift Package to implement a transformers-like API in Swift
Swift
530
star
54

pytorch_block_sparse

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

llm-ls

LSP server leveraging LLMs for code completion (and more?)
Rust
513
star
56

node-question-answering

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

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
442
star
58

large_language_model_training_playbook

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

ratchet

A cross-platform browser ML framework.
Rust
424
star
60

llm_training_handbook

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

swift-chat

Mac app to demonstrate swift-transformers
Swift
392
star
62

tflite-android-transformers

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

community-events

Place where folks can contribute to ๐Ÿค— community events
Jupyter Notebook
368
star
64

text-clustering

Easily embed, cluster and semantically label text datasets
Python
367
star
65

optimum-intel

๐Ÿค— Optimum Intel: Accelerate inference with Intel optimization tools
Jupyter Notebook
361
star
66

nn_pruning

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

speechbox

Python
339
star
68

controlnet_aux

Python
326
star
69

100-times-faster-nlp

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

education-toolkit

Educational materials for universities
Jupyter Notebook
320
star
71

unity-api

C#
302
star
72

datablations

Scaling Data-Constrained Language Models
Jupyter Notebook
296
star
73

open-muse

Open reproduction of MUSE for fast text2image generation.
Python
293
star
74

cosmopedia

Python
285
star
75

audio-transformers-course

The Hugging Face Course on Transformers for Audio
MDX
279
star
76

hf_transfer

Rust
242
star
77

hub-docs

Docs of the Hugging Face Hub
221
star
78

optimum-benchmark

๐Ÿ‹๏ธ A unified multi-backend utility for benchmarking Transformers, Timm, PEFT, Diffusers and Sentence-Transformers with full support of Optimum's hardware optimizations & quantization schemes.
Python
217
star
79

dataspeech

Python
207
star
80

diarizers

Python
206
star
81

simulate

๐ŸŽข Creating and sharing simulation environments for embodied and synthetic data research
Python
185
star
82

instruction-tuned-sd

Code for instruction-tuning Stable Diffusion.
Python
181
star
83

optimum-neuron

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

llm-swarm

Manage scalable open LLM inference endpoints in Slurm clusters
Python
176
star
85

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
170
star
86

olm-datasets

Pipeline for pulling and processing online language model pretraining data from the web
Python
170
star
87

data-is-better-together

Let's build better datasets, together!
Jupyter Notebook
162
star
88

diffusion-fast

Faster generation with text-to-image diffusion models.
Python
157
star
89

workshops

Materials for workshops on the Hugging Face ecosystem
Jupyter Notebook
146
star
90

jat

Distributed online training of a general multi-task Deep RL Agent
Python
136
star
91

chug

Minimal sharded dataset loaders, decoders, and utils for multi-modal document, image, and text datasets.
Python
136
star
92

sharp-transformers

A Unity plugin for using Transformers models in Unity.
C#
129
star
93

optimum-habana

Easy and lightning fast training of ๐Ÿค— Transformers on Habana Gaudi processor (HPU)
Python
114
star
94

hf-hub

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

competitions

Python
104
star
96

frp

FRP Fork
Go
102
star
97

coreml-examples

Swift Core ML Examples
Swift
98
star
98

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
92
star
99

fuego

[WIP] A ๐Ÿ”ฅ interface for running code in the cloud
Python
85
star
100

tune

Python
83
star