Update README.md
Browse files
README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
| 1 |
# π Nifty50GPT-Final β India's First Financial SQL LLM (Offline, Open-Source)
|
| 2 |
|
| 3 |
**Nifty50GPT-Final** is a lightweight, offline-ready transformer model fine tuned on structured Indian stock market data.
|
| 4 |
-
It was created by [Shubham Sood]
|
| 5 |
|
| 6 |
This release includes:
|
| 7 |
- A fully fine-tuned language model that generates **SQL queries** on structured prompts
|
|
@@ -10,7 +10,7 @@ This release includes:
|
|
| 10 |
|
| 11 |
---
|
| 12 |
|
| 13 |
-
##
|
| 14 |
|
| 15 |
| File | Description |
|
| 16 |
|---------------------------|-------------------------------------------------|
|
|
@@ -23,9 +23,9 @@ This release includes:
|
|
| 23 |
|
| 24 |
---
|
| 25 |
|
| 26 |
-
##
|
| 27 |
|
| 28 |
-
###
|
| 29 |
```python
|
| 30 |
from transformers import AutoModelForCausalLM, AutoTokenizer
|
| 31 |
import torch
|
|
@@ -53,7 +53,7 @@ print(tokenizer.decode(outputs[0]))
|
|
| 53 |
###DuckDB Integration (student_data.duckdb)
|
| 54 |
All responses from Nifty50GPT-Final are SQL-ready and designed to be run on student_data.duckdb.
|
| 55 |
|
| 56 |
-
|
| 57 |
Download DuckDB
|
| 58 |
|
| 59 |
Launch DuckDB in terminal or PowerShell:
|
|
@@ -66,11 +66,11 @@ WHERE stock_symbol = 'INFY'
|
|
| 66 |
AND date = DATE '2021-03-31';
|
| 67 |
|
| 68 |
|
| 69 |
-
|
| 70 |
You can extend the dataset while keeping the schema the same
|
| 71 |
|
| 72 |
|
| 73 |
-
###
|
| 74 |
|
| 75 |
1. Fundamental Metric Lookups
|
| 76 |
What was the net_profit of TCS on 2022-03-31?
|
|
@@ -118,13 +118,13 @@ S&P 500, Nasdaq 100, Dow Jones, FTSE 100,
|
|
| 118 |
DAX, Nikkei 225, Hang Seng, Shanghai Composite
|
| 119 |
|
| 120 |
|
| 121 |
-
|
| 122 |
|
| 123 |
YYYY-03-31 - all yearly fundamentals have been shown to be reported on 31st of every march
|
| 124 |
|
| 125 |
YYYY-MM-DD for the rest
|
| 126 |
|
| 127 |
-
|
| 128 |
Use exact stock symbols (INFY, not Infosys)
|
| 129 |
|
| 130 |
Use supported metric names and date formats
|
|
@@ -134,7 +134,7 @@ Follow the formats in this README for best results
|
|
| 134 |
|
| 135 |
---
|
| 136 |
|
| 137 |
-
##
|
| 138 |
|
| 139 |
This model and its associated database are provided **strictly for research, experimentation, and educational purposes** only.
|
| 140 |
|
|
@@ -144,7 +144,7 @@ This model and its associated database are provided **strictly for research, exp
|
|
| 144 |
- Outputs may be outdated, incorrect, or misinterpreted if used outside the documented prompt structure.
|
| 145 |
- The included `student_data.duckdb` file is a static, sample database and may not reflect the most current financial data.
|
| 146 |
|
| 147 |
-
###
|
| 148 |
|
| 149 |
By using this model or dataset:
|
| 150 |
- You acknowledge that **all responsibility lies with the user**.
|
|
@@ -156,8 +156,8 @@ This model is **not certified**, **audited**, or**approved** by any authority.
|
|
| 156 |
> Use responsibly. Fork freely. Trust nothing. Verify everything.
|
| 157 |
|
| 158 |
|
| 159 |
-
|
| 160 |
Created by Shubham Sood
|
| 161 |
-
Maintained by Student One
|
| 162 |
-
π www.studentone.tech
|
| 163 |
|
|
|
|
| 1 |
# π Nifty50GPT-Final β India's First Financial SQL LLM (Offline, Open-Source)
|
| 2 |
|
| 3 |
**Nifty50GPT-Final** is a lightweight, offline-ready transformer model fine tuned on structured Indian stock market data.
|
| 4 |
+
It was created by [Shubham Sood] at **Student One** to make financial analysis transparent, free, and locally usable β without APIs or cloud dependencies.
|
| 5 |
|
| 6 |
This release includes:
|
| 7 |
- A fully fine-tuned language model that generates **SQL queries** on structured prompts
|
|
|
|
| 10 |
|
| 11 |
---
|
| 12 |
|
| 13 |
+
## What's Included
|
| 14 |
|
| 15 |
| File | Description |
|
| 16 |
|---------------------------|-------------------------------------------------|
|
|
|
|
| 23 |
|
| 24 |
---
|
| 25 |
|
| 26 |
+
## How to Run (Inference on CPU or GPU)
|
| 27 |
|
| 28 |
+
### Local Inference (CPU)
|
| 29 |
```python
|
| 30 |
from transformers import AutoModelForCausalLM, AutoTokenizer
|
| 31 |
import torch
|
|
|
|
| 53 |
###DuckDB Integration (student_data.duckdb)
|
| 54 |
All responses from Nifty50GPT-Final are SQL-ready and designed to be run on student_data.duckdb.
|
| 55 |
|
| 56 |
+
How to Use It:
|
| 57 |
Download DuckDB
|
| 58 |
|
| 59 |
Launch DuckDB in terminal or PowerShell:
|
|
|
|
| 66 |
AND date = DATE '2021-03-31';
|
| 67 |
|
| 68 |
|
| 69 |
+
Works instantly. No server, no latency, no setup.
|
| 70 |
You can extend the dataset while keeping the schema the same
|
| 71 |
|
| 72 |
|
| 73 |
+
### What Can I Ask Nifty50-GPT?
|
| 74 |
|
| 75 |
1. Fundamental Metric Lookups
|
| 76 |
What was the net_profit of TCS on 2022-03-31?
|
|
|
|
| 118 |
DAX, Nikkei 225, Hang Seng, Shanghai Composite
|
| 119 |
|
| 120 |
|
| 121 |
+
Supported Date Format
|
| 122 |
|
| 123 |
YYYY-03-31 - all yearly fundamentals have been shown to be reported on 31st of every march
|
| 124 |
|
| 125 |
YYYY-MM-DD for the rest
|
| 126 |
|
| 127 |
+
Tips to Avoid Hallucination
|
| 128 |
Use exact stock symbols (INFY, not Infosys)
|
| 129 |
|
| 130 |
Use supported metric names and date formats
|
|
|
|
| 134 |
|
| 135 |
---
|
| 136 |
|
| 137 |
+
## Legal Disclaimer
|
| 138 |
|
| 139 |
This model and its associated database are provided **strictly for research, experimentation, and educational purposes** only.
|
| 140 |
|
|
|
|
| 144 |
- Outputs may be outdated, incorrect, or misinterpreted if used outside the documented prompt structure.
|
| 145 |
- The included `student_data.duckdb` file is a static, sample database and may not reflect the most current financial data.
|
| 146 |
|
| 147 |
+
### No Liability
|
| 148 |
|
| 149 |
By using this model or dataset:
|
| 150 |
- You acknowledge that **all responsibility lies with the user**.
|
|
|
|
| 156 |
> Use responsibly. Fork freely. Trust nothing. Verify everything.
|
| 157 |
|
| 158 |
|
| 159 |
+
Credits
|
| 160 |
Created by Shubham Sood
|
| 161 |
+
Maintained by Student One
|
| 162 |
+
π www.studentone.tech
|
| 163 |
|