from fastai.gen_doc.nbdoc import *
The text module of the fastai library contains all the necessary functions to define a Dataset suitable for the various NLP (Natural Language Processing) tasks and quickly generate models you can use for them. Specifically:
text.transform contains all the scripts to preprocess your data, from raw text to token ids,text.data contains the definition of TextDataset, which the main class you'll need in NLP,text.learner contains helper functions to quickly create a language model or an RNN classifier.Have a look at the links above for full details of the API of each module, of read on for a quick overview.
Let's start with a quick end-to-end example of training a model. We'll train a sentiment classifier on a sample of the popular IMDb data, showing 4 steps:
First let's import everything we need for text.
from fastai import *
from fastai.text import *
Contrary to images in Computer Vision, text can't directly be transformed into numbers to be fed into a model. The first thing we need to do is to preprocess our data so that we change the raw texts to lists of words, or tokens (a step that is called tokenization) then transform these tokens into numbers (a step that is called numericalization). These numbers are then passed to embedding layers that wil convert them in arrays of floats before passing them through a model.
You can find on the web plenty of Word Embeddings to directly convert your tokens into floats. Those word embeddings have generally be trained on a large corpus such as wikipedia. Following the work of ULMFiT, the fastai library is more focused on using pre-trained Language Models and fine-tuning them. Word embeddings are just vectors of 300 or 400 floats that represent different words, but a pretrained language model not only has those, but has also been trained to get a representation of full sentences and documents.
That's why the library is structured around three steps:
To show examples, we have provided a small sample of the IMDB dataset which contains 1,000 reviews of movies with labels (positive or negative).
path = untar_data(URLs.IMDB_SAMPLE)
path
PosixPath('/home/ubuntu/.fastai/data/imdb_sample')
Creating a dataset from your raw texts is very simple if you have it in one of those ways
Here, the sample from imdb is in a texts csv files that looks like this:
df = pd.read_csv(path/'texts.csv')
df.head()
| label | text | is_valid | |
|---|---|---|---|
| 0 | negative | Un-bleeping-believable! Meg Ryan doesn't even ... | False |
| 1 | positive | This is a extremely well-made film. The acting... | False |
| 2 | negative | Every once in a long while a movie will come a... | False |
| 3 | positive | Name just says it all. I watched this movie wi... | False |
| 4 | negative | This movie succeeds at being one of the most u... | False |
for file in ['train_tok.npy', 'valid_tok.npy']:
if os.path.exists(path/'tmp'/file): os.remove(path/'tmp'/file)
To get a DataBunch quickly, there are also several factory methods depending on how our data is structured. They are all detailed in text.data, here we'll use the method from_csv of the TextLMDataBunch (to get the data ready for a language model) and TextClasDataBunch (to get the data ready for a text classifier) classes.
# Language model data
data_lm = TextLMDataBunch.from_csv(path, 'texts.csv')
# Classifier model data
data_clas = TextClasDataBunch.from_csv(path, 'texts.csv', vocab=data_lm.train_ds.vocab, bs=32)
This does all the necessary preprocessing behing the scene. For the classifier, we also pass the vocabulary (mapping from ids to words) that we want to use: this is to ensure that data_clas will use the same dictionary as data_lm.
Since this step can be a bit time-consuming, it's best to save the result with:
data_lm.save()
data_clas.save()
This will create a 'tmp' directory where all the computed stuff will be stored. You can then reload those results with:
data_lm = TextLMDataBunch.load(path)
data_clas = TextClasDataBunch.load(path, bs=32)
Note that you can load the data with different DataBunch parameters (batch size, bptt,...)
We can use the data_lm object we created earlier to fine-tune a pretrained language model. fast.ai has an English model available that we can download. We can create a learner object that will directly create a model, download the pretrained weights and be ready for fine-tuning.
learn = language_model_learner(data_lm, pretrained_model=URLs.WT103, drop_mult=0.5)
learn.fit_one_cycle(1, 1e-2)
Total time: 00:19 epoch train_loss valid_loss accuracy 1 5.054821 4.385441 0.241620 (00:19)
Like a computer vision model, we can then unfreeze the model and fine-tune it.
learn.unfreeze()
learn.fit_one_cycle(1, 1e-3)
Total time: 00:24 epoch train_loss valid_loss accuracy 1 4.315878 3.903964 0.291229 (00:24)
To evaluate your language model, you can run the Learner.predict method and specify the number of words you want it to guess.
learn.predict("This is a review about", n_words=10)
Total time: 00:00
'This is a review about 100 years of all of up to deliver it was'
It doesn't make much sense (we have a tiny vocabulary here and didn't train much on it) but note that it respects basic grammar (which comes from the pretrained model).
Finally we save the encoder to be able to use it for classification in the next section.
learn.save_encoder('ft_enc')
We now use the data_clas object we created earlier to build a classifier with our fine-tuned encoder. The learner object can be done in a single line.
learn = text_classifier_learner(data_clas, drop_mult=0.5)
learn.load_encoder('ft_enc')
learn.fit_one_cycle(1, 1e-2)
Total time: 00:29 epoch train_loss valid_loss accuracy 1 0.654068 0.607041 0.666667 (00:29)
Again, we can unfreeze the model and fine-tune it.
learn.freeze_to(-2)
learn.fit_one_cycle(1, slice(5e-3/2., 5e-3))
Total time: 00:32 epoch train_loss valid_loss accuracy 1 0.645723 0.644110 0.696517 (00:32)
learn.unfreeze()
learn.fit_one_cycle(1, slice(2e-3/100, 2e-3))
Total time: 01:03 epoch train_loss valid_loss accuracy 1 0.531046 0.613796 0.666667 (01:03)
Again, we can predict on a raw text by using the Learner.predict method.
learn.predict("This was a great movie!")
(Category positive, tensor(1), tensor([0.1195, 0.8805]))