Edited README and added the inference script

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -1,3 +1,285 @@
 ---
 license: apache-2.0
 ---
+
+# Description
+
+This is LoRA-finetuned `codellama/CodeLlama-7b-hf` text2SQL model that generates a generic flavor of SQL that executes on databases such as MySQL, Postgres, and Snowflake. This is relatively small model that was fine-tuned on 8 x A10Gs with a total GPU memory of 192GB for over 4 days. For databases with different SQL syntaxes that do not adhere this generic syntax, we plan to launch other models catered to them. 
+
+
+# Usage
+
+## Huggingface Transformers Library
+
+```py
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+model_name = 'unSQLv1-7b-generic-lora'
+device = 'cuda'
+
+model = AutoModelForCausalLM.from_pretrained(model_name).to(device)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+example_prompt = '''
+You are a highly skilled SQL query generator that generates queries for 24 different databases. Your task is to convert natural language instructions into accurate and executable SQL queries. \nTo ensure precise translation, please follow these guidelines:\n\n1. Identify the database type: Determine if the request specifies a particular database system (e.g., MySQL, PostgreSQL, SQLite, etc.). If not specified, assume a generic SQL syntax compatible with most relational databases.\n2. Extract key information: Carefully read the instructions and identify the table names, column names, conditions, order requirements, and any other relevant details.\n3. Handle ambiguity: If the instructions are unclear or incomplete, ask clarifying questions to the user to ensure you have all the necessary information.\n4. Validate syntax: Double-check that your generated SQL query follows the correct syntax for the specified database type, including proper handling of quotes, aliases, and data types.\n5. Test the query: If possible, try executing the generated SQL query against a sample dataset to verify its accuracy and functionality.\n6. Provide explanations: Along with the SQL query, provide a brief explanation of how you interpreted the instructions and any assumptions you made.\n7. Handle multiple requests: If the instructions include multiple related queries, generate separate SQL statements for each request.\n8. Error handling: If you encounter any issues or limitations in translating the instructions to SQL, provide a clear explanation of the problem and any potential workarounds.\n\nRemember, the goal is to produce SQL queries that are accurate, executable, and aligned with the user's intent. Follow best practices for writing efficient and secure SQL code.
+
+### Schema and the Natural Language Query:
+CREATE TABLE stadium (
+    stadium_id number,
+    location text,
+    name text,
+    capacity number,
+    highest number,
+    lowest number,
+    average number
+)
+
+CREATE TABLE singer (
+    singer_id number,
+    name text,
+    country text,
+    song_name text,
+    song_release_year text,
+    age number,
+    is_male others
+)
+
+CREATE TABLE concert (
+    concert_id number,
+    concert_name text,
+    theme text,
+    stadium_id text,
+    year text
+)
+
+CREATE TABLE singer_in_concert (
+    concert_id number,
+    singer_id text
+)
+
+-- Using valid SQLite, answer the following questions for the tables provided above.
+
+-- What is the maximum, the average, and the minimum capacity of stadiums ?
+'''
+
+
+inputs = tokenizer.encode(example_prompt, return_tensors="pt").to(device)
+outputs = model.generate(inputs, max_length=512)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+
+## Sagemaker Endpoint I/O Example
+
+
+```js
+{
+    "inputs": "### Schema and the Natural Language Query:\nCREATE TABLE stadium (\n    stadium_id number,\n    location text,\n    name text,\n    capacity number,\n    highest number,\n    lowest number,\n    average number\n)\n\nCREATE TABLE singer (\n    singer_id number,\n    name text,\n    country text,\n    song_name text,\n    song_release_year text,\n    age number,\n    is_male others\n)\n\nCREATE TABLE concert (\n    concert_id number,\n    concert_name text,\n    theme text,\n    stadium_id text,\n    year text\n)\n\nCREATE TABLE singer_in_concert (\n    concert_id number,\n    singer_id text\n)\n\n-- Using valid SQLite, answer the following questions for the tables provided above.\n\n-- What is the maximum, the average, and the minimum capacity of stadiums ?",
+    "parameters": {
+        "maxNewTokens": 512,
+        "topP": 0.9,
+        "temperature": 0.2,
+        "decoderInputDetails": true,
+        "details": true
+    }
+}
+```
+
+```js
+{
+    "body": [
+        {
+            "generated_text": "\n\n\n### Response:\nSELECT MAX(capacity), AVG(capacity), MIN(capacity) FROM stadium",
+            "details": {
+                "finish_reason": "eos_token",
+                "generated_tokens": 30,
+                "seed": 14524408611356330000,
+                "prefill": [],
+                "tokens": [
+                    {
+                        "id": 13,
+                        "text": "\n",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 13,
+                        "text": "\n",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 13,
+                        "text": "\n",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 2277,
+                        "text": "##",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29937,
+                        "text": "#",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 13291,
+                        "text": " Response",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29901,
+                        "text": ":",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 13,
+                        "text": "\n",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 6404,
+                        "text": "SELECT",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 18134,
+                        "text": " MAX",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29898,
+                        "text": "(",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 5030,
+                        "text": "cap",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 5946,
+                        "text": "acity",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 511,
+                        "text": "),",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 16884,
+                        "text": " AV",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29954,
+                        "text": "G",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29898,
+                        "text": "(",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 5030,
+                        "text": "cap",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 5946,
+                        "text": "acity",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 511,
+                        "text": "),",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 341,
+                        "text": " M",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 1177,
+                        "text": "IN",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29898,
+                        "text": "(",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 5030,
+                        "text": "cap",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 5946,
+                        "text": "acity",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 29897,
+                        "text": ")",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 3895,
+                        "text": " FROM",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 10728,
+                        "text": " stad",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 1974,
+                        "text": "ium",
+                        "logprob": 0,
+                        "special": false
+                    },
+                    {
+                        "id": 2,
+                        "text": "</s>",
+                        "logprob": 0,
+                        "special": true
+                    }
+                ]
+            }
+        }
+    ],
+    "contentType": "application/json",
+    "invokedProductionVariant": "AllTraffic"
+}
+```

inference.py

@@ -0,0 +1,54 @@
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+model_name = 'unSQLv1-7b-generic-lora'
+device = 'cuda'
+
+model = AutoModelForCausalLM.from_pretrained(model_name).to(device)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+example_prompt = '''
+You are a highly skilled SQL query generator that generates queries for 24 different databases. Your task is to convert natural language instructions into accurate and executable SQL queries. \nTo ensure precise translation, please follow these guidelines:\n\n1. Identify the database type: Determine if the request specifies a particular database system (e.g., MySQL, PostgreSQL, SQLite, etc.). If not specified, assume a generic SQL syntax compatible with most relational databases.\n2. Extract key information: Carefully read the instructions and identify the table names, column names, conditions, order requirements, and any other relevant details.\n3. Handle ambiguity: If the instructions are unclear or incomplete, ask clarifying questions to the user to ensure you have all the necessary information.\n4. Validate syntax: Double-check that your generated SQL query follows the correct syntax for the specified database type, including proper handling of quotes, aliases, and data types.\n5. Test the query: If possible, try executing the generated SQL query against a sample dataset to verify its accuracy and functionality.\n6. Provide explanations: Along with the SQL query, provide a brief explanation of how you interpreted the instructions and any assumptions you made.\n7. Handle multiple requests: If the instructions include multiple related queries, generate separate SQL statements for each request.\n8. Error handling: If you encounter any issues or limitations in translating the instructions to SQL, provide a clear explanation of the problem and any potential workarounds.\n\nRemember, the goal is to produce SQL queries that are accurate, executable, and aligned with the user's intent. Follow best practices for writing efficient and secure SQL code.
+
+### Schema and the Natural Language Query:
+CREATE TABLE stadium (
+    stadium_id number,
+    location text,
+    name text,
+    capacity number,
+    highest number,
+    lowest number,
+    average number
+)
+
+CREATE TABLE singer (
+    singer_id number,
+    name text,
+    country text,
+    song_name text,
+    song_release_year text,
+    age number,
+    is_male others
+)
+
+CREATE TABLE concert (
+    concert_id number,
+    concert_name text,
+    theme text,
+    stadium_id text,
+    year text
+)
+
+CREATE TABLE singer_in_concert (
+    concert_id number,
+    singer_id text
+)
+
+-- Using valid SQLite, answer the following questions for the tables provided above.
+
+-- What is the maximum, the average, and the minimum capacity of stadiums ?
+'''
+
+inputs = tokenizer.encode(example_prompt, return_tensors="pt").to(device)
+outputs = model.generate(inputs, max_length=512)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+