alphaaico commited on
Commit
874402c
·
verified ·
1 Parent(s): e2e53f4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +88 -173
README.md CHANGED
@@ -1,202 +1,117 @@
1
  ---
2
- library_name: transformers
3
  tags:
 
 
4
  - unsloth
5
- - trl
6
- - grpo
 
 
 
 
 
 
 
7
  ---
8
 
9
- # Model Card for Model ID
 
 
 
 
 
 
10
 
11
- <!-- Provide a quick summary of what the model is/does. -->
12
 
 
 
 
 
 
13
 
 
14
 
15
- ## Model Details
16
 
17
- ### Model Description
18
 
19
- <!-- Provide a longer summary of what this model is. -->
 
 
 
 
20
 
21
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
22
 
23
- - **Developed by:** [More Information Needed]
24
- - **Funded by [optional]:** [More Information Needed]
25
- - **Shared by [optional]:** [More Information Needed]
26
- - **Model type:** [More Information Needed]
27
- - **Language(s) (NLP):** [More Information Needed]
28
- - **License:** [More Information Needed]
29
- - **Finetuned from model [optional]:** [More Information Needed]
 
 
 
 
 
30
 
31
- ### Model Sources [optional]
 
 
 
 
 
32
 
33
- <!-- Provide the basic links for the model. -->
 
 
 
 
34
 
35
- - **Repository:** [More Information Needed]
36
- - **Paper [optional]:** [More Information Needed]
37
- - **Demo [optional]:** [More Information Needed]
 
38
 
39
- ## Uses
40
 
41
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
 
43
- ### Direct Use
 
 
 
 
44
 
45
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
 
46
 
47
- [More Information Needed]
48
 
49
- ### Downstream Use [optional]
50
 
51
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
 
53
- [More Information Needed]
54
 
55
- ### Out-of-Scope Use
56
 
57
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 
 
58
 
59
- [More Information Needed]
 
 
 
 
60
 
61
- ## Bias, Risks, and Limitations
62
 
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
-
65
- [More Information Needed]
66
-
67
- ### Recommendations
68
-
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
-
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
-
73
- ## How to Get Started with the Model
74
-
75
- Use the code below to get started with the model.
76
-
77
- [More Information Needed]
78
-
79
- ## Training Details
80
-
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- [More Information Needed]
86
-
87
- ### Training Procedure
88
-
89
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
-
91
- #### Preprocessing [optional]
92
-
93
- [More Information Needed]
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
-
122
- [More Information Needed]
123
-
124
- #### Metrics
125
-
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
-
128
- [More Information Needed]
129
-
130
- ### Results
131
-
132
- [More Information Needed]
133
-
134
- #### Summary
135
-
136
-
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- [More Information Needed]
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** [More Information Needed]
151
- - **Hours used:** [More Information Needed]
152
- - **Cloud Provider:** [More Information Needed]
153
- - **Compute Region:** [More Information Needed]
154
- - **Carbon Emitted:** [More Information Needed]
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- [More Information Needed]
161
-
162
- ### Compute Infrastructure
163
-
164
- [More Information Needed]
165
-
166
- #### Hardware
167
-
168
- [More Information Needed]
169
-
170
- #### Software
171
-
172
- [More Information Needed]
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- [More Information Needed]
181
-
182
- **APA:**
183
-
184
- [More Information Needed]
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- [More Information Needed]
191
-
192
- ## More Information [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Authors [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Contact
201
-
202
- [More Information Needed]
 
1
  ---
2
+ base_model: meta-llama/Llama-3.2-3B-Instruct
3
  tags:
4
+ - text-generation-inference
5
+ - transformers
6
  - unsloth
7
+ - llama
8
+ - gguf
9
+ - GRPO
10
+ - meta
11
+ license: apache-2.0
12
+ language:
13
+ - en
14
+ datasets:
15
+ - openai/gsm8k
16
  ---
17
 
18
+ <div align="center">
19
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/669777597cb32718c20d97e9/4emWK_PB-RrifIbrCUjE8.png"
20
+ alt="Title card"
21
+ style="width: 500px;
22
+ height: auto;
23
+ object-position: center top;">
24
+ </div>
25
 
26
+ # Uploaded model
27
 
28
+ - **Developed by:** alphaaico
29
+ - **License:** apache-2.0
30
+ - **Finetuned from model :** meta-llama/Llama-3.2-3B-Instruct
31
+ - **Training Framework:** Unsloth + Hugging Face TRL
32
+ - **Finetuning Techniques:** GRPO + Reward Modelling
33
 
