• Stars
    star
    459
  • Rank 92,133 (Top 2 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created over 4 years ago
  • Updated 10 months ago

Reviews

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

Repository Details

Fast and production-ready question answering in Node.js

Question Answering for Node.js

npm version

Production-ready Question Answering directly in Node.js, with only 3 lines of code!

This package leverages the power of the πŸ€—Tokenizers library (built with Rust) to process the input text. It then uses TensorFlow.js to run the DistilBERT-cased model fine-tuned for Question Answering (87.1 F1 score on SQuAD v1.1 dev set, compared to 88.7 for BERT-base-cased). DistilBERT is used by default, but you can use other models available in the πŸ€—Transformers library in one additional line of code!

It can run models in SavedModel and TFJS formats locally, as well as remote models thanks to TensorFlow Serving.

Installation

npm install question-answering@latest

Quickstart

The following example will automatically download the default DistilBERT model in SavedModel format if not already present, along with the required vocabulary / tokenizer files. It will then run the model and return the answer to the question.

import { QAClient } from "question-answering"; // When using Typescript or Babel
// const { QAClient } = require("question-answering"); // When using vanilla JS

const text = `
  Super Bowl 50 was an American football game to determine the champion of the National Football League (NFL) for the 2015 season.
  The American Football Conference (AFC) champion Denver Broncos defeated the National Football Conference (NFC) champion Carolina Panthers 24–10 to earn their third Super Bowl title. The game was played on February 7, 2016, at Levi's Stadium in the San Francisco Bay Area at Santa Clara, California.
  As this was the 50th Super Bowl, the league emphasized the "golden anniversary" with various gold-themed initiatives, as well as temporarily suspending the tradition of naming each Super Bowl game with Roman numerals (under which the game would have been known as "Super Bowl L"), so that the logo could prominently feature the Arabic numerals 50.
`;

const question = "Who won the Super Bowl?";

const qaClient = await QAClient.fromOptions();
const answer = await qaClient.predict(question, text);

console.log(answer); // { text: 'Denver Broncos', score: 0.3 }

You can also download the model and vocabulary / tokenizer files separately by using the CLI.

Advanced

Using another model

The above example internally makes use of the default DistilBERT-cased model in the SavedModel format. The library is also compatible with any other DistilBERT-based model, as well as any BERT-based and RoBERTa-based models, both in SavedModel and TFJS formats. The following models are available in SavedModel format from the Hugging Face model hub thanks to the amazing NLP community πŸ€—:

To specify a model to use with the library, you need to instantiate a model class that you'll then pass to the QAClient:

import { initModel, QAClient } from "question-answering"; // When using Typescript or Babel
// const { initModel, QAClient } = require("question-answering"); // When using vanilla JS

const text = ...
const question = ...

const model = await initModel({ name: "deepset/roberta-base-squad2" });
const qaClient = await QAClient.fromOptions({ model });
const answer = await qaClient.predict(question, text);

console.log(answer); // { text: 'Denver Broncos', score: 0.46 }

Note that using a model hosted on Hugging Face is not a requirement: you can use any compatible model (including any from the HF hub not already available in SavedModel or TFJS format that you converted yourself) by passing the correct local path for the model and vocabulary files in the options.

Using models in TFJS format

To use a TFJS model, you simply need to pass tfjs to the runtime param of initModel (defaults to saved_model):

const model = await initModel({ name: "distilbert-base-cased-distilled-squad", runtime: RuntimeType.TFJS });

As with any SavedModel hosted in the HF model hub, the required files for the TFJS models will be automatically downloaded the first time. You can also download them manually using the CLI.

Using remote models with TensorFlow Serving

If your model is in the SavedModel format, you may prefer to host it on a dedicated server. Here is a simple example using Docker locally:

# Inside our project root, download DistilBERT-cased to its default `.models` location
npx question-answering download

# Download the TensorFlow Serving Docker image
docker pull tensorflow/serving

# Start TensorFlow Serving container and open the REST API port.
# Notice that in the `target` path we add a `/1`:
# this is required by TFX which is expecting the models to be "versioned"
docker run -t --rm -p 8501:8501 \
    --mount type=bind,source="$(pwd)/.models/distilbert-cased/",target="/models/cased/1" \
    -e MODEL_NAME=cased \
    tensorflow/serving &

In the code, you just have to pass remote as runtime and the server endpoint as path:

const model = await initModel({
  name: "distilbert-base-cased-distilled-squad",
  path: "http://localhost:8501/v1/models/cased",
  runtime: RuntimeType.Remote
});
const qaClient = await QAClient.fromOptions({ model });

Downloading models with the CLI

You can choose to download the model and associated vocab file(s) manually using the CLI. For example to download the deepset/roberta-base-squad2 model:

npx question-answering download deepset/roberta-base-squad2

By default, the files are downloaded inside a .models directory at the root of your project; you can provide a custom directory by using the --dir option of the CLI. You can also use --format tfjs to download a model in TFJS format (if available). To check all the options of the CLI: npx question-answering download --help.

Using a custom tokenizer

The QAClient.fromOptions params object has a tokenizer field which can either be a set of options relative to the tokenizer files, or an instance of a class extending the abstract Tokenizer class. To extend this class, you can create your own or, if you simply need to adjust some options, you can import and use the provided initTokenizer method, which will instantiate such a class for you.

Performances

Thanks to the native execution of SavedModel format in TFJS, the performance of such models is similar to the one using TensorFlow in Python.

Specifically, here are the results of a benchmark using question-answering with the default DistilBERT-cased model:

  • Running entirely locally (both SavedModel and TFJS formats)
  • Using a (pseudo) remote model server (i.e. local Docker with TensorFlow Serving running the SavedModel format)
  • Using the Question Answering pipeline in the πŸ€—Transformers library.

QA benchmark chart Shorts texts are texts between 500 and 1000 characters, long texts are between 4000 and 5000 characters. You can check the question-answering benchmark script here (the transformers one is equivalent). Benchmark run on a standard 2019 MacBook Pro running on macOS 10.15.2.

Troubleshooting

Errors when using Typescript

There is a known incompatibility in the TFJS library with some types. If you encounter errors when building your project, make sure to pass the --skipLibCheck flag when using the Typescript CLI, or to add skipLibCheck: true to your tsconfig.json file under compilerOptions. See here for more information.

Tensor not referenced when running SavedModel

Due to a bug in TFJS, the use of @tensorflow/tfjs-node to load or execute SavedModel models independently from the library is not recommended for now, since it could overwrite the TF backend used internally by the library. In the case where you would have to do so, make sure to require both question-answering and @tensorflow/tfjs-node in your code before making any use of either of them.

More Repositories

1

transformers

πŸ€— Transformers: State-of-the-art Machine Learning for Pytorch, TensorFlow, and JAX.
Python
125,320
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
22,776
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,007
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
8,181
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
7,008
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

autotrain-advanced

πŸ€— AutoTrain Advanced
Python
3,283
star
15

diffusion-models-class

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

notebooks

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

distil-whisper

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

neuralcoref

✨Fast Coreference Resolution in spaCy with Neural Networks
C
2,806
star
19

knockknock

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

swift-coreml-diffusers

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

safetensors

Simple, safe way to store and distribute tensors
Python
2,347
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

blog

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

setfit

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

text-embeddings-inference

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

course

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

evaluate

πŸ€— Evaluate: A library for easily evaluating machine learning models and datasets.
Python
1,825
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

cookbook

Open-source AI cookbook
Jupyter Notebook
1,357
star
33

huggingface_hub

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

Mongoku

πŸ”₯The Web-scale GUI for MongoDB
TypeScript
1,289
star
35

huggingface.js

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

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
37

gsplat.js

JavaScript Gaussian Splatting library.
TypeScript
1,114
star
38

llm-vscode

LLM powered development for VSCode
TypeScript
1,060
star
39

datatrove

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

pytorch-pretrained-BigGAN

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

torchMoji

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

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
43

awesome-huggingface

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

optimum-nvidia

Python
680
star
45

nanotron

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

dataset-viewer

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

transformers-bloom-inference

Fast Inference Solutions for BLOOM
Python
546
star
48

exporters

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

pytorch_block_sparse

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

llm.nvim

LLM powered development for Neovim
Lua
507
star
51

swift-transformers

Swift Package to implement a transformers-like API in Swift
Swift
482
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

swift-chat

Mac app to demonstrate swift-transformers
Swift
375
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

text-clustering

Easily embed, cluster and semantically label text datasets
Python
335
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

controlnet_aux

Python
306
star
64

optimum-intel

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

datablations

Scaling Data-Constrained Language Models
Jupyter Notebook
293
star
66

unity-api

C#
284
star
67

open-muse

Open reproduction of MUSE for fast text2image generation.
Python
284
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

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

optimum-benchmark

A unified multi-backend utility for benchmarking Transformers, Timm, Diffusers and Sentence-Transformers with full support of Optimum's hardware optimizations & quantization schemes.
Python
183
star
75

hf_transfer

Rust
181
star
76

olm-datasets

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

instruction-tuned-sd

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

optimum-neuron

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

llm-swarm

Manage scalable open LLM inference endpoints in Slurm clusters
Python
156
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
147
star
81

workshops

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

cosmopedia

Python
138
star
83

api-inference-community

Python
131
star
84

diffusion-fast

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

diarizers

Python
106
star
86

optimum-habana

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

sharp-transformers

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

competitions

Python
101
star
89

hf-hub

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

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
91

fuego

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

tune

Python
83
star
93

datasets-viewer

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

optimum-graphcore

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

frp

FRP Fork
Go
73
star
96

paper-style-guide

71
star
97

block_movement_pruning

Block Sparse movement pruning
Python
70
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

data-measurements-tool

Developing tools to automatically analyze datasets
Python
67
star