facebookresearch/fastText facebookresearch/fastText

  • Stars
    star
    24,973
  • Rank 790 (Top 0.02 %)
  • Language
    HTML
  • License
    MIT License
  • Created almost 8 years ago
  • Updated 8 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
facebookresearch/fastText
github

facebookresearch

Reviews

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

Repository Details

Library for fast text representation and classification.

fastText

fastText is a library for efficient learning of word representations and sentence classification.

CircleCI

Table of contents

Resources

Models

Supplementary data

FAQ

You can find answers to frequently asked questions on our website.

Cheatsheet

We also provide a cheatsheet full of useful one-liners.

Requirements

We are continuously building and testing our library, CLI and Python bindings under various docker images using circleci.

Generally, fastText builds on modern Mac OS and Linux distributions. Since it uses some C++11 features, it requires a compiler with good C++11 support. These include :

  • (g++-4.7.2 or newer) or (clang-3.3 or newer)

Compilation is carried out using a Makefile, so you will need to have a working make. If you want to use cmake you need at least version 2.8.9.

One of the oldest distributions we successfully built and tested the CLI under is Debian jessie.

For the word-similarity evaluation script you will need:

  • Python 2.6 or newer
  • NumPy & SciPy

For the python bindings (see the subdirectory python) you will need:

  • Python version 2.7 or >=3.4
  • NumPy & SciPy
  • pybind11

One of the oldest distributions we successfully built and tested the Python bindings under is Debian jessie.

If these requirements make it impossible for you to use fastText, please open an issue and we will try to accommodate you.

Building fastText

We discuss building the latest stable version of fastText.

Getting the source code

You can find our latest stable release in the usual place.

There is also the master branch that contains all of our most recent work, but comes along with all the usual caveats of an unstable branch. You might want to use this if you are a developer or power-user.

Building fastText using make (preferred)

$ wget https://github.com/facebookresearch/fastText/archive/v0.9.2.zip
$ unzip v0.9.2.zip
$ cd fastText-0.9.2
$ make

This will produce object files for all the classes as well as the main binary fasttext. If you do not plan on using the default system-wide compiler, update the two macros defined at the beginning of the Makefile (CC and INCLUDES).

Building fastText using cmake

For now this is not part of a release, so you will need to clone the master branch.

$ git clone https://github.com/facebookresearch/fastText.git
$ cd fastText
$ mkdir build && cd build && cmake ..
$ make && make install

This will create the fasttext binary and also all relevant libraries (shared, static, PIC).

Building fastText for Python

For now this is not part of a release, so you will need to clone the master branch.

$ git clone https://github.com/facebookresearch/fastText.git
$ cd fastText
$ pip install .

For further information and introduction see python/README.md

Example use cases

This library has two main use cases: word representation learning and text classification. These were described in the two papers 1 and 2.

Word representation learning

In order to learn word vectors, as described in 1, do:

$ ./fasttext skipgram -input data.txt -output model

where data.txt is a training file containing UTF-8 encoded text. By default the word vectors will take into account character n-grams from 3 to 6 characters. At the end of optimization the program will save two files: model.bin and model.vec. model.vec is a text file containing the word vectors, one per line. model.bin is a binary file containing the parameters of the model along with the dictionary and all hyper parameters. The binary file can be used later to compute word vectors or to restart the optimization.

Obtaining word vectors for out-of-vocabulary words

The previously trained model can be used to compute word vectors for out-of-vocabulary words. Provided you have a text file queries.txt containing words for which you want to compute vectors, use the following command:

$ ./fasttext print-word-vectors model.bin < queries.txt

This will output word vectors to the standard output, one vector per line. This can also be used with pipes:

$ cat queries.txt | ./fasttext print-word-vectors model.bin

See the provided scripts for an example. For instance, running:

$ ./word-vector-example.sh

will compile the code, download data, compute word vectors and evaluate them on the rare words similarity dataset RW [Thang et al. 2013].

Text classification

This library can also be used to train supervised text classifiers, for instance for sentiment analysis. In order to train a text classifier using the method described in 2, use:

$ ./fasttext supervised -input train.txt -output model

where train.txt is a text file containing a training sentence per line along with the labels. By default, we assume that labels are words that are prefixed by the string __label__. This will output two files: model.bin and model.vec. Once the model was trained, you can evaluate it by computing the precision and recall at k (P@k and R@k) on a test set using:

