shaheerawan3 commited on
Commit
fca1c02
Β·
verified Β·
1 Parent(s): 8bb7281

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +101 -9
README.md CHANGED
@@ -1,13 +1,105 @@
1
  ---
2
- title: Crypto Trading
3
- emoji: πŸ’»
4
- colorFrom: red
5
- colorTo: blue
6
- sdk: gradio
7
- sdk_version: 5.9.1
8
- app_file: app.py
9
- pinned: false
10
  license: mit
 
 
 
11
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
1
  ---
 
 
 
 
 
 
 
 
2
  license: mit
3
+ sdk: gradio
4
+ colorFrom: red
5
+ colorTo: green
6
  ---
7
+ # Cryptocurrency Price Predictor
8
+
9
+ An advanced cryptocurrency price prediction application using LSTM neural networks and technical indicators.
10
+
11
+ ## Features
12
+
13
+ - Real-time cryptocurrency price prediction
14
+ - Technical indicator analysis
15
+ - Interactive visualization
16
+ - Model confidence scoring
17
+ - Performance metrics (RMSE, MAPE, RΒ²)
18
+ - Volatility analysis
19
+ - Pre-trained model support
20
+ - GPU acceleration (when available)
21
+
22
+ ## Requirements
23
+
24
+ - Python 3.8+
25
+ - CUDA-capable GPU (optional, for faster training)
26
+
27
+ ## Installation
28
+
29
+ 1. Clone the repository:
30
+ ```bash
31
+ git clone https://github.com/yourusername/crypto-predictor.git
32
+ cd crypto-predictor
33
+ ```
34
+
35
+ 2. Create a virtual environment (recommended):
36
+ ```bash
37
+ python -m venv venv
38
+ source venv/bin/activate # On Windows: venv\Scripts\activate
39
+ ```
40
+
41
+ 3. Install dependencies:
42
+ ```bash
43
+ pip install -r requirements.txt
44
+ ```
45
+
46
+ ## Usage
47
+
48
+ 1. Start the application:
49
+ ```bash
50
+ python crypto_predictor.py
51
+ ```
52
+
53
+ 2. Open your web browser and navigate to:
54
+ ```
55
+ http://localhost:7860
56
+ ```
57
+
58
+ 3. Enter a cryptocurrency symbol (e.g., BTC, ETH) and adjust the parameters:
59
+ - Historical Days: Amount of historical data to use
60
+ - Lookback Period: Number of days to look back for predictions
61
+
62
+ 4. Click "Generate Analysis" to view predictions and analysis
63
+
64
+ ## Model Details
65
+
66
+ The prediction model uses:
67
+ - LSTM (Long Short-Term Memory) neural network
68
+ - Technical indicators including RSI, MACD, and moving averages
69
+ - Batch normalization
70
+ - Dropout regularization
71
+ - Early stopping
72
+ - Learning rate scheduling
73
+
74
+ ## Directory Structure
75
+
76
+ ```
77
+ crypto-predictor/
78
+ β”œβ”€β”€ crypto_predictor.py
79
+ β”œβ”€β”€ requirements.txt
80
+ β”œβ”€β”€ README.md
81
+ β”œβ”€β”€ models/ # Saved model states
82
+ β”œβ”€β”€ venv/ # Virtual environment
83
+ └── crypto_predictor.log
84
+ ```
85
+
86
+ ## Performance Metrics
87
+
88
+ The application provides several metrics:
89
+ - RMSE (Root Mean Square Error)
90
+ - MAPE (Mean Absolute Percentage Error)
91
+ - RΒ² Score (Coefficient of Determination)
92
+ - Prediction Confidence
93
+ - Price Volatility
94
+
95
+ ## Contributing
96
+
97
+ Feel free to submit issues, fork the repository, and create pull requests for any improvements.
98
+
99
+ ## License
100
+
101
+ MIT License - feel free to use this project for any purpose.
102
+
103
+ ## Disclaimer
104
 
105
+ This application is for educational purposes only. Cryptocurrency trading involves substantial risk of loss and is not suitable for every investor. Do not trade with money you cannot afford to lose.