🚀 ChatDB的Natural - SQL - 7B模型

Natural - SQL - 7B是一款在文本转SQL指令方面表现极为出色的模型，它能够出色地理解复杂问题，在同规模模型中脱颖而出。

ChatDB.ai | Notebook | Twitter

🚀 快速开始

安装依赖

确保你安装了正确版本的transformers库：

pip install transformers==4.35.2

加载模型

使用以下Python代码加载模型：

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained("chatdb/natural-sql-7b")
model = AutoModelForCausalLM.from_pretrained(
    "chatdb/natural-sql-7b",
    device_map="auto",
    torch_dtype=torch.float16,
)

生成SQL

inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
generated_ids = model.generate(
    **inputs,
    num_return_sequences=1,
    eos_token_id=100001,
    pad_token_id=100001,
    max_new_tokens=400,
    do_sample=False,
    num_beams=1,
)

outputs = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
print(outputs[0].split("```sql")[-1])

✨ 主要特性

• 在文本转SQL指令方面表现强劲，能出色理解复杂问题。
• 可以处理其他模型通常难以应对的复杂复合问题。

📦 安装指南

安装正确版本的transformers库：

pip install transformers==4.35.2

💻 使用示例

基础用法

加载模型

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained("chatdb/natural-sql-7b")
model = AutoModelForCausalLM.from_pretrained(
    "chatdb/natural-sql-7b",
    device_map="auto",
    torch_dtype=torch.float16,
)

生成SQL

inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
generated_ids = model.generate(
    **inputs,
    num_return_sequences=1,
    eos_token_id=100001,
    pad_token_id=100001,
    max_new_tokens=400,
    do_sample=False,
    num_beams=1,
)

outputs = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
print(outputs[0].split("```sql")[-1])

提示模板

# Task 
Generate a SQL query to answer the following question: `{自然语言问题}`

### PostgreSQL Database Schema 
The query will run on a database with the following schema: 

<SQL Table DDL Statements>

# SQL 
Here is the SQL query that answers the question: `{自然语言问题}` 
'''sql

示例SQL输出

示例模式

CREATE TABLE users (
        user_id SERIAL PRIMARY KEY,
        username VARCHAR(50) NOT NULL,
        email VARCHAR(100) NOT NULL,
        password_hash TEXT NOT NULL,
        created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
    );
CREATE TABLE projects (
    project_id SERIAL PRIMARY KEY,
    project_name VARCHAR(100) NOT NULL,
    description TEXT,
    start_date DATE,
    end_date DATE,
    owner_id INTEGER REFERENCES users(user_id)
);
CREATE TABLE tasks (
    task_id SERIAL PRIMARY KEY,
    task_name VARCHAR(100) NOT NULL,
    description TEXT,
    due_date DATE,
    status VARCHAR(50),
    project_id INTEGER REFERENCES projects(project_id)
);
CREATE TABLE taskassignments (
    assignment_id SERIAL PRIMARY KEY,
    task_id INTEGER REFERENCES tasks(task_id),
    user_id INTEGER REFERENCES users(user_id),
    assigned_date DATE NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE comments (
    comment_id SERIAL PRIMARY KEY,
    content TEXT NOT NULL,
    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    task_id INTEGER REFERENCES tasks(task_id),
    user_id INTEGER REFERENCES users(user_id)
);

示例SQL输出

问题：显示用户加入最多的日期

SELECT created_at::DATE AS day, COUNT(*) AS user_count
FROM users
GROUP BY day
ORDER BY user_count DESC
LIMIT 1;

问题：显示拥有评论最多任务的项目

SELECT p.project_name, t.task_name, COUNT(c.comment_id) AS comment_count
FROM projects p
JOIN tasks t ON p.project_id = t.project_id
JOIN comments c ON t.task_id = c.task_id
GROUP BY p.project_name, t.task_name
ORDER BY comment_count DESC
LIMIT 1;

问题：拥有Gmail邮箱地址的用户与没有Gmail邮箱地址的用户的比例是多少？

SELECT 
    SUM(CASE WHEN email ILIKE '%@gmail.com%' THEN 1 ELSE 0 END)::FLOAT / NULLIF(SUM(CASE WHEN email NOT ILIKE '%@gmail.com%' THEN 1 ELSE 0 END), 0) AS gmail_ratio
FROM 
    users;

📚 详细文档

基准测试

未训练的新数据集上的结果（通过SQL - Eval）

非常感谢defog团队开源了sql - eval👏

Natural - SQL还可以处理其他模型通常难以应对的复杂复合问题。这里有一个更详细的报告，一个小测试在这里。

📄 许可证

模型权重遵循CC BY - SA 4.0许可协议，并在原始模型Deepseek许可协议的基础上扩展了负责任使用的额外指南。你可以自由使用和修改该模型，甚至用于商业目的。如果你修改了模型权重，例如通过微调，你必须在相同的CC BY - SA 4.0许可协议下公开分享你的更改。

📋 模型信息