Roberta Tiny Word Chinese Cluecorpussmall

🚀 中文基於詞的RoBERTa輕量級模型

本項目提供了5個基於中文詞的RoBERTa預訓練模型，相較於基於字符的模型，這些模型在速度和性能上表現更優。項目詳細介紹了模型的訓練數據、過程，並提供了使用示例和相關引用信息。

🚀 快速開始

你可以直接使用以下代碼示例，通過管道進行掩碼語言建模（以基於詞的RoBERTa-Medium為例）：

>>> 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': '日本'}
]

✨ 主要特性

• 基於詞的建模：與大多數基於中文字符的預訓練權重不同，基於詞的模型在大多數情況下速度更快（序列長度更短），且性能更優。
• 多工具支持：這些模型可以通過 UER-py 或 TencentPretrain 進行預訓練。
• 公開數據與細節：使用公開可用的語料庫和分詞工具進行訓練，並提供所有訓練細節，方便用戶復現結果。

📦 安裝指南

文檔未提及安裝相關內容，可參考對應工具（如 UER-py 或 TencentPretrain）的官方安裝說明。

💻 使用示例

基礎用法

以下是使用該模型進行掩碼語言建模的基礎用法：

>>> 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和TensorFlow中使用該模型獲取給定文本特徵的示例：

# 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 Modelzoo頁面 或通過HuggingFace從以下鏈接下載5箇中文RoBERTa輕量級模型：

模型性能

與 基於字符的模型 相比，基於詞的模型在大多數情況下取得了更好的結果。以下是六個中文任務開發集上的得分：

超參數選擇

對於每個任務，我們從以下列表中選擇最佳的微調超參數，並使用序列長度為128進行訓練：

• 訓練輪數：3, 5, 8
• 批次大小：32, 64
• 學習率：3e-5, 1e-4, 3e-4

訓練數據

使用 CLUECorpusSmall 作為訓練數據，並使用Google的 sentencepiece 進行分詞。以下是在CLUECorpusSmall語料庫上訓練sentencepiece模型的代碼：

>>> 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 進行預訓練。我們先使用序列長度為128進行1,000,000步的預訓練，然後使用序列長度為512進行額外的250,000步預訓練。不同模型大小使用相同的超參數。

以基於詞的RoBERTa-Medium為例：

階段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

引用信息

@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}
}