• Stars
    star
    131
  • Rank 265,167 (Top 6 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 3 years 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

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
121,026
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

text-generation-inference

Large Language Model Text Generation Inference
Python
7,240
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
6,878
star
11

chat-ui

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

deep-rl-class

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

alignment-handbook

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

diffusion-models-class

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

notebooks

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

distil-whisper

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

neuralcoref

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

autotrain-advanced

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

knockknock

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

safetensors

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

swift-coreml-diffusers

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

optimum

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

awesome-papers

Papers & presentation materials from Hugging Face's internal science day
1,996
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

blog

Public repo for HF blog posts
Jupyter Notebook
1,685
star
29

transfer-learning-conv-ai

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

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
31

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
32

huggingface_hub

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

Mongoku

πŸ”₯The Web-scale GUI for MongoDB
TypeScript
1,277
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

huggingface.js

Utilities to use the Hugging Face Hub API
TypeScript
1,161
star
36

gsplat.js

JavaScript Gaussian Splatting library.
TypeScript
1,114
star
37

llm-vscode

LLM powered development for VSCode
TypeScript
1,060
star
38

datatrove

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

pytorch-pretrained-BigGAN

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

torchMoji

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

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
42

awesome-huggingface

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

optimum-nvidia

Python
680
star
44

nanotron

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

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
46

transformers-bloom-inference

Fast Inference Solutions for BLOOM
Python
546
star
47

pytorch_block_sparse

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

exporters

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

llm.nvim

LLM powered development for Neovim
Lua
507
star
50

cookbook

Open-source AI cookbook
Jupyter Notebook
471
star
51

node-question-answering

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

swift-transformers

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

large_language_model_training_playbook

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

llm-ls

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

llm_training_handbook

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

tflite-android-transformers

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

community-events

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

nn_pruning

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

swift-chat

Mac app to demonstrate swift-transformers
Swift
346
star
60

speechbox

Python
328
star
61

100-times-faster-nlp

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

education-toolkit

Educational materials for universities
Jupyter Notebook
307
star
63

optimum-intel

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

controlnet_aux

Python
291
star
65

unity-api

C#
284
star
66

open-muse

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

datablations

Scaling Data-Constrained Language Models
Jupyter Notebook
270
star
68

audio-transformers-course

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

hub-docs

Docs of the Hugging Face Hub
221
star
70

text-clustering

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

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
72

quanto

A pytorch Quantization Toolkit
Python
201
star
73

simulate

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

ratchet

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

hf_transfer

Rust
181
star
76

instruction-tuned-sd

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

olm-datasets

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

optimum-neuron

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

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
80

workshops

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

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
82

cosmopedia

Python
138
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