yarenty commited on
Commit
d7706c8
·
verified ·
1 Parent(s): 760522b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +74 -169
README.md CHANGED
@@ -1,199 +1,104 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
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
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
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
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
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
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
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
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
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. -->
174
 
175
- **BibTeX:**
 
176
 
177
- [More Information Needed]
 
 
178
 
179
- **APA:**
 
 
 
180
 
181
- [More Information Needed]
182
 
183
- ## Glossary [optional]
 
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
 
186
 
187
- [More Information Needed]
188
 
189
- ## More Information [optional]
 
 
 
 
 
 
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
 
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
 
 
 
 
 
 
 
 
 
198
 
199
- [More Information Needed]
 
 
1
  ---
2
+ license: llama3.2
3
+ base_model: meta-llama/Llama-3.2-8B-Instruct
4
+ tags:
5
+ - text-generation
6
+ - instruction
7
+ - datafusion
8
+ - rust
9
+ - code
10
  ---
11
 
12
+ ![transformers](https://img.shields.io/badge/transformers-yes-green)
13
+ ![Downloads](https://img.shields.io/endpoint?url=https://huggingface.co/api/models/yarenty/llama32-datafusion-instruct/badge/downloads)
14
+ ![Likes](https://img.shields.io/endpoint?url=https://huggingface.co/api/models/yarenty/llama32-datafusion-instruct/badge/likes)
15
 
16
+ **Author:** yarenty
17
+ **Model type:** Llama 3.2 (fine-tuned)
18
+ **Task:** Instruction-following, code Q/A, DataFusion expert assistant
19
+ **License:** Apache 2.0
20
+ **Visibility:** Public
21
 
22
+ ---
23
 
24
 
25
+ # Llama 3.2 DataFusion Instruct
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
 
27
+ This model is a fine-tuned version of **meta-llama/Llama-3.2-8B-Instruct**, specialized for the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/) ecosystem. It's designed to be a helpful assistant for developers, answering technical questions, generating code, and explaining concepts related to DataFusion, Arrow.rs, Ballista, and the broader Rust data engineering landscape.
28
 
29
+ **GGUF Version:** For quantized, low-resource deployment, you can find the GGUF version [here](<https://huggingface.co/yarenty/llama32-datafusion-instruct-gguf>).
30
 
31
+ ## Model Description
32
 
33
+ This model was fine-tuned on a curated dataset of high-quality question-answer pairs and instruction-following examples sourced from the official DataFusion documentation, source code, mailing lists, and community discussions.
34
 
35
+ - **Model Type:** Instruction-following Large Language Model (LLM)
36
+ - **Base Model:** `meta-llama/Llama-3.2-8B-Instruct`
37
+ - **Primary Use:** Developer assistant for the DataFusion ecosystem.
38
 
39
+ ## Prompt Template
40
 
41
+ To get the best results, format your prompts using the following instruction template.
42
 
43
+ ```
44
+ ### Instruction:
45
+ {Your question or instruction here}
46
 
47
+ ### Response:
48
+ ```
49
 
50
+ ## Example Usage
51
 
52
+ ```python
53
+ from transformers import AutoModelForCausalLM, AutoTokenizer
54
 
55
+ model_id = "yarenty/llama32-datafusion-instruct"
56
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
57
+ model = AutoModelForCausalLM.from_pretrained(model_id, device_map="auto")
58
 
59
+ # The model was trained with a specific instruction template.
60
+ # For optimal performance, your prompt should follow this structure.
61
+ prompt_template = """### Instruction:
62
+ How do I register a Parquet file in DataFusion?
63
 
64
+ ### Response:"""
65
 
66
+ inputs = tokenizer(prompt_template, return_tensors="pt").to(model.device)
67
+ outputs = model.generate(**inputs, max_new_tokens=256, eos_token_id=tokenizer.eos_token_id)
68
 
69
+ # Decode the output, skipping special tokens and the prompt
70
+ prompt_length = inputs["input_ids"].shape[1]
71
+ print(tokenizer.decode(outputs[0][prompt_length:], skip_special_tokens=True))
72
+ ```
73
 
74
+ ## Training Procedure
75
 
76
+ - **Hardware:** Trained on 1x NVIDIA A100 GPU.
77
+ - **Training Script:** Custom script using `transformers.SFTTrainer`.
78
+ - **Key Hyperparameters:**
79
+ - Epochs: 3
80
+ - Learning Rate: 2e-5
81
+ - Batch Size: 4
82
+ - **Dataset:** A curated dataset of ~5,000 high-quality QA pairs and instructions related to DataFusion. Data was cleaned and deduplicated as per the notes in `pitfalls.md`.
83
 
84
+ ## Intended Use & Limitations
85
 
86
+ - **Intended Use:** This model is intended for developers and data engineers working with DataFusion. It can be used for code generation, debugging assistance, and learning the library. It can also serve as a strong base for further fine-tuning on more specialized data.
87
+ - **Limitations:** The model's knowledge is limited to the data it was trained on. It may produce inaccurate or outdated information for rapidly evolving parts of the library. It is not a substitute for official documentation or expert human review.
88
 
89
+ ## Citation
90
 
91
+ If you find this model useful in your work, please cite:
92
+ ```
93
+ @misc{yarenty_2025_llama32_datafusion_instruct,
94
+ author = {yarenty},
95
+ title = {Llama 3.2 DataFusion Instruct},
96
+ year = {2025},
97
+ publisher = {Hugging Face},
98
+ journal = {Hugging Face repository},
99
+ howpublished = {\url{https://huggingface.co/yarenty/llama32-datafusion-instruct}}
100
+ }
101
+ ```
102
 
103
+ ## Contact
104
+ For questions or feedback, please open an issue on the Hugging Face repository or the [source GitHub repository](https://github.com/yarenty/trainer).