prithivMLmods commited on
Commit
f6f66c9
·
verified ·
1 Parent(s): 648a1a1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +67 -175
README.md CHANGED
@@ -1,199 +1,91 @@
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
  library_name: transformers
3
+ tags:
4
+ - text-generation-inference
5
+ - code
6
+ - math
7
+ - distill
8
+ - r1
9
+ license: apache-2.0
10
+ language:
11
+ - en
12
+ base_model:
13
+ - Qwen/Qwen2.5-1.5B-Instruct
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
+ # **Castula-U2-QwenRe-1.5B**
18
 
19
+ > **Castula-U2-QwenRe-1.5B** is a **compact, multilingual reasoning model** fine-tuned from **Qwen-1.5B**, excelling in **mathematical problem solving**, **logical reasoning**, **code generation**, and **general-purpose tasks**. Its step-by-step reasoning and bilingual fluency make it ideal for educational systems, coding assistants, and lightweight reasoning applications.
20
 
21
+ ## **Key Features**
22
 
23
+ 1. **Advanced Step-by-Step Reasoning**
24
+ Fine-tuned to produce intermediate steps for math, logic, and code problems, offering transparency and interpretability crucial for education, coding help, and diagnostics.
25
 
26
+ 2. **Multilingual Proficiency (English + Chinese)**
27
+ Understands and solves problems in **both English and Simplified Chinese**, making it accessible in diverse learning and working environments.
28
 
29
+ 3. **Compact Yet Versatile (1.5B Parameters)**
30
+ Small enough for **low-resource environments**, yet capable of **math**, **logical puzzles**, **basic coding tasks**, and general comprehension, balancing performance and efficiency.
31
 
32
+ 4. **Structured Computation & Problem Solving**
33
+ Mirrors human-like multi-step problem-solving, making solutions easy to follow, debug, or verify.
34
 
35
+ ## **Quickstart with Transformers**
36
 
37
+ ```python
38
+ from transformers import AutoModelForCausalLM, AutoTokenizer
 
 
 
 
 
39
 
40
+ model_name = "prithivMLmods/Castula-U2-QwenRe-1.5B"
41
 
42
+ model = AutoModelForCausalLM.from_pretrained(
43
+ model_name,
44
+ torch_dtype="auto",
45
+ device_map="auto"
46
+ )
47
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
48
 
49
+ prompt = "Solve: A train travels 180 km in 3 hours. What is its average speed?"
50
+ messages = [
51
+ {"role": "system", "content": "You are a helpful tutor skilled in solving math, logic, and code problems with step-by-step explanations."},
52
+ {"role": "user", "content": prompt}
53
+ ]
54
+ text = tokenizer.apply_chat_template(
55
+ messages,
56
+ tokenize=False,
57
+ add_generation_prompt=True
58
+ )
59
+ model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
60
 
61
+ generated_ids = model.generate(
62
+ **model_inputs,
63
+ max_new_tokens=512
64
+ )
65
+ generated_ids = [
66
+ output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
67
+ ]
68
 
69
+ response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
70
+ ```
71
 
72
+ ## **Intended Use**
73
 
74
+ - **Math & Logic Tutoring**: Solves problems with explanations ideal for students and educators.
75
+ - **Code Assistant**: Helps with beginner-to-intermediate code generation and understanding.
76
+ - **Bilingual Apps**: Educational tools in **English** and **Chinese** for a global audience.
77
+ - **Lightweight Reasoning Systems**: Deployable in **mobile apps**, **browser extensions**, and **edge devices**.
78
 
79
+ ## **Limitations**
80
 
81
+ 1. **Domain Specialization**:
82
+ Best in math, logic, and code. Performance may degrade in highly creative or abstract language tasks.
83
 
84
+ 2. **Compact Scale**:
85
+ While efficient, may underperform larger models in deeply complex reasoning or long-context tasks.
86
 
87
+ 3. **Inherited Bias**:
88
+ May reflect biases from the base model (Qwen-1.5B); outputs should be verified for sensitive or critical uses.
89
 
90
+ 4. **Prompt Sensitivity**:
91
+ Structured, clearly stated inputs produce significantly better outputs.