Okcan commited on
Commit
6569de8
·
verified ·
1 Parent(s): 51e1403

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -45
README.md CHANGED
@@ -1,77 +1,100 @@
1
  ---
2
  license: mit
3
  language:
4
- - en
 
 
 
 
 
 
 
 
5
  ---
6
 
7
- 🔍 Model Overview
8
- Feature Description
9
- 📦 Model Type LSTM (Long Short-Term Memory), a type of Recurrent Neural Network (RNN)
10
- 🧠 Frameworks Used TensorFlow (Keras API), Scikit-learn, yfinance, NumPy, Pandas
11
- 📈 Input Past 60 days of Bitcoin closing prices
12
- 🎯 Output The predicted closing price for the next day
13
- 🧪 Goal Short-term (1-day ahead) price prediction
14
- 📊 Evaluation Metric RMSE (Root Mean Squared Error)
15
 
16
- 🔧 What It Does
17
- Downloads historical BTC-USD data from Yahoo Finance
18
 
19
- Normalizes the closing price data between 0 and 1 using MinMaxScaler
20
 
21
- Splits the data into 80% training and 20% testing
22
 
23
- Uses a sliding window of 60 days to create time-sequenced input for LSTM
 
 
 
 
 
 
 
24
 
25
- Builds a 2-layer LSTM network with dropout to avoid overfitting
26
 
27
- Trains the model to minimize mean squared error
28
 
29
- Evaluates the model on test data
 
 
 
 
 
 
 
30
 
31
- Plots actual vs predicted prices
32
 
33
- Makes a future prediction for the next day based on the last 60 days
34
 
35
- 💡 What This Model Is Useful For
36
- Educational purposes (learning LSTM, time series preprocessing)
 
 
37
 
38
- Research and experimentation with financial prediction models
39
 
40
- Visualization and evaluation of model performance
41
 
42
- Academic paper support (as you’re already writing)
 
 
 
43
 
44
- ⚠️ Limitations
45
- It uses only closing price – no volume, sentiment, or indicators like RSI/MACD
46
 
47
- It performs single-step prediction (only the next day)
48
 
49
- May not adapt well to sudden market shocks
 
 
 
 
 
50
 
51
- Not suitable as-is for high-frequency trading or live trading bots
52
 
53
- 🚀 How to Improve It
54
- Include more features: trading volume, high/low prices, technical indicators
55
 
56
- Add external data: news sentiment, macroeconomic indicators
 
 
57
 
58
- Use attention mechanisms or transformer architectures
59
 
60
- Convert it to multi-step forecasting (predict next 3, 5, or 7 days)
61
 
62
- Wrap it in a REST API or real-time dashboard
63
 
64
- Let me know if you want to:
65
 
66
- Package this into a web app
 
 
 
 
 
 
 
67
 
68
- Prepare a GitHub README for the code
69
 
70
- Extend the model for live trading (e.g., using Binance API)
71
 
72
- Or build a production-ready pipeline
73
- ---
74
- ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️
75
- Disclaimer:
76
- This model is developed strictly for experimental and educational purposes. It is not intended for real-world financial forecasting or investment decisions. Users are strongly advised not to rely on the outputs of this model for any form of trading or financial transactions. No guarantees are made regarding the accuracy or reliability of the predictions, and no liability or responsibility is accepted for any losses or damages resulting from the use of this system. By using this model, you acknowledge and agree that no claims or disputes will be accepted under any circumstances.
77
- ---
 
1
  ---
2
  license: mit
3
  language:
4
+ - en
5
+ tags:
6
+ - bitcoin
7
+ - lstm
8
+ - time-series
9
+ - price-prediction
10
+ - tensorflow
11
+ - keras
12
+ - finance
13
  ---
14
 
15
+ # 🧠 Bitcoin Price Forecasting using LSTM Neural Network
 
 
 
 
 
 
 
16
 
17
+ A deep learning model based on Long Short-Term Memory (LSTM) networks to predict the next-day closing price of Bitcoin (BTC-USD) using historical data from Yahoo Finance.
 
18
 
19
+ ---
20
 
21
+ ## 🔍 Model Overview
22
 
23
+ | Feature | Description |
24
+ |--------------------|-----------------------------------------------------------------------------|
25
+ | 📦 Model Type | LSTM (Long Short-Term Memory), a variant of Recurrent Neural Networks (RNN) |
26
+ | 🧠 Frameworks Used | TensorFlow (Keras API), Scikit-learn, NumPy, Pandas, yfinance |
27
+ | 📈 Input | Past 60 days of Bitcoin closing prices |
28
+ | 🎯 Output | Predicted closing price for the next day |
29
+ | 📊 Evaluation | Root Mean Squared Error (RMSE) |
30
+ | 🧪 Goal | Short-term (1-day ahead) BTC price forecasting |
31
 
32
+ ---
33
 
34
+ ## 🔧 What the Model Does
35
 
36
+ - Downloads historical BTC-USD data from Yahoo Finance
37
+ - Normalizes the data between 0 and 1 using MinMaxScaler
38
+ - Splits into 80% training and 20% test sets
39
+ - Creates time-sequenced inputs with a 60-day sliding window
40
+ - Trains a 2-layer LSTM model with dropout to prevent overfitting
41
+ - Evaluates the model using RMSE
42
+ - Plots predicted vs actual prices
43
+ - Makes a next-day prediction using the last 60 days of data
44
 
45
+ ---
46
 
47
+ ## 💡 Use Cases
48
 
49
+ - Educational: Learning time series forecasting and LSTM models
50
+ - Research: Benchmarking for financial forecasting models
51
+ - Visualization: Analyze model performance on real BTC data
52
+ - Academic Support: Useful for papers or prototypes on AI-based financial systems
53
 
54
+ ---
55
 
56
+ ## ⚠️ Limitations
57
 
58
+ - Uses only the closing price (no volume, indicators, or sentiment data)
59
+ - Performs only single-step (1-day ahead) forecasting
60
+ - Does not account for sudden market news or shocks
61
+ - Not designed for high-frequency or live trading systems
62
 
63
+ ---
 
64
 
65
+ ## 🚀 Potential Improvements
66
 
67
+ - Include additional features: volume, RSI, MACD, etc.
68
+ - Integrate external signals: news, social media sentiment, macro data
69
+ - Add attention or transformer-based layers
70
+ - Extend to multi-step forecasting (3-day, 5-day, etc.)
71
+ - Deploy as REST API or interactive dashboard
72
+ - Connect to Binance or other exchanges for live predictions
73
 
74
+ ---
75
 
76
+ ## 📁 Files
 
77
 
78
+ - `lstm_bitcoin_predictor.py`: Full code to train, evaluate, and predict using LSTM
79
+ - `data.csv`: (optional) Cached historical BTC-USD data
80
+ - `model.h5`: Saved trained model
81
 
82
+ ---
83
 
84
+ ## 📜 License
85
 
86
+ This project is licensed under the MIT License.
87
 
88
+ ---
89
 
90
+ ## ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ Disclaimer⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
91
+
92
+ > **This model is intended for educational and research purposes only.**
93
+ >
94
+ > It is **not** designed for financial or investment decision-making.
95
+ > No guarantees are made about the accuracy of the forecasts.
96
+ > The authors accept no responsibility for any financial losses incurred from the use of this model.
97
+ > **Use at your own risk.**
98
 
 
99
 
 
100