joonavel commited on
Commit
db4cfaa
·
verified ·
1 Parent(s): 1680a25

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -102
README.md CHANGED
@@ -1,12 +1,25 @@
1
  ---
2
  base_model: unsloth/qwen2.5-coder-32b-instruct-bnb-4bit
3
  library_name: peft
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
  <!-- Provide a quick summary of what the model is/does. -->
 
9
 
 
10
 
11
 
12
  ## Model Details
@@ -17,43 +30,31 @@ library_name: peft
17
 
18
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
 
38
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
39
 
40
- ### Direct Use
41
 
42
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
 
45
 
46
- ### Downstream Use [optional]
47
 
48
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
 
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
@@ -67,11 +68,6 @@ library_name: peft
67
 
68
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
 
76
  ## Training Details
77
 
@@ -85,10 +81,13 @@ Use the code below to get started with the model.
85
 
86
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
 
88
- #### Preprocessing [optional]
 
89
 
90
- [More Information Needed]
91
 
 
 
92
 
93
  #### Training Hyperparameters
94
 
@@ -100,74 +99,6 @@ Use the code below to get started with the model.
100
 
101
  [More Information Needed]
102
 
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
  ## Citation [optional]
172
 
173
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
1
  ---
2
  base_model: unsloth/qwen2.5-coder-32b-instruct-bnb-4bit
3
  library_name: peft
4
+ datasets:
5
+ - 100suping/ko-bird-sql-schema
6
+ - won75/text_to_sql_ko
7
+ language:
8
+ - ko
9
+ pipeline_tag: text-generation
10
+ tags:
11
+ - SQL
12
+ - lora
13
+ - adapter
14
+ - instruction-tuning
15
  ---
16
 
17
+ # 100suping/Qwen2.5-Coder-34B-Instruct-kosql-adapter
18
 
19
  <!-- Provide a quick summary of what the model is/does. -->
20
+ This Repo contains **LoRA (Low-Rank Adaptation) Adapter** for [unsloth/qwen2.5-coder-32b-instruct]
21
 
22
+ This adapter was created through **instruction tuning**.
23
 
24
 
25
  ## Model Details
 
30
 
31
 
32
 
33
+ - **Base Model:** unsloth/Qwen2.5-Coder-32B-Instruct
34
+ - **Task:** Instruction Following(Korean)
35
+ - **Language:** English (or relevant language)
36
+ - **Training Data:** 100suping/ko-bird-sql-schema, won75/text_to_sql_ko
37
+ - **Model type:** Causal Language Models.
38
+ - **Language(s) (NLP):** Multi-Language
 
39
 
40
+ ## How to Get Started with the Model
 
 
 
 
 
 
 
 
41
 
42
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
+ To use this LoRA adapter, refer to the following code:
44
 
45
+ ### Prompt
46
 
47
  <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
 
49
+ ```
50
+ ```
51
 
52
+ ### Inference
53
 
54
  <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
55
 
56
+ ```
57
+ ```
 
 
 
 
 
58
 
59
  ## Bias, Risks, and Limitations
60
 
 
68
 
69
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
 
 
 
 
 
 
71
 
72
  ## Training Details
73
 
 
81
 
82
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
83
 
84
+ ```
85
+ ```
86
 
87
+ #### Preprocessing [optional]
88
 
89
+ ```
90
+ ```
91
 
92
  #### Training Hyperparameters
93
 
 
99
 
100
  [More Information Needed]
101
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
102
  ## Citation [optional]
103
 
104
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->