Update README.md

README.md

@@ -18,7 +18,8 @@ pretty_name: SynTranFa
 
 # SynTran-fa 
 Syntactic Transformed Version of Farsi QA datasets to make fluent responses from questions and short answers. You can use this dataset by the code below:
-```
+
+```python
 import datasets
 data = datasets.load_dataset('SLPL/syntran-fa', split="train")
 ```
@@ -85,19 +86,17 @@ Each row of the dataset will look like something like the below:
   'bert_loss': 1.110097069682014
 }
 ```
-+ __id__: 
-
-### Data Instances
-
-[More Information Needed]
-
-### Data Fields
++ `id` : the entry id in dataset
++ `question` : the question
++ `short_answer` : the short answer corresponding to the `question` (the primary answer)
++ `fluent_answer` : fluent (long) answer generated from both `question` and the `short_answer` (the secondary answer)
++ `bert_loss` : the loss that [pars-bert](https://huggingface.co/HooshvareLab/bert-base-parsbert-uncased) gives when inputting the `fluent_answer` to it. As it increases the sentence is more likely to be influent.
 
-[More Information Needed]
+Note: the dataset is sorted increasingly by the `bert_loss`, so first sentences are more likely to be fluent.
 
 ### Data Splits
 
-[More Information Needed]
+Currently, the dataset just provided the `train` split. There would be a `test` split soon.
 
 ## Dataset Creation