docs: Add citation

jaeyun95 · Sep 5, 2020 · 026ea9b · 026ea9b
1 parent 71ff1da
commit 026ea9b
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -27,8 +27,8 @@ tokenizer = ElectraTokenizer.from_pretrained("monologg/koelectra-base-v2-discrim
 
 ## Download Link
 
-| Model                |                                                                 Discriminator |                                                                 Generator |                                                                                         Tensorflow-v1 |
-| -------------------- | ----------------------------------------------------------------------------: | ------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------: |
+| Model                |                                                                     Discriminator |                                                                 Generator |                                                                                         Tensorflow-v1 |
+| -------------------- | --------------------------------------------------------------------------------: | ------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------: |
 | `KoELECTRA-Base-v1`  |     [Discriminator](https://huggingface.co/monologg/koelectra-base-discriminator) |     [Generator](https://huggingface.co/monologg/koelectra-base-generator) | [Tensorflow-v1](https://drive.google.com/drive/folders/1RFeXvGOhRJjFgtWKSyNHY40RTX5zdfKR?usp=sharing) |
 | `KoELECTRA-Small-v1` |    [Discriminator](https://huggingface.co/monologg/koelectra-small-discriminator) |    [Generator](https://huggingface.co/monologg/koelectra-small-generator) | [Tensorflow-v1](https://drive.google.com/drive/folders/1m2XHmU11_p75UxHXLaN7bzRemkmArV36?usp=sharing) |
 | `KoELECTRA-Base-v2`  |  [Discriminator](https://huggingface.co/monologg/koelectra-base-v2-discriminator) |  [Generator](https://huggingface.co/monologg/koelectra-base-v2-generator) | [Tensorflow-v1](https://drive.google.com/drive/folders/1QX5KGJmRQVbPIEdMUnpgjJdXGskkoUT_?usp=sharing) |
@@ -146,6 +146,21 @@ model = TFElectraModel.from_pretrained("monologg/koelectra-base-discriminator",
 
 KoELECTRA은 **Tensorflow Research Cloud (TFRC)** 프로그램의 Cloud TPU 지원으로 제작되었습니다.
 
+## Citation
+
+이 코드를 연구용으로 사용하는 경우 아래와 같이 인용해주세요.
+
+```
+@misc{park2020koelectra,
+  author = {Park, Jangwon},
+  title = {KoELECTRA: Pretrained ELECTRA Model for Korean},
+  year = {2020},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/monologg/KoELECTRA}}
+}
+```
+
 ## Reference
 
 - [ELECTRA](https://github.com/google-research/electra)

diff --git a/README_EN.md b/README_EN.md
@@ -28,8 +28,8 @@ tokenizer = ElectraTokenizer.from_pretrained("monologg/koelectra-base-v2-discrim
 
 ## Download Link
 
-| Model                |                                                                 Discriminator |                                                                 Generator |                                                                                         Tensorflow-v1 |
-| -------------------- | ----------------------------------------------------------------------------: | ------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------: |
+| Model                |                                                                     Discriminator |                                                                 Generator |                                                                                         Tensorflow-v1 |
+| -------------------- | --------------------------------------------------------------------------------: | ------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------: |
 | `KoELECTRA-Base-v1`  |     [Discriminator](https://huggingface.co/monologg/koelectra-base-discriminator) |     [Generator](https://huggingface.co/monologg/koelectra-base-generator) | [Tensorflow-v1](https://drive.google.com/drive/folders/1RFeXvGOhRJjFgtWKSyNHY40RTX5zdfKR?usp=sharing) |
 | `KoELECTRA-Small-v1` |    [Discriminator](https://huggingface.co/monologg/koelectra-small-discriminator) |    [Generator](https://huggingface.co/monologg/koelectra-small-generator) | [Tensorflow-v1](https://drive.google.com/drive/folders/1m2XHmU11_p75UxHXLaN7bzRemkmArV36?usp=sharing) |
 | `KoELECTRA-Base-v2`  |  [Discriminator](https://huggingface.co/monologg/koelectra-base-v2-discriminator) |  [Generator](https://huggingface.co/monologg/koelectra-base-v2-generator) | [Tensorflow-v1](https://drive.google.com/drive/folders/1QX5KGJmRQVbPIEdMUnpgjJdXGskkoUT_?usp=sharing) |
@@ -145,6 +145,21 @@ In case of `KoELECTRA-Small`, overall performance is better than `DistilKoBERT`.
 
 KoELECTRA was created with Cloud TPU support from the **Tensorflow Research Cloud (TFRC)** program.
 
+## Citation
+
+If you use this code for research, please cite:
+
+```
+@misc{park2020koelectra,
+  author = {Park, Jangwon},
+  title = {KoELECTRA: Pretrained ELECTRA Model for Korean},
+  year = {2020},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/monologg/KoELECTRA}}
+}
+```
+
 ## Reference
 
 - [ELECTRA](https://github.com/google-research/electra)