Update README.md
Browse files
README.md
CHANGED
|
@@ -1,202 +1,143 @@
|
|
| 1 |
---
|
| 2 |
base_model: unsloth/Qwen3-0.6B
|
| 3 |
library_name: peft
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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 |
-
|
| 15 |
-
|
| 16 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 17 |
-
|
| 18 |
|
|
|
|
|
|
|
| 19 |
|
| 20 |
-
-
|
| 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 |
-
|
| 43 |
-
|
| 44 |
-
|
| 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 |
-
|
| 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 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
|
| 110 |
-
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
|
| 120 |
-
|
| 121 |
-
|
| 122 |
-
|
| 123 |
-
|
| 124 |
-
|
| 125 |
-
|
| 126 |
-
|
| 127 |
-
|
| 128 |
-
|
| 129 |
-
|
| 130 |
-
|
| 131 |
-
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
|
| 135 |
-
|
| 136 |
-
|
| 137 |
-
|
| 138 |
-
|
| 139 |
-
|
| 140 |
-
|
| 141 |
-
|
| 142 |
-
|
| 143 |
-
|
| 144 |
-
|
| 145 |
-
|
| 146 |
-
|
| 147 |
-
|
| 148 |
-
|
| 149 |
-
-
|
| 150 |
-
-
|
| 151 |
-
-
|
| 152 |
-
|
| 153 |
-
|
| 154 |
-
|
| 155 |
-
|
| 156 |
-
|
| 157 |
-
|
| 158 |
-
|
| 159 |
-
|
| 160 |
-
|
| 161 |
-
|
| 162 |
-
|
| 163 |
-
|
| 164 |
-
|
| 165 |
-
|
| 166 |
-
|
| 167 |
-
|
| 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]
|
| 200 |
### Framework versions
|
| 201 |
|
| 202 |
- PEFT 0.15.2
|
|
|
|
| 1 |
---
|
| 2 |
base_model: unsloth/Qwen3-0.6B
|
| 3 |
library_name: peft
|
| 4 |
+
license: mit
|
| 5 |
+
datasets:
|
| 6 |
+
- atahanuz/stock_prediction
|
| 7 |
+
language:
|
| 8 |
+
- en
|
| 9 |
+
pipeline_tag: text-generation
|
| 10 |
+
tags:
|
| 11 |
+
- finance
|
| 12 |
+
- sft
|
| 13 |
+
- trl
|
| 14 |
+
- unsloth
|
| 15 |
+
- transformers
|
| 16 |
---
|
| 17 |
|
| 18 |
+
# Model Card for StockDirection-6K
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
## Model Details
|
| 21 |
|
| 22 |
+
StockDirection is a fine-tuned language model for binary stock movement prediction.
|
| 23 |
+
The model is trained to predict whether the next day’s stock price of Akbank (AKBNK), traded on Borsa Istanbul (BIST), will move UP or DOWN, based on the daily percentage changes from the last four days and the current day.
|
|
|
|
|
|
|
| 24 |
|
| 25 |
+
- Input: A formatted prompt describing the last 5 days of daily percentage price changes.
|
| 26 |
+
- Output: A simple categorical prediction — "UP" or "DOWN".
|
| 27 |
|
| 28 |
+
This model was fine-tuned on a dataset of 6,300 labeled rows of AKBNK stock data.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 29 |
|
| 30 |
## Uses
|
| 31 |
|
|
|
|
|
|
|
| 32 |
### Direct Use
|
| 33 |
|
| 34 |
+
- Educational purposes: Demonstrating how LLMs can be fine-tuned for financial classification tasks.
|
| 35 |
+
- Research: Exploring text-based sequence learning for stock direction prediction.
|
| 36 |
+
- Proof of concept: Serving as an example for stock price direction prediction using natural language prompts.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 37 |
|
| 38 |
+
⚠️ Not for financial advice or live trading decisions.
|
| 39 |
|
|
|
|
| 40 |
|
| 41 |
## How to Get Started with the Model
|
| 42 |
|
| 43 |
Use the code below to get started with the model.
|
| 44 |
|
| 45 |
+
```python
|
| 46 |
+
from transformers import AutoTokenizer, AutoModelForCausalLM
|
| 47 |
+
from peft import PeftModel
|
| 48 |
+
|
| 49 |
+
|
| 50 |
+
|
| 51 |
+
tokenizer = AutoTokenizer.from_pretrained("unsloth/Qwen3-0.6B",)
|
| 52 |
+
base_model = AutoModelForCausalLM.from_pretrained(
|
| 53 |
+
"unsloth/Qwen3-0.6B",
|
| 54 |
+
device_map={"": 0}
|
| 55 |
+
)
|
| 56 |
+
|
| 57 |
+
model = PeftModel.from_pretrained(base_model,"khazarai/StockDirection-6K")
|
| 58 |
+
|
| 59 |
+
|
| 60 |
+
question ="""
|
| 61 |
+
You are an assistant that predicts whatever a stock will go up or down in the next day based on the daily percentage price changes of the last:
|
| 62 |
+
4 days ago: 0.00
|
| 63 |
+
3 days ago: -3.09
|
| 64 |
+
2 days ago: 2.13
|
| 65 |
+
1 day ago: -2.04
|
| 66 |
+
today: 0.01
|
| 67 |
+
Predict whatever the next day's price will go up or down. Simply write your prediction as UP or DOWN
|
| 68 |
+
"""
|
| 69 |
+
|
| 70 |
+
messages = [
|
| 71 |
+
{"role" : "user", "content" : question}
|
| 72 |
+
]
|
| 73 |
+
text = tokenizer.apply_chat_template(
|
| 74 |
+
messages,
|
| 75 |
+
tokenize = False,
|
| 76 |
+
add_generation_prompt = True,
|
| 77 |
+
enable_thinking = False,
|
| 78 |
+
)
|
| 79 |
+
|
| 80 |
+
from transformers import TextStreamer
|
| 81 |
+
_ = model.generate(
|
| 82 |
+
**tokenizer(text, return_tensors = "pt").to("cuda"),
|
| 83 |
+
max_new_tokens = 200,
|
| 84 |
+
temperature = 0.7,
|
| 85 |
+
top_p = 0.8,
|
| 86 |
+
top_k = 20,
|
| 87 |
+
streamer = TextStreamer(tokenizer, skip_prompt = True),
|
| 88 |
+
)
|
| 89 |
+
```
|
| 90 |
+
**For pipeline:**
|
| 91 |
+
|
| 92 |
+
```python
|
| 93 |
+
from transformers import pipeline, AutoModelForCausalLM, AutoTokenizer
|
| 94 |
+
from peft import PeftModel
|
| 95 |
+
|
| 96 |
+
tokenizer = AutoTokenizer.from_pretrained("unsloth/Qwen3-0.6B")
|
| 97 |
+
base_model = AutoModelForCausalLM.from_pretrained("unsloth/Qwen3-0.6B")
|
| 98 |
+
model = PeftModel.from_pretrained(base_model, "khazarai/StockDirection-6K")
|
| 99 |
+
|
| 100 |
+
question ="""
|
| 101 |
+
You are an assistant that predicts whatever a stock will go up or down in the next day based on the daily percentage price changes of the last:
|
| 102 |
+
4 days ago: 0.00
|
| 103 |
+
3 days ago: -3.09
|
| 104 |
+
2 days ago: 2.13
|
| 105 |
+
1 day ago: -2.04
|
| 106 |
+
today: 0.01
|
| 107 |
+
Predict whatever the next day's price will go up or down. Simply write your prediction as UP or DOWN
|
| 108 |
+
"""
|
| 109 |
+
|
| 110 |
+
pipe = pipeline("text-generation", model=model, tokenizer=tokenizer)
|
| 111 |
+
messages = [
|
| 112 |
+
{"role": "user", "content": question}
|
| 113 |
+
]
|
| 114 |
+
pipe(messages)
|
| 115 |
+
|
| 116 |
+
```
|
| 117 |
+
|
| 118 |
+
## Training Data
|
| 119 |
+
|
| 120 |
+
- Dataset: [atahanuz/stock_prediction](https://huggingface.co/datasets/atahanuz/stock_prediction)
|
| 121 |
+
- Size: 6,355 labeled examples.
|
| 122 |
+
- Structure: Each sample contains past 5 daily percentage changes and the target label (UP/DOWN).
|
| 123 |
+
|
| 124 |
+
Example:
|
| 125 |
+
|
| 126 |
+
```vbnet
|
| 127 |
+
Question: You are an assistant that predicts whether a stock will go up or down in the next day
|
| 128 |
+
based on the daily percentage price changes of the last:
|
| 129 |
+
4 days ago: nan
|
| 130 |
+
3 days ago: 0.00
|
| 131 |
+
2 days ago: 2.22
|
| 132 |
+
1 day ago: -2.17
|
| 133 |
+
today: -2.22
|
| 134 |
+
Predict whether the next day's price will go up or down.
|
| 135 |
+
Simply write your prediction as UP or DOWN.
|
| 136 |
+
|
| 137 |
+
Answer: DOWN
|
| 138 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 139 |
|
|
|
|
| 140 |
|
|
|
|
| 141 |
### Framework versions
|
| 142 |
|
| 143 |
- PEFT 0.15.2
|