$ ./fasttext test model.bin test.txt k

The argument k is optional, and is equal to 1 by default.

In order to obtain the k most likely labels for a piece of text, use:

$ ./fasttext predict model.bin test.txt k

or use predict-prob to also get the probability for each label

$ ./fasttext predict-prob model.bin test.txt k

where test.txt contains a piece of text to classify per line. Doing so will print to the standard output the k most likely labels for each line. The argument k is optional, and equal to 1 by default. See classification-example.sh for an example use case. In order to reproduce results from the paper 2, run classification-results.sh, this will download all the datasets and reproduce the results from Table 1.

If you want to compute vector representations of sentences or paragraphs, please use:

$ ./fasttext print-sentence-vectors model.bin < text.txt

This assumes that the text.txt file contains the paragraphs that you want to get vectors for. The program will output one vector representation per line in the file.

You can also quantize a supervised model to reduce its memory usage with the following command:

$ ./fasttext quantize -output model

This will create a .ftz file with a smaller memory footprint. All the standard functionality, like test or predict work the same way on the quantized models:

$ ./fasttext test model.ftz test.txt

The quantization procedure follows the steps described in 3. You can run the script quantization-example.sh for an example.

Full documentation

Invoke a command without arguments to list available arguments and their default values:

$ ./fasttext supervised
Empty input or output path.

The following arguments are mandatory:
  -input              training file path
  -output             output file path

The following arguments are optional:
  -verbose            verbosity level [2]

The following arguments for the dictionary are optional:
  -minCount           minimal number of word occurrences [1]
  -minCountLabel      minimal number of label occurrences [0]
  -wordNgrams         max length of word ngram [1]
  -bucket             number of buckets [2000000]
  -minn               min length of char ngram [0]
  -maxn               max length of char ngram [0]
  -t                  sampling threshold [0.0001]
  -label              labels prefix [__label__]

The following arguments for training are optional:
  -lr                 learning rate [0.1]
  -lrUpdateRate       change the rate of updates for the learning rate [100]
  -dim                size of word vectors [100]
  -ws                 size of the context window [5]
  -epoch              number of epochs [5]
  -neg                number of negatives sampled [5]
  -loss               loss function {ns, hs, softmax} [softmax]
  -thread             number of threads [12]
  -pretrainedVectors  pretrained word vectors for supervised learning []
  -saveOutput         whether output params should be saved [0]

The following arguments for quantization are optional:
  -cutoff             number of words and ngrams to retain [0]
  -retrain            finetune embeddings if a cutoff is applied [0]
  -qnorm              quantizing the norm separately [0]
  -qout               quantizing the classifier [0]
  -dsub               size of each sub-vector [2]

Defaults may vary by mode. (Word-representation modes skipgram and cbow use a default -minCount of 5.)

References

Please cite 1 if using this code for learning word representations or 2 if using for text classification.

Enriching Word Vectors with Subword Information

[1] P. Bojanowski*, E. Grave*, A. Joulin, T. Mikolov, Enriching Word Vectors with Subword Information

@article{bojanowski2017enriching,
  title={Enriching Word Vectors with Subword Information},
  author={Bojanowski, Piotr and Grave, Edouard and Joulin, Armand and Mikolov, Tomas},
  journal={Transactions of the Association for Computational Linguistics},
  volume={5},
  year={2017},
  issn={2307-387X},
  pages={135--146}
}

Bag of Tricks for Efficient Text Classification

[2] A. Joulin, E. Grave, P. Bojanowski, T. Mikolov, Bag of Tricks for Efficient Text Classification

@InProceedings{joulin2017bag,
  title={Bag of Tricks for Efficient Text Classification},
  author={Joulin, Armand and Grave, Edouard and Bojanowski, Piotr and Mikolov, Tomas},
  booktitle={Proceedings of the 15th Conference of the European Chapter of the Association for Computational Linguistics: Volume 2, Short Papers},
  month={April},
  year={2017},
  publisher={Association for Computational Linguistics},
  pages={427--431},
}

FastText.zip: Compressing text classification models

[3] A. Joulin, E. Grave, P. Bojanowski, M. Douze, H. Jรฉgou, T. Mikolov, FastText.zip: Compressing text classification models

