Upload README documentation
Browse files
README.md
CHANGED
|
@@ -1,3 +1,123 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- crypto
|
| 5 |
+
- price-prediction
|
| 6 |
+
- lstm
|
| 7 |
+
- trading
|
| 8 |
+
library_name: pytorch
|
| 9 |
---
|
| 10 |
+
|
| 11 |
+
# Crypto Price Predictor V8
|
| 12 |
+
|
| 13 |
+
A high-performance LSTM-based cryptocurrency price prediction model with bias correction.
|
| 14 |
+
|
| 15 |
+
## Model Details
|
| 16 |
+
|
| 17 |
+
### Architecture
|
| 18 |
+
- **Type**: Bidirectional LSTM
|
| 19 |
+
- **Layers**: 2 stacked LSTM layers
|
| 20 |
+
- **Hidden Size**: 64 (auto-detected per model)
|
| 21 |
+
- **Input Features**: 44 technical indicators
|
| 22 |
+
- **Output**: Next hour price prediction
|
| 23 |
+
|
| 24 |
+
### Supported Cryptocurrencies
|
| 25 |
+
BTC, ETH, SOL, BNB, XRP, ADA, DOT, LINK, MATIC, AVAX, FTM, NEAR, ATOM, ARB, OP, LTC, DOGE, UNI, SHIB, PEPE
|
| 26 |
+
|
| 27 |
+
### Performance
|
| 28 |
+
- **Average MAPE**: < 0.05%
|
| 29 |
+
- **Average MAE**: < 50 USD (varies by price)
|
| 30 |
+
- **Direction Accuracy**: ~65-75%
|
| 31 |
+
|
| 32 |
+
## Usage
|
| 33 |
+
|
| 34 |
+
### Quick Start
|
| 35 |
+
|
| 36 |
+
```python
|
| 37 |
+
from bot_predictor import BotPredictor
|
| 38 |
+
|
| 39 |
+
# Initialize
|
| 40 |
+
bot = BotPredictor()
|
| 41 |
+
|
| 42 |
+
# Get prediction
|
| 43 |
+
prediction = bot.predict('BTC')
|
| 44 |
+
print(f"Next Hour Price: ${prediction['corrected_price']:.2f}")
|
| 45 |
+
print(f"Direction: {prediction['direction']}")
|
| 46 |
+
print(f"Confidence: {prediction['confidence']*100:.1f}%")
|
| 47 |
+
```
|
| 48 |
+
|
| 49 |
+
### Installation
|
| 50 |
+
|
| 51 |
+
```bash
|
| 52 |
+
pip install torch torchvision torchaudio
|
| 53 |
+
pip install scikit-learn pandas numpy ccxt
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
### Models
|
| 57 |
+
|
| 58 |
+
All models are in PyTorch format (.pth files). Download all models to use the full suite.
|
| 59 |
+
|
| 60 |
+
### Bias Correction
|
| 61 |
+
|
| 62 |
+
Each model includes an automatic bias correction value to account for training/test distribution differences.
|
| 63 |
+
|
| 64 |
+
File: `bias_corrections_v8.json`
|
| 65 |
+
|
| 66 |
+
## Technical Indicators (44 total)
|
| 67 |
+
|
| 68 |
+
- RSI (14, 21)
|
| 69 |
+
- MACD + Signal + Histogram
|
| 70 |
+
- Bollinger Bands (20, 2)
|
| 71 |
+
- ATR (14)
|
| 72 |
+
- CCI (20)
|
| 73 |
+
- Momentum (10)
|
| 74 |
+
- SMA (5, 10, 20, 50)
|
| 75 |
+
- EMA (12, 26)
|
| 76 |
+
- Volume Ratio
|
| 77 |
+
- OHLC-derived features
|
| 78 |
+
|
| 79 |
+
## Training Details
|
| 80 |
+
|
| 81 |
+
- **Data**: 1000 hourly candles per symbol
|
| 82 |
+
- **Train/Val/Test Split**: 80/10/10
|
| 83 |
+
- **Optimizer**: Adam (LR=0.005)
|
| 84 |
+
- **Loss**: MSE
|
| 85 |
+
- **Batch Size**: 64
|
| 86 |
+
- **Epochs**: 150 (with early stopping)
|
| 87 |
+
- **Dropout**: 0.3
|
| 88 |
+
|
| 89 |
+
## Requirements
|
| 90 |
+
|
| 91 |
+
```
|
| 92 |
+
torch>=2.0.0
|
| 93 |
+
torchvision
|
| 94 |
+
pandas>=1.5.0
|
| 95 |
+
numpy>=1.23.0
|
| 96 |
+
scikit-learn>=1.2.0
|
| 97 |
+
ccxt>=2.0.0
|
| 98 |
+
huggingface_hub>=0.16.0
|
| 99 |
+
python-dotenv>=1.0.0
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
## License
|
| 103 |
+
|
| 104 |
+
MIT License
|
| 105 |
+
|
| 106 |
+
## Citation
|
| 107 |
+
|
| 108 |
+
```
|
| 109 |
+
@software{crypto_predictor_v8,
|
| 110 |
+
title={Crypto Price Predictor V8},
|
| 111 |
+
author={Your Name},
|
| 112 |
+
year={2025},
|
| 113 |
+
url={https://huggingface.co/caizongxun/crypto-price-predictor-v8}
|
| 114 |
+
}
|
| 115 |
+
```
|
| 116 |
+
|
| 117 |
+
## Disclaimer
|
| 118 |
+
|
| 119 |
+
These models are for educational and research purposes only. Do not use for actual trading without thorough validation.
|
| 120 |
+
|
| 121 |
+
## Support
|
| 122 |
+
|
| 123 |
+
For issues and questions, please refer to the GitHub repository.
|