Updated README.md with template mapping details

#5
Files changed (1) hide show
  1. README.md +11 -9
README.md CHANGED
@@ -57,17 +57,19 @@ Telugu is a low-resource language where there no riddles and their answers gener
57
  ## Sources
58
  - **Mutiple Riddles Websites**: Performed webscraping from [1](https://telugupatham.blogspot.com/p/podupu-kathalu.html), [2](http://www.maganti.org/podupu/podupu1.html), [3](https://teluguadda.co.in/podupu-kathalu-telugu-with-answers/), [4](http://palukuteniyalu.blogspot.com/2016/03/blog-post_17.html) and [5](http://mostusefulthings.blogspot.com/2011/06/blog-post.html) websites which consists of riddles of varying difficulties. Next, performed some pre-processing of the data like removing unwanted characters and bad riddles from the scraped data. Finally, converted the scraped data into Instruct-style prompts and completions.
59
 
 
 
 
 
 
 
60
  ## Templates
61
- For the creation of instruct-style prompts and completions from the scraped data, the following one template was used:
62
  1. Given Title/Headline of the article, generate the article with that Title/Headline.
63
- ```python
64
- Prompt:
65
- ("రిడిల్" / "పొడుపు కథ") కి సమాధానం ఇవ్వు
66
- {{Riddle}}
67
-
68
- Completion:
69
- మీరు అడిగిన ("రిడిల్" / "పొడుపు కథ")కి సమాధానం: {{Answer}}
70
- ```
71
 
72
  ## Personal or Sensitive Data
73
  This dataset contains public information. To our knowledge, there are no private person’s personal identifiers or sensitive information.
 
57
  ## Sources
58
  - **Mutiple Riddles Websites**: Performed webscraping from [1](https://telugupatham.blogspot.com/p/podupu-kathalu.html), [2](http://www.maganti.org/podupu/podupu1.html), [3](https://teluguadda.co.in/podupu-kathalu-telugu-with-answers/), [4](http://palukuteniyalu.blogspot.com/2016/03/blog-post_17.html) and [5](http://mostusefulthings.blogspot.com/2011/06/blog-post.html) websites which consists of riddles of varying difficulties. Next, performed some pre-processing of the data like removing unwanted characters and bad riddles from the scraped data. Finally, converted the scraped data into Instruct-style prompts and completions.
59
 
60
+ ## Data Fields
61
+ - `inputs` : Prompt or input to the language model.
62
+ - `targets` : Completion or output of the language model.
63
+ - `template_id` : Id of the template used in `inputs` and `targets`.
64
+ - `template_lang`: ISO code of the language used in the `inputs` and `targets` where *tel* refers to Telugu.
65
+
66
  ## Templates
67
+ For the creation of instruct-style prompts and completions from the scraped data, the following one template with 2 different templates were used:
68
  1. Given Title/Headline of the article, generate the article with that Title/Headline.
69
+ | template_id | inputs | targets |
70
+ |-------------|--------|---------|
71
+ | 1 | ```ఈ రిడిల్ కి సమాధానం ఇవ్వు {{Riddle}}``` | ```మీరు అడిగిన రిడిల్ కి సమాధానం: {{Answer}}``` |
72
+ | 2 | ```ఈ పొడుపు కథ కి సమాధానం ఇవ్వు {{Riddle}}``` | ```మీరు అడిగిన పొడుపు కథ కి సమాధానం: {{Answer}}``` |
 
 
 
 
73
 
74
  ## Personal or Sensitive Data
75
  This dataset contains public information. To our knowledge, there are no private person’s personal identifiers or sensitive information.