Create README.md

README.md

@@ -0,0 +1,72 @@
+---
+license: llama2
+language:
+- en
+pipeline_tag: text-generation
+  
+---
+# **Code-Llama-2-13B-instruct-text2sql-GPTQ Model Card**
+
+**Model Name**: Code-Llama-2-13B-instruct-text2sql-GPTQ
+
+**Description**: This model is a GPTQ quantisation of a fine-tuned version of the Code Llama 2 with 13 billion parameters, specifically tailored for text-to-SQL tasks. It has been trained to generate SQL queries given a database schema and a natural language question. The GPTQ quantisation was performed with AutoGPTQ.
+
+## Model Information
+
+- **Base Model**: [bugdaryan/Code-Llama-2-13B-instruct-text2sql](https://huggingface.co/bugdaryan/Code-Llama-2-13B-instruct-text2sql)
+
+## GPTQ Parameters
+
+- **bits**: 4
+- **group_size**: 128
+- **desc_act**: False
+- **damp_percent**: 0.01
+
+## GPTQ dataset
+
+- **Dataset**: [bugdaryan/sql-create-context-instruction](https://huggingface.co/bugdaryan/sql-create-context-instruction)
+- **Randomized Rows**: 1024
+
+## License
+
+This model is governed by a custom commercial license from Code Llama. For details, please visit: [Custom Commercial License](https://ai.meta.com/resources/models-and-libraries/llama-downloads/)
+
+## Intended Use
+
+**Intended Use Cases**: This model is intended for commercial and research use in English. It is designed for text-to-SQL tasks, enabling users to generate SQL queries from natural language questions.
+
+**Out-of-Scope Uses**: Any use that violates applicable laws or regulations, use in languages other than English, or any other use prohibited by the Acceptable Use Policy and Licensing Agreement for Code Llama and its variants.
+
+## Example Code
+
+You can use the Code-Llama-2-13B-instruct-text2sql-GPTQ model to generate SQL queries from natural language questions, as demonstrated in the following code snippet:
+```cmd
+pip install -q accelerate transformers optimum auto-gptq
+```
+
+```python
+import torch
+from transformers import AutoTokenizer
+from auto_gptq import AutoGPTQForCausalLM
+
+model_name = 'support-pvelocity/Code-Llama-2-13B-instruct-text2sql-GPTQ'
+
+model = AutoGPTQForCausalLM.from_quantized(model_name, use_safetensors=True, device_map='auto')
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+table = "CREATE TABLE sales ( sale_id number PRIMARY KEY, product_id number, customer_id number, salesperson_id number, sale_date DATE, quantity number, FOREIGN KEY (product_id) REFERENCES products(product_id), FOREIGN KEY (customer_id) REFERENCES customers(customer_id), FOREIGN KEY (salesperson_id) REFERENCES salespeople(salesperson_id)); CREATE TABLE product_suppliers ( supplier_id number PRIMARY KEY, product_id number, supply_price number, FOREIGN KEY (product_id) REFERENCES products(product_id)); CREATE TABLE customers ( customer_id number PRIMARY KEY, name text, address text ); CREATE TABLE salespeople ( salesperson_id number PRIMARY KEY, name text, region text ); CREATE TABLE product_suppliers ( supplier_id number PRIMARY KEY, product_id number, supply_price number );"
+
+question = 'Find the salesperson who made the most sales.'
+
+prompt = f"[INST] Write SQLite query to answer the following question given the database schema. Please wrap your code answer using ```: Schema: {table} Question: {question} [/INST] Here is the SQLite query to answer to the question: {question}: ``` "
+
+tokens = tokenizer(prompt, return_tensors="pt").to('cuda:0')
+input_ids = tokens.input_ids
+
+generated_ids = model.generate(input_ids=input_ids, max_length=4048, pad_token_id=tokenizer.eos_token_id)
+output = tokenizer.decode(generated_ids[0], skip_special_tokens=True)
+output = output.split('```')[2]
+print(output)
+```
+
+This code demonstrates how to utilize the model for generating SQL queries based on a provided database schema and a natural language question. It showcases the model's capability to assist in SQL query generation for text-to-SQL tasks.