You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

167 lines
8.6 KiB

1 month ago
  1. ---
  2. license: mit
  3. pipeline_tag: time-series-forecasting
  4. tags:
  5. - Finance
  6. - Candlestick
  7. - K-line
  8. ---
  9. # Kronos: A Foundation Model for the Language of Financial Markets
  10. [![Paper](https://img.shields.io/badge/Paper-2508.02739-b31b1b.svg)](https://arxiv.org/abs/2508.02739)
  11. [![Live Demo](https://img.shields.io/badge/%F0%9F%9A%80-Live_Demo-brightgreen)](https://shiyu-coder.github.io/Kronos-demo/)
  12. [![GitHub](https://img.shields.io/badge/%F0%9F%92%BB-GitHub-blue?logo=github)](https://github.com/shiyu-coder/Kronos)
  13. <p align="center">
  14. <img src="https://github.com/shiyu-coder/Kronos/blob/master/figures/logo.png?raw=true" alt="Kronos Logo" width="100">
  15. </p>
  16. **Kronos** is the **first open-source foundation model** for financial candlesticks (K-lines), trained on data from over **45 global exchanges**. It is designed to handle the unique, high-noise characteristics of financial data.
  17. ## Introduction
  18. Kronos is a family of decoder-only foundation models, pre-trained specifically for the "language" of financial markets—K-line sequences. It leverages a novel two-stage framework:
  19. 1. A specialized tokenizer first quantizes continuous, multi-dimensional K-line data (OHLCV) into **hierarchical discrete tokens**.
  20. 2. A large, autoregressive Transformer is then pre-trained on these tokens, enabling it to serve as a unified model for diverse quantitative tasks.
  21. <p align="center">
  22. <img src="https://github.com/shiyu-coder/Kronos/blob/master/figures/overview.png?raw=true" alt="Kronos Overview" align="center" width="700px" />
  23. </p>
  24. The success of large-scale pre-training paradigm, exemplified by Large Language Models (LLMs), has inspired the development of Time Series Foundation Models (TSFMs). Kronos addresses existing limitations by introducing a specialized tokenizer that discretizes continuous market information into token sequences, preserving both price dynamics and trade activity patterns. We pre-train Kronos using an autoregressive objective on a massive, multi-market corpus of over 12 billion K-line records from 45 global exchanges, enabling it to learn nuanced temporal and cross-asset representations. Kronos excels in a zero-shot setting across a diverse set of financial tasks, including price series forecasting, volatility forecasting, and synthetic data generation.
  25. ## Live Demo
  26. We have set up a live demo to visualize Kronos's forecasting results. The webpage showcases a forecast for the **BTC/USDT** trading pair over the next 24 hours.
  27. 👉 [Access the Live Demo Here](https://shiyu-coder.github.io/Kronos-demo/)
  28. ## Model Zoo
  29. We release a family of pre-trained models with varying capacities to suit different computational and application needs. All models are readily accessible from the Hugging Face Hub.
  30. | Model | Tokenizer | Context length | Param | Hugging Face Model Card |
  31. |--------------|---------------------------------------------------------------------------------| -------------- | ------ |--------------------------------------------------------------------------|
  32. | Kronos-mini | [Kronos-Tokenizer-2k](https://huggingface.co/NeoQuasar/Kronos-Tokenizer-2k) | 2048 | 4.1M | ✅ [NeoQuasar/Kronos-mini](https://huggingface.co/NeoQuasar/Kronos-mini) |
  33. | Kronos-small | [Kronos-Tokenizer-base](https://huggingface.co/NeoQuasar/Kronos-Tokenizer-base) | 512 | 24.7M | ✅ [NeoQuasar/Kronos-small](https://huggingface.co/NeoQuasar/Kronos-small) |
  34. | Kronos-base | [Kronos-Tokenizer-base](https://huggingface.co/NeoQuasar/Kronos-Tokenizer-base) | 512 | 102.3M | ✅ [NeoQuasar/Kronos-base](https://huggingface.co/NeoQuasar/Kronos-base) |
  35. | Kronos-large | [Kronos-Tokenizer-base](https://huggingface.co/NeoQuasar/Kronos-Tokenizer-base) | 512 | 499.2M | ❌ Not yet publicly available |
  36. ## Getting Started: Making Forecasts
  37. Forecasting with Kronos is straightforward using the `KronosPredictor` class. It handles data preprocessing, normalization, prediction, and inverse normalization, allowing you to get from raw data to forecasts in just a few lines of code.
  38. **Important Note**: The `max_context` for `Kronos-small` and `Kronos-base` is **512**. This is the maximum sequence length the model can process. For optimal performance, it is recommended that your input data length (i.e., `lookback`) does not exceed this limit. The `KronosPredictor` will automatically handle truncation for longer contexts.
  39. Here is a step-by-step guide to making your first forecast.
  40. ### Installation
  41. 1. Install Python 3.10+, and then install the dependencies from the [GitHub repository's `requirements.txt`](https://github.com/shiyu-coder/Kronos/blob/main/requirements.txt):
  42. ```shell
  43. pip install -r requirements.txt
  44. ```
  45. ### 1. Load the Tokenizer and Model
  46. First, load a pre-trained Kronos model and its corresponding tokenizer from the Hugging Face Hub.
  47. ```python
  48. from model import Kronos, KronosTokenizer, KronosPredictor
  49. # Load from Hugging Face Hub
  50. tokenizer = KronosTokenizer.from_pretrained("NeoQuasar/Kronos-Tokenizer-base")
  51. model = Kronos.from_pretrained("NeoQuasar/Kronos-small")
  52. ```
  53. ### 2. Instantiate the Predictor
  54. Create an instance of `KronosPredictor`, passing the model, tokenizer, and desired device.
  55. ```python
  56. # Initialize the predictor
  57. predictor = KronosPredictor(model, tokenizer, device="cuda:0", max_context=512)
  58. ```
  59. ### 3. Prepare Input Data
  60. The `predict` method requires three main inputs:
  61. - `df`: A pandas DataFrame containing the historical K-line data. It must include columns `['open', 'high', 'low', 'close']`. `volume` and `amount` are optional.
  62. - `x_timestamp`: A pandas Series of timestamps corresponding to the historical data in `df`.
  63. - `y_timestamp`: A pandas Series of timestamps for the future periods you want to predict.
  64. ```python
  65. import pandas as pd
  66. # Load your data (example data can be found in the GitHub repo)
  67. df = pd.read_csv("./data/XSHG_5min_600977.csv")
  68. df['timestamps'] = pd.to_datetime(df['timestamps'])
  69. # Define context window and prediction length
  70. lookback = 400
  71. pred_len = 120
  72. # Prepare inputs for the predictor
  73. x_df = df.loc[:lookback-1, ['open', 'high', 'low', 'close', 'volume', 'amount']]
  74. x_timestamp = df.loc[:lookback-1, 'timestamps']
  75. y_timestamp = df.loc[lookback:lookback+pred_len-1, 'timestamps']
  76. ```
  77. ### 4. Generate Forecasts
  78. Call the `predict` method to generate forecasts. You can control the sampling process with parameters like `T`, `top_p`, and `sample_count` for probabilistic forecasting.
  79. ```python
  80. # Generate predictions
  81. pred_df = predictor.predict(
  82. df=x_df,
  83. x_timestamp=x_timestamp,
  84. y_timestamp=y_timestamp,
  85. pred_len=pred_len,
  86. T=1.0, # Temperature for sampling
  87. top_p=0.9, # Nucleus sampling probability
  88. sample_count=1 # Number of forecast paths to generate and average
  89. )
  90. print("Forecasted Data Head:")
  91. print(pred_df.head())
  92. ```
  93. The `predict` method returns a pandas DataFrame containing the forecasted values for `open`, `high`, `low`, `close`, `volume`, and `amount`, indexed by the `y_timestamp` you provided.
  94. ### 5. Example and Visualization
  95. For a complete, runnable script that includes data loading, prediction, and plotting, please see [`examples/prediction_example.py`](https://github.com/shiyu-coder/Kronos/blob/main/examples/prediction_example.py) in the GitHub repository.
  96. Running this script will generate a plot comparing the ground truth data against the model's forecast, similar to the one shown below:
  97. <p align="center">
  98. <img src="https://github.com/shiyu-coder/Kronos/blob/master/figures/prediction_example.png?raw=true" alt="Forecast Example" align="center" width="600px" />
  99. </p>
  100. Additionally, a script that makes predictions without Volume and Amount data can be found in [`examples/prediction_wo_vol_example.py`](https://github.com/shiyu-coder/Kronos/blob/main/examples/prediction_wo_vol_example.py).
  101. ## 🔧 Finetuning on Your Own Data (A-Share Market Example)
  102. Refer to the [README](https://github.com/shiyu-coder/Kronos) of GitHub repository.
  103. ## Citation
  104. If you use Kronos in your research, we would appreciate a citation to our [paper](https://huggingface.co/papers/2508.02739):
  105. ```bibtex
  106. @misc{shi2025kronos,
  107. title={Kronos: A Foundation Model for the Language of Financial Markets},
  108. author={Yu Shi and Zongliang Fu and Shuo Chen and Bohan Zhao and Wei Xu and Changshui Zhang and Jian Li},
  109. year={2025},
  110. eprint={2508.02739},
  111. archivePrefix={arXiv},
  112. primaryClass={q-fin.ST},
  113. url={https://arxiv.org/abs/2508.02739},
  114. }
  115. ```
  116. ## License
  117. This project is licensed under the [MIT License](https://github.com/shiyu-coder/Kronos/blob/main/LICENSE).