Roberta Medium Word Chinese Cluecorpussmall

🚀 中国語の単語ベースRoBERTaミニモデル

このモデル群は、中国語の単語ベースのRoBERTaモデルで、多くの自然言語処理タスクで優れた性能を発揮します。文字ベースのモデルと比較して、単語ベースのモデルは処理速度が速く、精度も高いという特徴があります。

🚀 クイックスタート

このモデルを使用するには、HuggingFaceのtransformersライブラリを利用できます。以下に具体的な使用例を示します。

✨ 主な機能

• 高性能：多くの中国語タスクで文字ベースのモデルよりも高いスコアを達成します。
• 高速処理：単語ベースのモデルなので、処理速度が速くなります。
• 公開データ利用：公開されているコーパスと形態素解析ツールを使用しているため、再現性が高いです。

📦 インストール

transformersライブラリをインストールすることで、このモデルを使用できます。

pip install transformers

💻 使用例

基本的な使用法

マスク言語モデリングのパイプラインを使用して、モデルを直接利用する例です。

>>> from transformers import pipeline
>>> unmasker = pipeline('fill-mask', model='uer/roberta-medium-word-chinese-cluecorpussmall')
>>> unmasker("[MASK]的首都是北京。")
[
    {'sequence': '中国 的首都是北京。',
     'score': 0.21525809168815613, 
     'token': 2873, 
     'token_str': '中国'}, 
    {'sequence': '北京 的首都是北京。', 
     'score': 0.15194718539714813, 
     'token': 9502, 
     'token_str': '北京'}, 
    {'sequence': '我们 的首都是北京。', 
     'score': 0.08854265511035919, 
     'token': 4215, 
     'token_str': '我们'},
    {'sequence': '美国 的首都是北京。', 
     'score': 0.06808705627918243, 
     'token': 7810, 
     'token_str': '美国'}, 
    {'sequence': '日本 的首都是北京。', 
     'score': 0.06071401759982109, 
     'token': 7788, 
     'token_str': '日本'}
]

高度な使用法

与えられたテキストの特徴量を取得する例です。

PyTorchでの使用例

from transformers import AlbertTokenizer, BertModel
tokenizer = AlbertTokenizer.from_pretrained('uer/roberta-medium-word-chinese-cluecorpussmall')
model = BertModel.from_pretrained("uer/roberta-medium-word-chinese-cluecorpussmall")
text = "用你喜欢的任何文本替换我。"
encoded_input = tokenizer(text, return_tensors='pt')
output = model(**encoded_input)

TensorFlowでの使用例

from transformers import AlbertTokenizer, TFBertModel
tokenizer = AlbertTokenizer.from_pretrained('uer/roberta-medium-word-chinese-cluecorpussmall')
model = TFBertModel.from_pretrained("uer/roberta-medium-word-chinese-cluecorpussmall")
text = "用你喜欢的任何文本替换我。"
encoded_input = tokenizer(text, return_tensors='tf')
output = model(encoded_input)

なお、BertTokenizerはsentencepieceをサポートしていないため、ここではAlbertTokenizerを使用しています。

📚 ドキュメント

モデルの説明

このモデル群は、UER-pyによって事前学習された5つの中国語の単語ベースのRoBERTaモデルです。また、TencentPretrainによっても事前学習可能です。

多くの中国語の事前学習モデルは文字ベースですが、この単語ベースのモデルは、実験結果によると、処理速度が速く、性能も高いです。このため、異なるサイズの5つのモデルを公開しています。再現性を高めるために、公開されているコーパスと形態素解析ツールを使用し、すべての学習詳細を公開しています。

以下のリンクからモデルをダウンロードできます。

文字ベースのモデルと比較すると、単語ベースのモデルはほとんどの場合で良い結果を得ています。以下は6つの中国語タスクの開発セットでのスコアです。

各タスクでは、以下のハイパーパラメータから最適なものを選択し、シーケンス長128で学習を行いました。

• epochs: 3, 5, 8
• batch sizes: 32, 64
• learning rates: 3e-5, 1e-4, 3e-4

学習データ

学習データにはCLUECorpusSmallを使用しています。形態素解析にはGoogleのsentencepieceを使用しており、このモデルはCLUECorpusSmallコーパスで学習されています。

