Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
airaria committed Mar 21, 2022
1 parent bbbba10 commit 786a201
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 10 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,24 @@ To use TextPruner, users can either import TextPruner into the python scripts or
For the performance of the pruned model on typical tasks, see [Experiments](#experiments).




### Supporting Models

TextPruner currently supports the following pre-trained models in [transformers](https://github.com/huggingface/transformers):
* BERT
* Albert
* Electra
* RoBERTa
* XLM-RoBERTa

| Model | Vocabualry Pruning | Transformer Pruning |
|-|:-:|:-:|
| BERT | :heavy_check_mark: | :heavy_check_mark: |
| ALBERT | :heavy_check_mark: | :heavy_check_mark: |
| RoBERTa | :heavy_check_mark: | :heavy_check_mark: |
| ELECTRA| :heavy_check_mark: | :heavy_check_mark: |
| XLM-RoBERTa | :heavy_check_mark: | :heavy_check_mark: |
|XLM | :heavy_check_mark: | :x: |
|BART | :heavy_check_mark: | :x: |
|T5 | :heavy_check_mark: | :x: |
|mT5 | :heavy_check_mark: | :x: |


See the [online documentation](https://textpruner.readthedocs.io) for the API reference.

Expand Down
21 changes: 16 additions & 5 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,23 @@ TextPruner目前支持词表裁剪和transformer裁剪,参见[裁剪模式](#

TextPruner在典型任务上的实验效果,参见[实验结果](#实验)

### 支持模型

TextPruner目前支持[Transformers](https://github.com/huggingface/transformers)库中的如下预训练模型:
* BERT
* Albert
* Electra
* RoBERTa
* XLM-RoBERTa


| 模型 | 词表裁剪 | Transformer裁剪 |
|-|:-:|:-:|
| BERT | :heavy_check_mark: | :heavy_check_mark: |
| ALBERT | :heavy_check_mark: | :heavy_check_mark: |
| RoBERTa | :heavy_check_mark: | :heavy_check_mark: |
| ELECTRA| :heavy_check_mark: | :heavy_check_mark: |
| XLM-RoBERTa | :heavy_check_mark: | :heavy_check_mark: |
|XLM | :heavy_check_mark: | :x: |
|BART | :heavy_check_mark: | :x: |
|T5 | :heavy_check_mark: | :x: |
|mT5 | :heavy_check_mark: | :x: |


API文档参见[在线文档](https://textpruner.readthedocs.io)

Expand Down

0 comments on commit 786a201

Please sign in to comment.