Create README.md

README.md

@@ -0,0 +1,41 @@
+---
+language:
+- en
+
+tags:
+- feedback comment generation for writing learning
+
+licenses:
+- cc-by-nc-sa
+---
+## Model overview
+
+This model was trained in terms of [GenChal 2022: Feedback Comment Generation for Writing Learning](https://fcg.sharedtask.org/) shared task
+
+In this task, the model gets the string with text with the error and the exact span of the error and should return the comment in natural language, which explains the nature of the error.
+
+## Model training details
+
+### Data
+
+The data was provided in the following way
+
+```
+input sentence [\t] offset range [\t] feedback comment 
+```
+
+Here are some examples
+```
+The smoke flow my face .	10:17	When the <verb> <<flow>> is used as an <intransitive verb> to express ''to move in a stream'', a <preposition> needs to be placed to indicate the direction. 'To' and 'towards' are <prepositions> that indicate direction.
+
+I want to stop smoking during driving bicycle .	23:29	A <gerund> does not normally follow the <preposition> <<during>>. Think of an expression using the <conjunction> 'while' instead of a <preposition>.
+
+```
+
+### Data preprocessing
+
+We lowercased the text and explicitly pointed out the error in the original text
+
+
+
+## How to use