tdoehmen commited on
Commit
99e6a3b
1 Parent(s): 6ceb70e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -3
README.md CHANGED
@@ -5,7 +5,7 @@ license: cc-by-4.0
5
 
6
  ## Model Description
7
 
8
- In this repository we are introducing **schemapile-fk-starcoder**. It's a language model, based on [BigCode/starcoder](https://huggingface.co/bigcode/starcoder) fine-tuned for predicting foreign key relationships in relational database schemas.
9
 
10
  ## Training Data
11
 
@@ -13,7 +13,7 @@ Forein key pairs extracted from [SchemaPile](https://zenodo.org/records/10931803
13
 
14
  ## Evaluation Data
15
 
16
- We evaluate the foreign key detection accuracy of [schemapile-fk-starcoder](https://huggingface.co/tdoehmen/schemapile-fk-starcoder) and [schemapile-fk-t5](https://huggingface.co/tdoehmen/schemapile-fk-t5) on schemas from [Spider](https://yale-lily.github.io/spider), [BIRD-SQL](https://bird-bench.github.io/), and [CTU PRLR](https://arxiv.org/abs/1511.03086).
17
 
18
  <img src="https://cdn-uploads.huggingface.co/production/uploads/616ea71919594606318887e9/6ouh4u6PFQlY8prLrAm4l.png" alt="eval" width="400"/>
19
 
@@ -29,6 +29,8 @@ The model was trained, using 4x A100 40GB GPUs with DeepSpeed ZeRO-3 offloading,
29
  - warmup_ratio: 0.03
30
  - weight_decay: 0.0
31
 
 
 
32
  ## How to Use
33
 
34
  We recommend using the provided prompt template and constrained output using jsonformer:
@@ -49,4 +51,4 @@ Example Output:
49
  'referencedColumn': 'address_id'}
50
  ```
51
 
52
- To run the model locally, we recommend using our end-to-end [Example Notebook](https://github.com/amsterdata/schemapile/blob/main/experiments/foreign_key_detection/schemapile-fk-starcoder-example.ipynb) (requires a single A100 40GB).
 
5
 
6
  ## Model Description
7
 
8
+ In this repository we are introducing **starcoder-schemapile-fk**. It's a language model, based on [BigCode/starcoder](https://huggingface.co/bigcode/starcoder) fine-tuned for predicting foreign key relationships in relational database schemas.
9
 
10
  ## Training Data
11
 
 
13
 
14
  ## Evaluation Data
15
 
16
+ We evaluate the foreign key detection accuracy of [starcoder-schemapile-fk](https://huggingface.co/tdoehmen/starcoder-schemapile-fk) and [t5-schemapile-fk](https://huggingface.co/tdoehmen/t5-schemapile-fk) on schemas from [Spider](https://yale-lily.github.io/spider), [BIRD-SQL](https://bird-bench.github.io/), and [CTU PRLR](https://arxiv.org/abs/1511.03086).
17
 
18
  <img src="https://cdn-uploads.huggingface.co/production/uploads/616ea71919594606318887e9/6ouh4u6PFQlY8prLrAm4l.png" alt="eval" width="400"/>
19
 
 
29
  - warmup_ratio: 0.03
30
  - weight_decay: 0.0
31
 
32
+ [Training Code](https://github.com/amsterdata/schemapile/tree/main/experiments/foreign_key_detection/starcoder_finetune)
33
+
34
  ## How to Use
35
 
36
  We recommend using the provided prompt template and constrained output using jsonformer:
 
51
  'referencedColumn': 'address_id'}
52
  ```
53
 
54
+ To run the model locally, we recommend using our end-to-end [Example Notebook](https://github.com/amsterdata/schemapile/blob/main/experiments/foreign_key_detection/starcoder-schemapile-fk-example.ipynb) (requires a single A100 40GB).