avinot/schema-summarization

1---2datasets:3- avinot/schema-summarization_spider4language:5- en6metrics:7- bleu8- rouge9base_model:10- google/long-t5-tglobal-base11pipeline_tag: translation12tags:13- schema-summarization14---15# Model Card for Model ID16In the Text2SQL pipeline, we often pass the schema of our relational database in order for the model and/or agent to generate proper SQL code to query our database based on the user query.17This method yielded promissing results when using small databases containing few tables with few columns. However in practice within the industry, databases may contain thousands of tables each having hundreds of columns. Hense the motivation of building this model.18This model aims to provide the minimum schema (in term of column count) in order for a Text2SQL model and/or agent to generate the appropriate SQL code. All this solely based on the initial user query.19 20## Model Details21 22### Model Description23 24<!-- Provide a longer summary of what this model is. -->25 26 27 28- **Developed by:** [Aymeric Vinot](https://huggingface.co/avinot)29- **Model type:** PEFT model from a encoder-decoder transformer architecture30- **Language(s) (NLP):** english31- **Finetuned from model:** [google/long-t5-tglobal-base](https://huggingface.co/google/long-t5-tglobal-base)32 33### Model Sources [optional]34 35<!-- Provide the basic links for the model. -->36 37- **Repository:** [More Information Needed]38- **Paper [optional]:** [More Information Needed]39- **Demo [optional]:** [More Information Needed]40 41## Uses42 43<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->44 45### Direct Use46 47<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->48 49[More Information Needed]50 51 52## Bias, Risks, and Limitations53 54<!-- This section is meant to convey both technical and sociotechnical limitations. -->55 56[More Information Needed]57 58### Recommendations59 60<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->61 62Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.63 64## How to Get Started with the Model65 66Use the code below to get started with the model.67 68[More Information Needed]69 70## Training Details71 72### Training Data73 74<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->75 76[More Information Needed]77 78### Training Procedure79 80<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->81 82#### Preprocessing [optional]83 84[More Information Needed]85 86 87#### Training Hyperparameters88 89- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->90 91## Evaluation92 93<!-- This section describes the evaluation protocols and provides the results. -->94 95### Testing Data, Factors & Metrics96 97#### Testing Data98 99<!-- This should link to a Dataset Card if possible. -->100 101[More Information Needed]102 103#### Factors104 105<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->106 107[More Information Needed]108 109#### Metrics110 111<!-- These are the evaluation metrics being used, ideally with a description of why. -->112 113[More Information Needed]114 115### Results116 117[More Information Needed]118 119#### Summary120 121 122 123## Model Examination [optional]124 125<!-- Relevant interpretability work for the model goes here -->126 127[More Information Needed]128 129## Technical Specifications [optional]130 131### Model Architecture and Objective132 133[More Information Needed]134 135### Compute Infrastructure136 137[More Information Needed]138 139#### Hardware140 141[More Information Needed]142 143#### Software144 145[More Information Needed]146 147## Citation [optional]148 149<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->150 151**BibTeX:**152 153[More Information Needed]154 155**APA:**156 157[More Information Needed]158 159## Glossary [optional]160 161<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->162 163[More Information Needed]164 165## More Information [optional]166 167[More Information Needed]168 169## Model Card Authors [optional]170 171[More Information Needed]172 173## Model Card Contact174 175[More Information Needed]