34
+ ## Overview
35
 
36
+ Welcome to the next evolution of AI reasoning! Reason-With-Choice-3B is not just another fine-tuned model, it’s a game-changer. It doesn't just generate reasoning, it chooses whether reasoning is even necessary before delivering an answer. This self-reflective capability allows it to introspect, analyze, and adapt to the complexity of each question, ensuring the most efficient and insightful response possible.
37
 
38
+ Think about it: most AI models blindly generate reasoning even when unnecessary, leading to bloated, redundant responses. Not this one. With its built-in decision-making, Reason-With-Choice-3B determines if deep reasoning is needed or if a direct answer will suffice—bringing unparalleled efficiency and intelligence to your AI-driven applications.
39
 
40
+ ## Key Highlights
41
+ - Reasoning & Self-Reflection: The model first decides if reasoning is necessary and then either provides step-by-step logic or directly answers the question.
42
+ - Structured Output: Responses follow a strict format with <think>, <reflection>, and <answer> sections, ensuring clarity and interpretability.
43
+ - Optimized Training: Trained using GRPO (Guided Reward Policy Optimization) to enforce structured responses and improve decision-making.
44
+ - Efficient Inference: Fine-tuned with Unsloth & Hugging Face’s TRL, ensuring faster inference speeds and optimized resource utilization.
45
 
46
+ ## Prompt Structure
47
 
48
+ The model generates responses in the following structured format:
49
+ ```python
50
+ <think>
51
+ [Detailed reasoning, if required. Otherwise, this section remains empty.]
52
+ </think>
53
+ <reflection>
54
+ [Internal thought process explaining whether reasoning was needed.]
55
+ </reflection>
56
+ <answer>
57
+ [Final response.]
58
+ </answer>
59
+ ```
60
 
61
+ ## Key Features
62
+ - Decision-Making Capability: The model intelligently determines whether reasoning is necessary before answering.
63
+ - Improved Accuracy: Training with reward functions ensures adherence to logical response structure.
64
+ - Structured Outputs: Guarantees that each response follows a predictable and interpretable format.
65
+ - Enhanced Efficiency: Optimized inference with vLLM for fast token generation and low memory footprint.
66
+ - Multi-Use Case Compatibility: Can be used for Q&A systems, logical reasoning tasks, and AI-assisted decision-making.
67
 
68
+ ## Quantization Levels Available
69
+ - q4_k_m
70
+ - q5_k_m
71
+ - q8_0
72
+ - 16-bit (Full Precision)
73
 
74
+ ## Ideal Configuration for Usage
75
+ - Temperature: 0.8
76
+ - Top-p: 0.95
77
+ - Max Tokens: 1024
78
 
79
+ ## Use Cases
80
 
81
+ **Reason-With-Choice-3B is ideal for:**
82
 
83
+ - AI Research: Investigating decision-making and reasoning processes in AI.
84
+ - Conversational AI: Enhancing chatbot intelligence with structured reasoning.
85
+ - Automated Decision Support: Assisting in structured, step-by-step problem-solving.
86
+ - Educational Tools: Providing logical explanations for learning and problem-solving.
87
+ - Business Intelligence: AI-assisted decision-making for operational and strategic planning.
88
 
89
+ ## Limitations & Considerations
90
+ - Domain Adaptation: May require further fine-tuning for domain-specific tasks.
91
+ - Inference Time: Increased processing time when reasoning is necessary.
92
+ - Potential Biases: Outputs depend on training data and may require verification for critical applications.
93
 
94
+ ## License
95
 
96
+ This model is released under the Apache-2.0 license.
97
 
98
+ ## Acknowledgments
99
 
100
+ Special thanks to the Unsloth team for optimizing the fine-tuning pipeline and to Hugging Face’s TRL for enabling advanced fine-tuning techniques.
101
 
102
+ ## Security & Format Considerations
103
 
104
+ This model has been saved in .bin format due to Unsloth's default serialization method. If security is a concern, we recommend converting to .safetensors using:
105
+ ```python
106
+ from transformers import AutoModel
107
+ from safetensors.torch import save_file
108
 
109
+ model = AutoModel.from_pretrained("path/to/model")
110
+ state_dict = model.state_dict()
111
+ save_file(state_dict, "model.safetensors")
112
+ print("Model converted to safetensors successfully.")
113
+ ```
114
 
115
+ Alternatively, GGUF models are available for optimized inference with llama.cpp, exllama, and other runtime frameworks.
116
 
117
+ Choose the format best suited to your security, performance, and deployment requirements.