Skip to content

add directory to store experimental results and reviews #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2023
Merged

add directory to store experimental results and reviews #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1288903
add directory to store experimental results and reviews
goyalpramod May 25, 2023
2b4a34d
change directory name to literature_review
goyalpramod May 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions literature_review/dataset/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

7 changes: 7 additions & 0 deletions literature_review/model/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

9 changes: 9 additions & 0 deletions literature_review/papers/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions literature_review/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)