antoinelouis commited on
Commit
aff844a
•
1 Parent(s): 2deaac8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -4
README.md CHANGED
@@ -2,13 +2,13 @@
2
  language: "fr"
3
  ---
4
 
5
- # BelGPT-2
6
 
7
- **BelGPT-2** (*Belgian GPT-2* 🇧🇪) is a "small" GPT-2 model pre-trained on a very large and heterogeneous French corpus (around 60Gb). Please check [antoiloui/gpt2-french](https://github.com/antoiloui/gpt2-french) for more information about the pre-trained model, its implementation, and the data.
8
 
9
- ## Using BelGPT-2 for Text Generation in French
10
 
11
- You can use BelGPT-2 with [🤗 transformers](https://github.com/huggingface/transformers) library as follows:
12
 
13
  ```python
14
  import torch
@@ -50,3 +50,20 @@ Below is the list of all French copora used to pre-trained the model:
50
  | EuroParl | `europarl` | 289.9 MB | 278.7 MB |
51
  | NewsCommentary | `news_commentary` | 61.4 MB | 58.1 MB |
52
  | **Total** | | **236.3 GB** | **57.9 GB** |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  language: "fr"
3
  ---
4
 
5
+ # Belgian GPT-2 🇧🇪
6
 
7
+ **A GPT-2 model pre-trained on a very large and heterogeneous French corpus (~60Gb).**
8
 
9
+ ## Usage
10
 
11
+ You can use BelGPT-2 with [🤗 transformers](https://github.com/huggingface/transformers):
12
 
13
  ```python
14
  import torch
50
  | EuroParl | `europarl` | 289.9 MB | 278.7 MB |
51
  | NewsCommentary | `news_commentary` | 61.4 MB | 58.1 MB |
52
  | **Total** | | **236.3 GB** | **57.9 GB** |
53
+
54
+ ## Documentation
55
+
56
+ Detailed documentation on the pre-trained model, its implementation, and the data can be found [here](https://github.com/antoiloui/belgpt2/blob/master/docs/index.md).
57
+
58
+ ## Citation
59
+
60
+ For attribution in academic contexts, please cite this work as:
61
+
62
+ ```
63
+ @misc{louis2020belgpt2,
64
+ author = {Louis, Antoine},
65
+ title = {{BelGPT-2: a GPT-2 model pre-trained on French corpora.}},
66
+ year = {2020},
67
+ howpublished = {\url{https://github.com/antoiloui/belgpt2}},
68
+ }
69
+ ```