@article{joulin2016fasttext,
  title={FastText.zip: Compressing text classification models},
  author={Joulin, Armand and Grave, Edouard and Bojanowski, Piotr and Douze, Matthijs and J{\'e}gou, H{\'e}rve and Mikolov, Tomas},
  journal={arXiv preprint arXiv:1612.03651},
  year={2016}
}

(* These authors contributed equally.)

Join the fastText community

See the CONTRIBUTING file for information about how to help out.

License

fastText is MIT-licensed.

More Repositories

1

llama

Inference code for LLaMA models
Python
44,989
star
2

segment-anything

The repository provides code for running inference with the SegmentAnything Model (SAM), links for downloading the trained model checkpoints, and example notebooks that show how to use the model.
Jupyter Notebook
42,134
star
3

Detectron

FAIR's research platform for object detection research, implementing popular algorithms like Mask R-CNN and RetinaNet.
Python
25,771
star
4

fairseq

Facebook AI Research Sequence-to-Sequence Toolkit written in Python.
Python
25,718
star
5

detectron2

Detectron2 is a platform for object detection, segmentation and other visual recognition tasks.
Python
25,567
star
6

faiss

A library for efficient similarity search and clustering of dense vectors.
C++
24,035
star
7

audiocraft

Audiocraft is a library for audio processing and generation with deep learning. It features the state-of-the-art EnCodec audio compressor / tokenizer, along with MusicGen, a simple and controllable music generation LM with textual and melodic conditioning.
Python
18,693
star
8

codellama

Inference code for CodeLlama models
Python
13,303
star
9

detr

End-to-End Object Detection with Transformers
Python
11,076
star
10

ParlAI

A framework for training and evaluating AI models on a variety of openly available dialogue datasets.
Python
10,085
star
11

seamless_communication

Foundational Models for State-of-the-Art Speech and Text Translation
Jupyter Notebook
9,653
star
12

maskrcnn-benchmark

Fast, modular reference implementation of Instance Segmentation and Object Detection algorithms in PyTorch.
Python
9,104
star
13

pifuhd

High-Resolution 3D Human Digitization from A Single Image.
Python
8,923
star
14

hydra

Hydra is a framework for elegantly configuring complex applications
Python
8,044
star
15

AnimatedDrawings

Code to accompany "A Method for Animating Children's Drawings of the Human Figure"
Python
8,032
star
16

ImageBind

ImageBind One Embedding Space to Bind Them All
Python
7,630
star
17

nougat

Implementation of Nougat Neural Optical Understanding for Academic Documents
Python
7,568
star
18

llama-recipes

Scripts for fine-tuning Llama2 with composable FSDP & PEFT methods to cover single/multi-node GPUs. Supports default & custom datasets for applications such as summarization & question answering. Supporting a number of candid inference solutions such as HF TGI, VLLM for local or cloud deployment.Demo apps to showcase Llama2 for WhatsApp & Messenger
Jupyter Notebook
7,402
star
19

pytorch3d

PyTorch3D is FAIR's library of reusable components for deep learning with 3D data
Python
7,322
star
20

dinov2

PyTorch code and models for the DINOv2 self-supervised learning method.
Jupyter Notebook
7,278
star
21

DensePose

A real-time approach for mapping all human pixels of 2D RGB images to a 3D surface-based model of the body
Jupyter Notebook
6,547
star
22

pytext

A natural language modeling framework based on PyTorch
Python
6,357
star
23

metaseq

Repo for external large-scale work
Python
5,947
star
24

demucs

Code for the paper Hybrid Spectrogram and Waveform Source Separation
Python
5,886
star
25

SlowFast

PySlowFast: video understanding codebase from FAIR for reproducing state-of-the-art video models.
Python
5,678
star
26

mae

PyTorch implementation of MAE https//arxiv.org/abs/2111.06377
Python
5,495
star
27

mmf

A modular framework for vision & language multimodal research from Facebook AI Research (FAIR)
Python
5,235
star
28

ConvNeXt

Code release for ConvNeXt model
Python
4,971
star
29

dino

PyTorch code for Vision Transformers training with the Self-Supervised learning method DINO
Python
4,830
star
30

DiT

Official PyTorch Implementation of "Scalable Diffusion Models with Transformers"
Python
4,761
star
31

AugLy

A data augmentations library for audio, image, text, and video.
Python
4,739
star
32

Kats

Kats, a kit to analyze time series data, a lightweight, easy-to-use, generalizable, and extendable framework to perform time series analysis, from understanding the key statistics and characteristics, detecting change points and anomalies, to forecasting future trends.
Python
4,387
star
33

DrQA

Reading Wikipedia to Answer Open-Domain Questions
Python
4,374
star
34

xformers

Hackable and optimized Transformers building blocks, supporting a composable construction.
Python
4,191
star
35

moco

PyTorch implementation of MoCo: https://arxiv.org/abs/1911.05722
Python
4,035
star
36

StarSpace

Learning embeddings for classification, retrieval and ranking.
C++
3,856
star
37

fairseq-lua

Facebook AI Research Sequence-to-Sequence Toolkit
Lua
3,765
star
38

nevergrad

A Python toolbox for performing gradient-free optimization
Python
3,446
star
39

deit

Official DeiT repository
Python
3,425
star
40

dlrm

An implementation of a deep learning recommendation model (DLRM)
Python
3,417
star
41

ReAgent

A platform for Reasoning systems (Reinforcement Learning, Contextual Bandits, etc.)
Python
3,395
star
42

LASER

Language-Agnostic SEntence Representations
Python
3,308
star
43

VideoPose3D

Efficient 3D human pose estimation in video using 2D keypoint trajectories
Python
3,294
star
44

PyTorch-BigGraph

Generate embeddings from large-scale graph-structured data.
Python
3,238
star
45

deepmask

Torch implementation of DeepMask and SharpMask
Lua
3,113
star
46

MUSE

A library for Multilingual Unsupervised or Supervised word Embeddings
Python
3,094
star
47

vissl

VISSL is FAIR's library of extensible, modular and scalable components for SOTA Self-Supervised Learning with images.
Jupyter Notebook
3,038
star
48

pytorchvideo

A deep learning library for video understanding research.
Python
2,885
star
49

XLM

PyTorch original implementation of Cross-lingual Language Model Pretraining.
Python
2,763
star
50

hiplot

HiPlot makes understanding high dimensional data easy
TypeScript
2,481
star
51

ijepa

Official codebase for I-JEPA, the Image-based Joint-Embedding Predictive Architecture. First outlined in the CVPR paper, "Self-supervised learning from images with a joint-embedding predictive architecture."
Python
2,381
star
52

fairscale

PyTorch extensions for high performance and large scale training.
Python
2,319
star
53

audio2photoreal

Code and dataset for photorealistic Codec Avatars driven from audio
Python
2,316
star
54

encodec

State-of-the-art deep learning based audio codec supporting both mono 24 kHz audio and stereo 48 kHz audio.
Python
2,313
star
55

habitat-sim

A flexible, high-performance 3D simulator for Embodied AI research.
C++
2,299
star
56

InferSent

InferSent sentence embeddings
Jupyter Notebook
2,264
star
57

co-tracker

CoTracker is a model for tracking any point (pixel) on a video.
Jupyter Notebook
2,240
star
58

Pearl

A Production-ready Reinforcement Learning AI Agent Library brought by the Applied Reinforcement Learning team at Meta.
Python
2,193
star
59

pyrobot

PyRobot: An Open Source Robotics Research Platform
Python
2,109
star
60

darkforestGo

DarkForest, the Facebook Go engine.
C
2,108
star
61

ELF

An End-To-End, Lightweight and Flexible Platform for Game Research
C++
2,089
star
62

pycls

Codebase for Image Classification Research, written in PyTorch.
Python
2,053
star
63

esm

Evolutionary Scale Modeling (esm): Pretrained language models for proteins
Python
2,026
star
64

frankmocap

A Strong and Easy-to-use Single View 3D Hand+Body Pose Estimator
Python
1,972
star
65

video-nonlocal-net

Non-local Neural Networks for Video Classification
Python
1,931
star
66

SentEval

A python tool for evaluating the quality of sentence embeddings.
Python
1,930
star
67

ResNeXt

Implementation of a classification framework from the paper Aggregated Residual Transformations for Deep Neural Networks
Lua
1,863
star
68

SparseConvNet

Submanifold sparse convolutional networks
C++
1,847
star
69

swav

PyTorch implementation of SwAV https//arxiv.org/abs/2006.09882
Python
1,790
star
70

TensorComprehensions

A domain specific language to express machine learning workloads.
C++
1,747
star
71

Mask2Former

Code release for "Masked-attention Mask Transformer for Universal Image Segmentation"
Python
1,638
star
72

habitat-lab

A modular high-level library to train embodied AI agents across a variety of tasks and environments.
Python
1,636
star
73

fvcore

Collection of common code that's shared among different research projects in FAIR computer vision team.
Python
1,623
star
74

TransCoder

Public release of the TransCoder research project https://arxiv.org/pdf/2006.03511.pdf
Python
1,611
star
75

poincare-embeddings

PyTorch implementation of the NIPS-17 paper "Poincarรฉ Embeddings for Learning Hierarchical Representations"
Python
1,587
star
76

votenet

Deep Hough Voting for 3D Object Detection in Point Clouds
Python
1,563
star
77

pytorch_GAN_zoo

A mix of GAN implementations including progressive growing
Python
1,554
star
78

ClassyVision

An end-to-end PyTorch framework for image and video classification
Python
1,552
star
79

deepcluster

Deep Clustering for Unsupervised Learning of Visual Features
Python
1,544
star
80

higher

higher is a pytorch library allowing users to obtain higher order gradients over losses spanning training loops rather than individual training steps.
Python
1,524
star
81

UnsupervisedMT

Phrase-Based & Neural Unsupervised Machine Translation
Python
1,496
star
82

consistent_depth

We estimate dense, flicker-free, geometrically consistent depth from monocular video, for example hand-held cell phone video.
Python
1,479
star
83

Detic

Code release for "Detecting Twenty-thousand Classes using Image-level Supervision".
Python
1,446
star
84

end-to-end-negotiator

Deal or No Deal? End-to-End Learning for Negotiation Dialogues
Python
1,368
star
85

multipathnet

A Torch implementation of the object detection network from "A MultiPath Network for Object Detection" (https://arxiv.org/abs/1604.02135)
Lua
1,349
star
86

CommAI-env

A platform for developing AI systems as described in A Roadmap towards Machine Intelligence - http://arxiv.org/abs/1511.08130
1,324
star
87

theseus

A library for differentiable nonlinear optimization
Python
1,306
star
88

ConvNeXt-V2

Code release for ConvNeXt V2 model
Python
1,300
star
89

DPR

Dense Passage Retriever - is a set of tools and models for open domain Q&A task.
Python
1,292
star
90

CrypTen

A framework for Privacy Preserving Machine Learning
Python
1,283
star
91

denoiser

Real Time Speech Enhancement in the Waveform Domain (Interspeech 2020)We provide a PyTorch implementation of the paper Real Time Speech Enhancement in the Waveform Domain. In which, we present a causal speech enhancement model working on the raw waveform that runs in real-time on a laptop CPU. The proposed model is based on an encoder-decoder architecture with skip-connections. It is optimized on both time and frequency domains, using multiple loss functions. Empirical evidence shows that it is capable of removing various kinds of background noise including stationary and non-stationary noises, as well as room reverb. Additionally, we suggest a set of data augmentation techniques applied directly on the raw waveform which further improve model performance and its generalization abilities.
Python
1,272
star
92

DeepSDF

Learning Continuous Signed Distance Functions for Shape Representation
Python
1,191
star
93

TimeSformer

The official pytorch implementation of our paper "Is Space-Time Attention All You Need for Video Understanding?"
Python
1,172
star
94

House3D

a Realistic and Rich 3D Environment
C++
1,167
star
95

MaskFormer

Per-Pixel Classification is Not All You Need for Semantic Segmentation (NeurIPS 2021, spotlight)
Python
1,149
star
96

LAMA

LAnguage Model Analysis
Python
1,104
star
97

fastMRI

A large-scale dataset of both raw MRI measurements and clinical MRI images.
Python
1,098
star
98

meshrcnn

code for Mesh R-CNN, ICCV 2019
Python
1,083
star
99

mixup-cifar10

mixup: Beyond Empirical Risk Minimization
Python
1,073
star
100

DomainBed

DomainBed is a suite to test domain generalization algorithms
Python
1,071
star