Skip to content

Commit

Permalink
Translate kornli.md (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
warnikchow authored and ratsgo committed Nov 15, 2020
1 parent 5fa1464 commit 560f643
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions en-docs/corpuslist/kornli.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ sort: 5

# KorNLI

KorNLI는 카카브레인에서 만들어 공개한 데이터입니다.
데이터 정보는 다음과 같습니다.
KorNLI is the data created and released by KakaoBrain.
Data specification is as follows:

- author: KakaoBrain
- repository: [https://github.com/kakaobrain/KorNLUDatasets](https://github.com/kakaobrain/KorNLUDatasets)
Expand All @@ -16,58 +16,58 @@ KorNLI는 카카브레인에서 만들어 공개한 데이터입니다.
- xnli_dev: 2,490 examples
- xnli_test: 5,010 examples

데이터 구조는 다음과 같습니다.
Data structure is as:

|속성명|내용|
|Attributes|Property|
|---|---|
|text|문장|
|pair|text와 쌍이 되는 문장|
|label|text, pair 사이의 관계|
|text|Sentence|
|pair|Sentence that makes up a pair with the text|
|label|Relation between the text and pair|


## 1. 파이썬에서 사용하기
## 1. In Python

파이썬 콘솔을 실행한 뒤 말뭉치를 내려받고 읽어들일 수 있습니다.
Execute Python console, download the corpus, and read it.

### 말뭉치 다운로드
### Downloading the corpus

KorNLI를 로컬에 내려 받는 파이썬 예제는 다음과 같습니다.
You can download KorNLI in the local by the following procedure.

```python
from Korpora import Korpora
Korpora.fetch("kornli")
```

```note
기본적으로 사용자의 로컬 컴퓨터 루트 하위의 Korpora라는 디렉토리에 말뭉치를 내려 받습니다(`~/Korpora`). 다른 경로에 말뭉치를 다운로드 받고 싶다면
fetch 함수 실행시 `root_dir=custom_path`라는 인자를 추가하세요.
First, download the corpus to Korpora, a directory under the user's local computer root (`~/Korpora`).
If you want to download it in other path, please assign `root_dir=custom_path` when you execute fetch function.
```

```tip
fetch 함수 실행시 `force_download=True`라는 인자를 줄 경우 해당 말뭉치가 이미 로컬에 있더라도 이를 무시하고 다시 내려 받습니다. 기본값은 `False`입니다.
If you assign `force_download=True` when you execute the fetch function, the corpus is downloaded again regardless of its presence in the local. The default is `False`.
```


### 말뭉치 읽어들이기

KorNLI를 파이썬 콘솔에서 읽어들이는 예제는 다음과 같습니다.
말뭉치가 로컬에 없다면 다운로드도 함께 수행합니다.
You can read KorNLI in Python console with the following scheme.
If the corpus is not in the local, the downloading is accompanied.

```python
from Korpora import Korpora
corpus = Korpora.load("kornli")
```

다음과 같이 실행해도 KorNLI를 읽어들일 수 있습니다.
수행 결과는 위의 코드와 동일합니다.
You can read KorNLI as below;
the result is the same as the above operation.

```python
from Korpora import KorNLIKorpus
corpus = KorNLIKorpus()
```

위 코드 둘 중 하나를 택해 실행하면 `corpus`라는 변수에 말뭉치를 로드합니다.
`multinli_train`은 KorNLI의 multinli_train 데이터로 첫번째 인스턴스는 다음과 같이 확인할 수 있습니다.
Execute one of the above, and the copus is assigned to the variable `corpus`.
`multinli_train` denotes the multinli_train data of KorNLI, and you can check the first instance as:

```
>>> corpus.multinli_train[0]
Expand All @@ -80,7 +80,7 @@ LabeledSentencePair(text='개념적으로 크림 스키밍은 제품과 지리
neutral
```

`snli_train`, `xnli_dev`, `xnli_test`는 각각 KorNLI의 snli_train, xnli_dev, xnli_test 데이터로 첫번째 인스턴스는 다음과 같이 확인할 수 있습니다.
`snli_train`, `xnli_dev`, and `xnli_test` denote snli_train, xnli_dev, and xnli_test data of KorNLI, respectively, and you can check the first instance as:

```
>>> corpus.snli_train[0]
Expand All @@ -92,41 +92,41 @@ LabeledSentencePair(text='글쎄, 나는 그것에 관해 생각조차 하지
```


`get_all_texts`라는 메소드를 실행하면 KorNLI의 모든 text(문장)를 확인할 수 있습니다.
The method `get_all_texts` lets you check all the texts (Sentence) in KorNLI.

```
>>> corpus.get_all_texts()
['개념적으로 크림 스키밍은 제품과 지리라는 두 가지 기본 차원을 가지고 있다.', ... ]
```

`get_all_pairs`라는 메소드를 실행하면 KorNLI의 모든 pair(text와 쌍이 되는 문장)를 확인할 수 있습니다.
The method `get_all_pairs` lets you check all the pairs (Sentence that makes up a pair with the text) in KorNLI.

```
>>> corpus.get_all_pairs()
[SentencePair(text='개념적으로 크림 스키밍은 제품과 지리라는 두 가지 기본 차원을 가지고 있다.', pair='제품과 지리학은 크림 스키밍을 작동시키는 것이다.'), ... ]
```

`get_all_labels`라는 메소드를 실행하면 KorNLI의 모든 label(text, pair 사이의 관계)을 확인할 수 있습니다.
The method `get_all_labels` lets you check all the labels (Relation between the text and pair) in KorNLI.

```
>>> corpus.get_all_labels()
['neutral', ... ]
```

## 2. 터미널에서 사용하기
## 2. In terminal

파이썬 콘솔 실행 없이 바로 말뭉치를 다운받을 수 있습니다.
다음과 같이 실행하면 됩니다.
You can download the corpus without executing Python console.
The command is as below.

```bash
korpora fetch --corpus kornli
```

```note
기본적으로 사용자의 로컬 컴퓨터 루트 하위의 Korpora라는 디렉토리에 말뭉치를 내려 받습니다(`~/Korpora`). 다른 경로에 말뭉치를 다운로드 받고 싶다면
터미널에서 fetch 함수 실행시 `--root_dir custom_path`라는 인자를 추가하세요.
First, download the corpus to Korpora, a directory under the user's local computer root (`~/Korpora`).
If you want to download it in other path, please assign `--root_dir custom_path` when you execute fetch function in the terminal.
```

```tip
터미널에서 fetch 함수 실행시 `--force_download`라는 인자를 줄 경우 해당 말뭉치가 이미 로컬에 있더라도 이를 무시하고 다시 내려 받습니다.
If you assign `--force_download` when you execute fetch function in the terminal, the corpus is downloaded again regardless of its presence in the local.
```

0 comments on commit 560f643

Please sign in to comment.