diff --git a/literature_review/dataset/readme.md b/literature_review/dataset/readme.md new file mode 100644 index 0000000..da7410f --- /dev/null +++ b/literature_review/dataset/readme.md @@ -0,0 +1,6 @@ +To contribute kindly follow the following framework: +1. Name of the dataset (an embedded link will be appreciated) +2. Pros and cons (Mention how it is better than the current dataset that the current model has been traied on, for example more complex queries, more data samples etc) +3. How can the current model be trained on or fine tuned on this dataset +4. Anything you believe is worth mentioning + diff --git a/literature_review/model/readme.md b/literature_review/model/readme.md new file mode 100644 index 0000000..96e3756 --- /dev/null +++ b/literature_review/model/readme.md @@ -0,0 +1,7 @@ +To contribute kindly follow the following framework: +1. Name of the model (an embedded link will be appreciated) +2. Pros and cons (Mention how it is better than our current model, be it speed, cost effective, more code coverage etc) +3. Tests failed +4. How can it be integrated in the current product +5. Anything you believe worth mentioning + diff --git a/literature_review/papers/readme.md b/literature_review/papers/readme.md new file mode 100644 index 0000000..1863430 --- /dev/null +++ b/literature_review/papers/readme.md @@ -0,0 +1,9 @@ +To contribute kindly follow the following framework: +1. Name of the paper (an embedded link will be appreciated) +2. The datatset Used +3. The model Used +4. Novelty introduced +5. How it can be integrated in the project +6. Additional information you believe will be helpful + +Kindly keep everything to the point and if you believe any point needs to be elaborated further, reference that section of the paper instead of quoting it in your review \ No newline at end of file diff --git a/literature_review/readme.md b/literature_review/readme.md new file mode 100644 index 0000000..80e7331 --- /dev/null +++ b/literature_review/readme.md @@ -0,0 +1,8 @@ +This directory contains: +* The information of the different models tried out and the experimental result +* The different datasets available for Text to SQL and the pros and cons of each +* Literature review of the different papers + +The contribution guideline for each has been mentioned in its own respective folder + +The naming convention for each file inside each folder shall be the name of the model or the dataset, if the name is too big as in the case of papers, one may use the name of the novelty introduced in the paper or use a suitable acronym. (e.g wikiSQL.md) \ No newline at end of file