ALBERT with SentencePiece for Japanese text.

This is a repository of Japanese ALBERT model with SentencePiece tokenizer.
(Note: this project is a fork of bert-japanese)

To clone this repository together with the required ALBERT (our fork of original ALBERT) and WikiExtractor:

git clone --recurse-submodules https://github.com/alinear-corp/albert-japanese

Pretrained models

We provide pretrained BERT model and trained SentencePiece model for Japanese text. Training data is the Japanese wikipedia corpus from Wikimedia Downloads.
The latest release is v2, you can download the pretrained model at:

• Pretrained BERT model and trained SentencePiece model

Loss function during training is as below (after 1M steps the loss function massively changes because max_seq_length is changed from 128 to 512.):

Use pretrained model with transformers

You can use the pretrained model with transformers. The model is uploaded to hagging face's repository.

• ALINEAR/albert-japanese-v2

For example, if you want to train AlbertForSequenceClassification, you can load the pretrained model by:

from transformers import AlbertTokenizer, AlbertForSequenceClassification
tokenizer = AlbertTokenizer.from_pretrained("ALINEAR/albert-japanese-v2")
model = AlbertForSequenceClassification.from_pretrained("ALINEAR/albert-japanese-v2", num_labels=...)

Finetuning with BERT Japanese

We also provide a simple Japanese text classification problem with livedoor ニュースコーパス.
Try the following notebook to check the usability of finetuning.
You can run the notebook on CPU (too slow) or GPU/TPU environments.

• finetune-to-livedoor-corpus.ipynb

The results are the following:

• ALBERT with SentencePiece

                precision    recall  f1-score   support
  
  dokujo-tsushin       1.00      0.93      0.96       178
    it-life-hack       0.92      0.96      0.94       172
   kaden-channel       0.95      0.98      0.97       176
  livedoor-homme       0.90      0.82      0.86        95
     movie-enter       0.96      0.98      0.97       158
          peachy       0.95      0.97      0.96       174
            smax       0.99      0.98      0.98       167
    sports-watch       0.96      0.98      0.97       190
      topic-news       0.96      0.94      0.95       163
  
        accuracy                           0.96      1473
       macro avg       0.95      0.95      0.95      1473
    weighted avg       0.96      0.96      0.96      1473
  

• BERT with SentencePiece (from original bert-japanese repository)

                  precision    recall  f1-score   support
  
  dokujo-tsushin       0.98      0.94      0.96       178
    it-life-hack       0.96      0.97      0.96       172
   kaden-channel       0.99      0.98      0.99       176
  livedoor-homme       0.98      0.88      0.93        95
     movie-enter       0.96      0.99      0.98       158
          peachy       0.94      0.98      0.96       174
            smax       0.98      0.99      0.99       167
    sports-watch       0.98      1.00      0.99       190
      topic-news       0.99      0.98      0.98       163
  
       micro avg       0.97      0.97      0.97      1473
       macro avg       0.97      0.97      0.97      1473
    weighted avg       0.97      0.97      0.97      1473
  

Pretraining from scratch

All scripts for pretraining from scratch are provided. Follow the instructions below.

Data preparation

Data downloading and preprocessing.

python3 src/data-download-and-extract.py
bash src/file-preprocessing.sh

The above scripts use the latest jawiki data and wikiextractor module, which are different from those used for the pretrained model. If you wanna prepare the same situation, use the following information:

• albert-japanese: commit e420eab47a1d6d4775adc07e0b112aac8088d81b
• ALBERT: commit 08a848f08ec79d85f434b5c2fb6147e89f01bccb
• dataset: jawiki-20191201-pages-articles-multistream.xml.bz2 in the Google Drive
• wikiextractor: commit 16186e290d9eb0eb3a3784c6c0635a9ed7e855c3

Training SentencePiece model

Train a SentencePiece model using the preprocessed data.

python3 src/train-sentencepiece.py

Creating data for pretraining

Create .tfrecord files for pretraining.

bash src/run_create_pretraining_data.sh [extract_dir] [max_seq_length]

extract_dir is a base directory to which the wikipedia texts are extracted, and,
max_seq_length need to be 128 and 512

Pretraining

You need GPU/TPU environment to pretrain a BERT model.
The following notebook provides the link to Colab notebook where you can run the scripts with TPUs.

• pretraining.ipynb