Sébastien De Greef commited on
Commit
9767bde
1 Parent(s): 1e1b538

Fix typo in license field and update dataset description

Browse files
Files changed (1) hide show
  1. README.md +73 -5
README.md CHANGED
@@ -5,12 +5,80 @@ task_categories:
5
  tags:
6
  - finance
7
  - crypto
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  ---
9
- # Cryptocurrency 1-Day Candles Dataset
10
 
11
- ## Description
12
 
13
- This dataset comprises 1-day candlestick charts for various cryptocurrencies across multiple markets.
14
- Each candlestick represents a single day of trading activity, detailing the open, high, low, and close (OHLC) prices, along with volume data.
15
 
16
- This dataset is designed to assist researchers, traders, and enthusiasts in analyzing market trends, developing trading strategies, and studying the volatility and behavior of cryptocurrencies.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  tags:
6
  - finance
7
  - crypto
8
+ - economics
9
+ - trading
10
+ - blockchain
11
+ - quantitative-analysis
12
+ - machine-learning
13
+ - deep-learning
14
+ - time-series
15
+ - sequence-modeling
16
+ - price-prediction
17
+ - market-analysis
18
+ - investment-strategies
19
+ - technical-indicators
20
+ - historical-data-analysis
21
+ language:
22
+ - en
23
+ multilinguality:
24
+ - monolingual
25
+ pretty_name: CryptoData Dataset
26
  ---
27
+ # CryptoData Dataset
28
 
29
+ The CryptoData dataset is a comprehensive collection of cryptocurrency market data, designed to support various analyses, including price prediction, market trend analysis, and the study of the impact of various indicators on cryptocurrency prices.
30
 
31
+ This dataset has been configured to provide flexibility in selecting specific types of market data through the use of different dataset configurations. Depending on the analysis needs, users can select one of the available configurations to load data tailored to their requirements.
 
32
 
33
+ ## Available Configurations:
34
+
35
+ 1. **Default**: Includes open, high, low, close, and volume for each cryptocurrency market and date.
36
+
37
+ 2. **Close**: Focuses on the close price and volume of each cryptocurrency market and date, optimized for simplicity and analyses centered on closing prices.
38
+
39
+ 3. **Indicators**: Expands upon the default configuration by including technical indicators such as RSI (Relative Strength Index), SMA (Simple Moving Average), and EMA (Exponential Moving Average), aimed at more advanced technical analyses.
40
+
41
+ 4. **Sequences**: Specifically designed for sequence prediction tasks, this configuration provides sequences of market data alongside the corresponding prediction targets, facilitating the development of models for future price prediction.
42
+
43
+ ## How to Use:
44
+
45
+ Below are Python code snippets demonstrating how to load the CryptoData dataset with each configuration. Before running the snippets, ensure you have the `datasets` library from Hugging Face installed.
46
+
47
+ ```python
48
+ from datasets import load_dataset
49
+
50
+ # Load the default configuration
51
+ dataset_default = load_dataset("crypto_data", config_name="default")
52
+
53
+ # Load the 'close' configuration
54
+ dataset_close = load_dataset("crypto_data", config_name="close")
55
+
56
+ # Load the 'indicators' configuration
57
+ dataset_indicators = load_dataset("crypto_data", config_name="indicators")
58
+
59
+ # Load the 'sequences' configuration
60
+ dataset_sequences = load_dataset("crypto_data", config_name="sequences")
61
+ ```
62
+
63
+ ## Dataset Structure:
64
+
65
+ - `market`: The cryptocurrency market (e.g., "BTC-USD").
66
+ - `date`/`time`: The date or time of the data point.
67
+ - `open`, `high`, `low`, `close`: Open, high, low, and close prices for the cryptocurrency.
68
+ - `volume`: The volume of transactions.
69
+ - `rsi`, `sma`, `ema`: Technical indicators including Relative Strength Index, Simple Moving Average, and Exponential Moving Average (available in the `indicators` configuration).
70
+ - `sequence`, `prediction`: Arrays of historical data and the corresponding future data to predict (available in the `sequences` configuration).
71
+
72
+ ## Important Notes:
73
+
74
+ - This dataset is for academic and research purposes only. Ensure compliance with any usage restrictions set by the data provider.
75
+ - When using technical indicators in your analysis, be aware that these indicators alone may not provide a complete picture of market dynamics.
76
+ - The sequences configuration requires significant preprocessing, including the calculation of technical indicators and the formation of sequences. This configuration is best suited for those with experience in time series analysis and deep learning.
77
+
78
+ ## Citation and Acknowledgments:
79
+
80
+ This dataset is made available for public use by the cryptocurrency research community. While there is no specific citation for this dataset, users are encouraged to reference the dataset's URL and the corresponding author's contributions.
81
+
82
+ Homepage: [CryptoData Dataset on Hugging Face](https://hub.huggingface.co/datasets/crypto_data)
83
+
84
+ For any questions or issues with the dataset, please raise an issue on the repository hosting the dataset.