Hugging Face's logo

avinot
/
schema-summarization

Translation
Safetensors
English
longt5
schema-summarization
Model card Files
xet
Community
schema-summarization / README.md
avinot's picture
avinot
Update README.md
8743464 verified
preview code
|
raw
history blame
5.78 kB
metadata
datasets:
  - avinot/schema-summarization_spider
language:
  - en
metrics:
  - bleu
  - rouge
base_model:
  - google/long-t5-tglobal-base
pipeline_tag: translation
tags:
  - schema-summarization

Model Card for Model ID

In 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. This 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. This 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.

Model Details

Model Description

  • Developed by: [More Information Needed]
  • Funded by [optional]: [More Information Needed]
  • Shared by [optional]: [More Information Needed]
  • Model type: [More Information Needed]
  • Language(s) (NLP): [More Information Needed]
  • License: [More Information Needed]
  • Finetuned from model [optional]: [More Information Needed]

Model Sources [optional]

  • Repository: [More Information Needed]
  • Paper [optional]: [More Information Needed]
  • Demo [optional]: [More Information Needed]

Uses

Direct Use

[More Information Needed]

Downstream Use [optional]

[More Information Needed]

Out-of-Scope Use

[More Information Needed]

Bias, Risks, and Limitations

[More Information Needed]

Recommendations

Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.

How to Get Started with the Model

Use the code below to get started with the model.

[More Information Needed]

Training Details

Training Data

[More Information Needed]

Training Procedure

Preprocessing [optional]

[More Information Needed]

Training Hyperparameters

  • Training regime: [More Information Needed]

Speeds, Sizes, Times [optional]

[More Information Needed]

Evaluation

Testing Data, Factors & Metrics

Testing Data

[More Information Needed]

Factors

[More Information Needed]

Metrics

[More Information Needed]

Results

[More Information Needed]

Summary

Model Examination [optional]

[More Information Needed]

Environmental Impact

Carbon emissions can be estimated using the Machine Learning Impact calculator presented in Lacoste et al. (2019).

  • Hardware Type: [More Information Needed]
  • Hours used: [More Information Needed]
  • Cloud Provider: [More Information Needed]
  • Compute Region: [More Information Needed]
  • Carbon Emitted: [More Information Needed]

Technical Specifications [optional]

Model Architecture and Objective

[More Information Needed]

Compute Infrastructure

[More Information Needed]

Hardware

[More Information Needed]

Software

[More Information Needed]

Citation [optional]

BibTeX:

[More Information Needed]

APA:

[More Information Needed]

Glossary [optional]

[More Information Needed]

More Information [optional]

[More Information Needed]

Model Card Authors [optional]

[More Information Needed]

Model Card Contact

[More Information Needed]