wasmdashai commited on
Commit
1c056e8
·
verified ·
1 Parent(s): 867dec7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +70 -158
README.md CHANGED
@@ -3,197 +3,109 @@ library_name: transformers
3
  pipeline_tag: text-generation
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]
 
3
  pipeline_tag: text-generation
4
  ---
5
 
 
6
 
7
+ # Wasm-Coder-8B-Instruct-V1
8
 
9
+ **Wasm-Coder-8B-Instruct-V1** is an 8-billion parameter instruction-tuned language model developed by [wasmdashai](https://huggingface.co/wasmdashai), optimized for WebAssembly (Wasm)-oriented programming tasks, code generation, and technical reasoning. It is designed to help developers working on edge computing, browser-based runtimes, and low-level systems programming.
10
 
11
+ ---
12
 
13
+ ## 🚀 Introduction
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
 
15
+ `Wasm-Coder-8B-Instruct-V1` is part of the Wasm-Coder family—models specifically tailored for tasks involving WebAssembly, Rust, C/C++, and embedded systems programming. The model has been instruction-tuned on a diverse dataset combining code, documentation, compiler logs, and structured code reasoning tasks.
16
 
17
+ ### Key Features:
18
 
19
+ * Strong performance in **code synthesis**, **bug fixing**, and **code explanation**, especially for Rust and WebAssembly projects.
20
+ * Efficient for **edge devices**, **browsers**, and **serverless runtimes**.
21
+ * Based on a powerful transformer architecture with performance enhancements such as RoPE and SwiGLU.
22
+ * Trained with instruction-following datasets for natural conversations and multi-turn reasoning.
23
+ * Supports **long-context processing** (up to 32,768 tokens) with optional rope scaling.
24
 
25
+ ---
26
 
27
+ ## 🧠 Model Details
28
 
29
+ * **Architecture**: Decoder-only transformer
30
+ * **Parameters**: 8B
31
+ * **Training**: Pretrained + Instruction fine-tuning
32
+ * **Supported Context Length**: 32,768 tokens
33
+ * **Specialization**: WebAssembly, Rust, C/C++, Systems Programming
34
+ * **Components**:
35
 
36
+ * RoPE (Rotary Positional Embeddings)
37
+ * SwiGLU activation
38
+ * RMSNorm
39
+ * QKV Attention Bias
40
 
41
+ ---
 
 
 
 
42
 
43
+ ## 💻 Quickstart
44
 
45
+ Install dependencies:
46
 
47
+ ```bash
48
+ pip install --upgrade transformers
49
+ ```
50
 
51
+ Example code to load and run the model:
52
 
53
+ ```python
54
+ from transformers import AutoTokenizer, AutoModelForCausalLM
55
 
56
+ model_name = "wasmdashai/Wasm-Coder-8B-Instruct-V1"
57
 
58
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
59
+ model = AutoModelForCausalLM.from_pretrained(
60
+ model_name,
61
+ torch_dtype="auto",
62
+ device_map="auto"
63
+ )
64
 
65
+ prompt = "Write a Rust function that compiles to WebAssembly and adds two numbers."
66
 
67
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
68
+ outputs = model.generate(**inputs, max_new_tokens=512)
69
+ result = tokenizer.decode(outputs[0], skip_special_tokens=True)
70
 
71
+ print(result)
72
+ ```
73
 
74
+ ---
75
 
76
+ ## 📚 Long-Context Support
77
 
78
+ To process long inputs (e.g., full source files or compiler traces), use **YaRN-based RoPE scaling**:
79
 
80
+ Add this to `config.json`:
81
 
82
+ ```json
83
+ {
84
+ "rope_scaling": {
85
+ "type": "yarn",
86
+ "factor": 4.0,
87
+ "original_max_position_embeddings": 32768
88
+ }
89
+ }
90
+ ```
91
 
92
+ ---
93
 
94
+ ## 🔧 Use Cases
95
 
96
+ * WebAssembly code generation and debugging
97
+ * Rust/C++ code explanation and transformation
98
+ * Embedded/IoT code support
99
+ * Smart contract logic for blockchain environments using Wasm
100
+ * Code agents and assistants running in browsers
101
 
102
+ ---
103
 
104
+ ## 📬 Contact
105
 
106
+ 📧 For questions, collaborations, or commercial licensing:
107
 
108
109
 
110
+ ---
111