Update README.md
Browse files
README.md
CHANGED
@@ -1,199 +1,89 @@
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
-
tags:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
#
|
|
|
|
|
7 |
|
8 |
-
|
9 |
|
|
|
|
|
10 |
|
|
|
11 |
|
12 |
-
|
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 |
-
|
|
|
|
|
168 |
|
169 |
-
|
170 |
|
171 |
-
|
|
|
172 |
|
173 |
-
|
|
|
|
|
|
|
|
|
174 |
|
175 |
-
|
|
|
176 |
|
177 |
-
|
|
|
178 |
|
179 |
-
|
|
|
180 |
|
181 |
-
|
|
|
|
|
|
|
|
|
182 |
|
183 |
-
|
|
|
184 |
|
185 |
-
|
|
|
|
|
|
|
|
|
186 |
|
187 |
-
|
188 |
|
189 |
-
|
|
|
|
|
|
|
190 |
|
191 |
-
|
|
|
192 |
|
193 |
-
|
|
|
194 |
|
195 |
-
|
196 |
|
197 |
-
|
|
|
198 |
|
199 |
-
|
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
+
tags:
|
4 |
+
- reasoning
|
5 |
+
- transformers
|
6 |
+
- maths
|
7 |
+
- brahmai
|
8 |
+
license: apache-2.0
|
9 |
+
datasets:
|
10 |
+
- brahmairesearch/x1-exp
|
11 |
+
language:
|
12 |
+
- en
|
13 |
+
base_model:
|
14 |
+
- Qwen/Qwen2.5-7B
|
15 |
+
pipeline_tag: text-generation
|
16 |
---
|
17 |
|
18 |
+
# x1 | BRAHMAI
|
19 |
+
**7 Billion Parameters | v0.1**
|
20 |
+
![x1-7B-v0.1](https://i.ibb.co/dJgyV8H/image.png)
|
21 |
|
22 |
+
Introducing **x1-7B-v0.1**, the first Large Language Model by [BRAHMAI](https://brahmai.in) with built-in reasoning capabilities. Based on the powerful **Qwen2.5 7B** architecture, this model has been fine-tuned using a synthetic dataset generated from open-source models across multiple datasets and custom agentic pipelines.
|
23 |
|
24 |
+
### Note:
|
25 |
+
As the first iteration of this model, **x1-7B-v0.1** demonstrates strong performance in answering reasoning-based questions, making it a valuable tool for advancing further development. When reasoning, the model encapsulates its thought process within `<thinking>` and `</thinking>` tags before delivering the final response.
|
26 |
|
27 |
+
---
|
28 |
|
29 |
+
### Known Limitations
|
30 |
+
While promising, this model has its quirks:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
31 |
|
32 |
+
1. **Unexpected Behavior with Simple Inputs:** For instance, it may break when simply greeted with "Hi."
|
33 |
+
2. **Excessive Reasoning:** Even for basic queries, the model often engages in elaborate reasoning chains.
|
34 |
+
3. **Repetitive Responses:** Occasionally, after providing an answer, the model gets stuck in a loop, repeating patterns.
|
35 |
|
36 |
+
---
|
37 |
|
38 |
+
### Example Conversations
|
39 |
+
**Note:** All examples were tested with `max_new_tokens` set to 512.
|
40 |
|
41 |
+
#### Example 1: Comparing 9.24 and 9.8
|
42 |
+
```
|
43 |
+
USER: What is larger? 9.24 or 9.8?
|
44 |
+
ASSISTANT: <thinking>
|
45 |
+
To determine which number is larger between 9.24 and 9.8, we can compare the digits in each place value.
|
46 |
|
47 |
+
1. Both numbers have the same digit in the ones place (9).
|
48 |
+
2. In the tenths place, 9.24 has a 2, while 9.8 has an 8. Since 8 is greater than 2, 9.8 is larger than 9.24.
|
49 |
|
50 |
+
Thus, 9.8 is larger than 9.24.
|
51 |
+
</thinking>
|
52 |
|
53 |
+
9.8 is larger than 9.24.
|
54 |
+
```
|
55 |
|
56 |
+
#### Example 2: The "Hi" Scenario
|
57 |
+
```
|
58 |
+
USER: Hi
|
59 |
+
ASSISTANT: <thinking>
|
60 |
+
The user is asking for a list of 100 words that start with the letter "S" and end with the letter "e". To generate this list, I need to think of words that fit these criteria.
|
61 |
|
62 |
+
I will start by brainstorming words that begin with "S" and end with "e". Some examples include "sage", "sneeze", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve", "sieve",
|
63 |
+
```
|
64 |
|
65 |
+
#### Example 3: Counting "R"s in "STRAWBERRY"
|
66 |
+
```
|
67 |
+
USER: How many R's are in STRAWBERRY?
|
68 |
+
ASSISTANT: <thinking>
|
69 |
+
To determine the number of "R"s in "STRAWBERRY," I’ll count the occurrences of "R."
|
70 |
|
71 |
+
The word "STRAWBERRY" consists of the following letters: S, T, R, A, W, B, E, R, R, Y.
|
72 |
|
73 |
+
Counting the "R"s:
|
74 |
+
- The first "R" is in the third position.
|
75 |
+
- The second "R" is in the eighth position.
|
76 |
+
- The third "R" is in the ninth position.
|
77 |
|
78 |
+
Therefore, there are 3 "R"s in "STRAWBERRY."
|
79 |
+
</thinking>
|
80 |
|
81 |
+
There are 3 "R"s in the word "STRAWBERRY."
|
82 |
+
```
|
83 |
|
84 |
+
---
|
85 |
|
86 |
+
### Moving Forward
|
87 |
+
We're committed to refining this model. Stay tuned for improvements as we continue to fine-tune it.
|
88 |
|
89 |
+
If you have any questions or feedback, feel free to reach out to us at [[email protected]](mailto:[email protected]).
|