Update README.md
Browse files
README.md
CHANGED
|
@@ -1,199 +1,91 @@
|
|
| 1 |
-
---
|
| 2 |
library_name: transformers
|
| 3 |
-
tags: []
|
| 4 |
---
|
| 5 |
|
| 6 |
-
# Model Card for
|
| 7 |
-
|
| 8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
| 9 |
|
|
|
|
| 10 |
|
|
|
|
| 11 |
|
| 12 |
## Model Details
|
| 13 |
|
| 14 |
### Model Description
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
|
|
|
|
| 19 |
|
| 20 |
-
- **Developed by
|
| 21 |
-
- **
|
| 22 |
-
- **
|
| 23 |
-
- **
|
| 24 |
-
- **
|
| 25 |
-
- **
|
| 26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 27 |
|
| 28 |
-
### Model Sources
|
| 29 |
|
| 30 |
-
|
|
|
|
| 31 |
|
| 32 |
-
-
|
| 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 |
-
|
| 43 |
|
| 44 |
-
|
|
|
|
|
|
|
| 45 |
|
| 46 |
-
|
|
|
|
|
|
|
| 47 |
|
| 48 |
-
|
| 49 |
|
| 50 |
-
|
|
|
|
|
|
|
|
|
|
| 51 |
|
| 52 |
### Out-of-Scope Use
|
| 53 |
|
| 54 |
-
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
-
|
| 57 |
|
| 58 |
## Bias, Risks, and Limitations
|
| 59 |
|
| 60 |
-
|
| 61 |
|
| 62 |
-
|
|
|
|
|
|
|
| 63 |
|
| 64 |
### Recommendations
|
| 65 |
|
| 66 |
-
|
|
|
|
|
|
|
| 67 |
|
| 68 |
-
|
| 69 |
|
| 70 |
## How to Get Started with the Model
|
| 71 |
|
| 72 |
-
|
| 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 |
-
|
|
|
|
| 198 |
|
| 199 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
library_name: transformers
|
| 2 |
+
tags: [causal-lm, autoregressive, instruction-tuned, text-generation, reasoning-switch, thoughswitch]
|
| 3 |
---
|
| 4 |
|
| 5 |
+
# Model Card for BrainWave‑ML/ThoughtSwitch‑V1‑1.7b‑Instruct
|
|
|
|
|
|
|
| 6 |
|
| 7 |
+
Welcome to the **ThoughtSwitch V1 (1.7B, Instruct‑tuned)**—a next-generation causal language model designed to **dynamically toggle between Thinking and Non‑Thinking modes** according to the prompt’s intent, now fine-tuned for instruction-following behavior.
|
| 8 |
|
| 9 |
+
---
|
| 10 |
|
| 11 |
## Model Details
|
| 12 |
|
| 13 |
### Model Description
|
| 14 |
|
| 15 |
+
ThoughSwitch V1 (Instruct) builds upon the original ThoughtSwitch architecture and has been fine-tuned for instruction compliance and user alignment. This model autonomously adjusts its cognitive depth:
|
| 16 |
|
| 17 |
+
- **Thinking Mode**: For tasks demanding a reasoning process, step-by-step logic, or meticulous analysis.
|
| 18 |
+
- **Non‑Thinking Mode**: For casual responses, fluent writing, or scenarios where fast output is more valuable than deep reasoning.
|
| 19 |
|
| 20 |
+
- **Developed by**: BrainWave‑ML
|
| 21 |
+
- **Model type**: Causal Language Model (GPT-style)
|
| 22 |
+
- **Instruction tuning**: Yes — adapted for instruction-following tasks
|
| 23 |
+
- **Language(s)**: Primarily English
|
| 24 |
+
- **License**: Not specified on the Hub; please include (e.g. Apache 2.0)
|
| 25 |
+
- **Parameters**: ~1.72 B parameters :contentReference[oaicite:0]{index=0}
|
|
|
|
| 26 |
|
| 27 |
+
### Model Sources
|
| 28 |
|
| 29 |
+
- **Repository**: [Model Page on Hugging Face](https://huggingface.co/BrainWave-ML/ThoughtSwitch-V1-1.7b-Instruct) :contentReference[oaicite:1]{index=1}
|
| 30 |
+
- **Quantizations available**: There's a related GGUF quantized version (by mradermacher), based on this model :contentReference[oaicite:2]{index=2}
|
| 31 |
|
| 32 |
+
---
|
|
|
|
|
|
|
| 33 |
|
| 34 |
## Uses
|
| 35 |
|
|
|
|
|
|
|
| 36 |
### Direct Use
|
| 37 |
|
| 38 |
+
Use ThoughtSwitch V1 (Instruct) for:
|
| 39 |
|
| 40 |
+
- Generating responses with context-dependent reasoning depth
|
| 41 |
+
- Instruction-following in educational, NLP-assistive, or conversational settings
|
| 42 |
+
- Creative content generation with controllable thoroughness
|
| 43 |
|
| 44 |
+
Example prompts:
|
| 45 |
+
- **Thinking Mode**: `"Explain step by step how to solve this puzzle: ..."`
|
| 46 |
+
- **Non‑Thinking Mode**: `"Write a quick summary of today's news."`
|
| 47 |
|
| 48 |
+
### Downstream Use
|
| 49 |
|
| 50 |
+
Great for:
|
| 51 |
+
|
| 52 |
+
- Becoming integrated into tutoring systems, chatbots, or decision-support agents
|
| 53 |
+
- Fine-tuning further for specialized tasks like complex QA or fast content generation
|
| 54 |
|
| 55 |
### Out-of-Scope Use
|
| 56 |
|
| 57 |
+
Not recommended for:
|
| 58 |
+
|
| 59 |
+
- Sensitive or factual-critical domains (medical, legal, financial) without external validation
|
| 60 |
+
- Languages or domains not well represented in its training data
|
| 61 |
|
| 62 |
+
---
|
| 63 |
|
| 64 |
## Bias, Risks, and Limitations
|
| 65 |
|
| 66 |
+
ThoughSwitch may:
|
| 67 |
|
| 68 |
+
- Reflect biases in training sources (web, books, synthetic tasks)
|
| 69 |
+
- Occasionally hallucinate or give logically flawed outputs, including misinterpreting the reasoning cue
|
| 70 |
+
- Need safeguards to ensure appropriate mode switching in ambiguous prompts
|
| 71 |
|
| 72 |
### Recommendations
|
| 73 |
|
| 74 |
+
- Validate important responses with a reason-check or external verification
|
| 75 |
+
- Tailor prompts clearly to favor intended mode (e.g. "Think step by step…")
|
| 76 |
+
- Monitor performance in ambiguous or critical contexts; consider fine-tuning for those areas
|
| 77 |
|
| 78 |
+
---
|
| 79 |
|
| 80 |
## How to Get Started with the Model
|
| 81 |
|
| 82 |
+
```python
|
| 83 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
|
| 85 |
+
model = AutoModelForCausalLM.from_pretrained("BrainWave-ML/ThoughtSwitch-V1-1.7b-Instruct")
|
| 86 |
+
tokenizer = AutoTokenizer.from_pretrained("BrainWave-ML/ThoughtSwitch-V1-1.7b-Instruct")
|
| 87 |
|
| 88 |
+
prompt = "Think step by step: Why does ice float on water?"
|
| 89 |
+
inputs = tokenizer(prompt, return_tensors="pt")
|
| 90 |
+
outputs = model.generate(**inputs, max_new_tokens=100)
|
| 91 |
+
print(tokenizer.decode(outputs[0], skip_special_tokens=True))
|