>>> import sentencepiece as spm
>>> spm.SentencePieceTrainer.train(input='cluecorpussmall.txt',
             model_prefix='cluecorpussmall_spm',
             vocab_size=100000,
             max_sentence_length=1024,
             max_sentencepiece_length=6,
             user_defined_symbols=['[MASK]','[unused1]','[unused2]',
                '[unused3]','[unused4]','[unused5]','[unused6]',
                '[unused7]','[unused8]','[unused9]','[unused10]'],
             pad_id=0,
             pad_piece='[PAD]',
             unk_id=1,
             unk_piece='[UNK]',
             bos_id=2,
             bos_piece='[CLS]',
             eos_id=3,
             eos_piece='[SEP]',
             train_extremely_large_corpus=True
            )

学習手順

モデルはUER-pyを使用してTencent Cloud上で事前学習されています。シーケンス長128で1,000,000ステップ事前学習した後、シーケンス長512でさらに250,000ステップ事前学習しています。異なるモデルサイズで同じハイパーパラメータを使用しています。

ステージ1

python3 preprocess.py --corpus_path corpora/cluecorpussmall.txt \
                      --spm_model_path models/cluecorpussmall_spm.model \
                      --dataset_path cluecorpussmall_word_seq128_dataset.pt \
                      --processes_num 32 --seq_length 128 \
                      --dynamic_masking --data_processor mlm

python3 pretrain.py --dataset_path cluecorpussmall_word_seq128_dataset.pt \
                    --spm_model_path models/cluecorpussmall_spm.model \
                    --config_path models/bert/medium_config.json \
                    --output_model_path models/cluecorpussmall_word_roberta_medium_seq128_model.bin \
                    --world_size 8 --gpu_ranks 0 1 2 3 4 5 6 7 \
                    --total_steps 1000000 --save_checkpoint_steps 100000 --report_steps 50000 \
                    --learning_rate 1e-4 --batch_size 64 \
                    --data_processor mlm --target mlm

ステージ2

python3 preprocess.py --corpus_path corpora/cluecorpussmall.txt \
                      --spm_model_path models/cluecorpussmall_spm.model \
                      --dataset_path cluecorpussmall_word_seq512_dataset.pt \
                      --processes_num 32 --seq_length 512 \
                      --dynamic_masking --data_processor mlm

python3 pretrain.py --dataset_path cluecorpussmall_word_seq512_dataset.pt \
                    --spm_model_path models/cluecorpussmall_spm.model \
                    --pretrained_model_path models/cluecorpussmall_word_roberta_medium_seq128_model.bin-1000000 \
                    --config_path models/bert/medium_config.json \
                    --output_model_path models/cluecorpussmall_word_roberta_medium_seq512_model.bin \
                    --world_size 8 --gpu_ranks 0 1 2 3 4 5 6 7 \
                    --total_steps 250000 --save_checkpoint_steps 50000 --report_steps 10000 \
                    --learning_rate 5e-5 --batch_size 16 \
                    --data_processor mlm --target mlm

最後に、事前学習したモデルをHuggingfaceの形式に変換します。

python3 scripts/convert_bert_from_uer_to_huggingface.py --input_model_path models/cluecorpussmall_word_roberta_medium_seq512_model.bin-250000 \
                                                        --output_model_path pytorch_model.bin \
                                                        --layers_num 8 --type mlm

BibTeX引用

@article{devlin2018bert,
  title={BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding},
  author={Devlin, Jacob and Chang, Ming-Wei and Lee, Kenton and Toutanova, Kristina},
  journal={arXiv preprint arXiv:1810.04805},
  year={2018}
}

@article{turc2019,
  title={Well-Read Students Learn Better: On the Importance of Pre-training Compact Models},
  author={Turc, Iulia and Chang, Ming-Wei and Lee, Kenton and Toutanova, Kristina},
  journal={arXiv preprint arXiv:1908.08962v2 },
  year={2019}
}

@article{zhao2019uer,
  title={UER: An Open-Source Toolkit for Pre-training Models},
  author={Zhao, Zhe and Chen, Hui and Zhang, Jinbin and Zhao, Xin and Liu, Tao and Lu, Wei and Chen, Xi and Deng, Haotang and Ju, Qi and Du, Xiaoyong},
  journal={EMNLP-IJCNLP 2019},
  pages={241},
  year={2019}
}

@article{zhao2023tencentpretrain,
  title={TencentPretrain: A Scalable and Flexible Toolkit for Pre-training Models of Different Modalities},
  author={Zhao, Zhe and Li, Yudong and Hou, Cheng and Zhao, Jing and others},
  journal={ACL 2023},
  pages={217},
  year={2023}