Create README.md

README.md

@@ -0,0 +1,81 @@
+---
+license: cc-by-4.0
+task_categories:
+- text-generation
+- question-answering
+- table-question-answering
+language:
+- pt
+tags:
+- sql
+- code
+- nlp
+- text2sql
+- text-to-sql
+---
+# Overview
+
+Este dataset  é uma versão traduzida para o português do dataset `b-mc2/sql-create-context`,
+que foi construído a partir dos datasets WikiSQL e Spider. Ele contém exemplos de perguntas
+em português, instruções SQL CREATE TABLE e consultas SQL que respondem às perguntas
+utilizando a instrução CREATE TABLE como contexto.
+
+O principal objetivo deste dataset é ajudar modelos de linguagem natural  em português a gerar consultas
+SQL precisas e contextualizadas, prevenindo a alucinação de nomes de colunas e tabelas, um
+problema comum em datasets de texto para SQL. Ao fornecer apenas a instrução CREATE TABLE
+como contexto, o dataset visa proporcionar uma melhor fundamentação para os modelos sem a
+necessidade de fornecer linhas reais de dados, o que limita o uso de tokens e a exposição
+a dados privados, sensíveis ou proprietários.
+
+Detalhes do Dataset
+
+- **Total de Exemplos:** 78.577
+- **Colunas:**
+  - `pergunta`: A pergunta em linguagem natural.
+  - `contexto`: A instrução SQL CREATE TABLE que fornece o contexto necessário para responder à pergunta.
+  - `resposta`: A consulta SQL que responde à pergunta utilizando o contexto fornecido.
+
+
+# Processo de Tradução
+
+As perguntas foram traduzidas para o português utilizando o modelo `facebook/nllb-200-distilled-1.3B`,
+garantindo que as consultas em linguagem natural mantenham o mesmo significado e contexto das perguntas originais em inglês.
+
+
+# Objetivo e Aplicações
+
+Este dataset é ideal para o treinamento de modelos de linguagem natural para a geração de consultas SQL,
+especialmente em cenários onde a precisão na nomeação de colunas e tabelas é crucial. Ele pode ser usado
+para melhorar a performance de modelos em tarefas de texto-para-SQL, fornecendo um contexto claro e
+evitando erros comuns de alucinação.
+
+# Projetos originais
+```
+@misc{b-mc2_2023_sql-create-context,
+  title   = {sql-create-context Dataset},
+  author  = {b-mc2}, 
+  year    = {2023},
+  url     = {https://huggingface.co/datasets/b-mc2/sql-create-context},
+  note    = {This dataset was created by modifying data from the following sources: \cite{zhongSeq2SQL2017, yu2018spider}.},
+}
+```
+
+
+```
+@article{zhongSeq2SQL2017,
+  author  = {Victor Zhong and Caiming Xiong and Richard Socher},
+  title   = {Seq2SQL: Generating Structured Queries from Natural Language using Reinforcement Learning},
+  journal = {CoRR},
+  volume  = {abs/1709.00103},
+  year    = {2017}
+}
+```
+
+```
+@article{yu2018spider,
+  title   = {Spider: A large-scale human-labeled dataset for complex and cross-domain semantic parsing and text-to-sql task},
+  author  = {Yu, Tao and Zhang, Rui and Yang, Kai and Yasunaga, Michihiro and Wang, Dongxu and Li, Zifan and Ma, James and Li, Irene and Yao, Qingning and Roman, Shanelle and others},
+  journal = {arXiv preprint arXiv:1809.08887},
+  year    = {2018}
+}
+```