Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/FOST
FOST is a general forecasting tool, which demonstrate our experience and advanced technology in practical forecasting domains, including temporal, spatial-temporal and hierarchical forecasting. Current general forecasting tools (Gluon-TS by amazon, Prophet by facebook etc.) can not process and model structural graph data, especially in spatial domains, also those tools suffer from tradeoff between usability and accuracy. To address these challenges, we design and develop FOST and aims to empower engineers and data scientists to build high-accuracy and easy-usability forecasting tools.
https://github.com/microsoft/FOST
Last synced: about 1 month ago
JSON representation
FOST is a general forecasting tool, which demonstrate our experience and advanced technology in practical forecasting domains, including temporal, spatial-temporal and hierarchical forecasting. Current general forecasting tools (Gluon-TS by amazon, Prophet by facebook etc.) can not process and model structural graph data, especially in spatial domains, also those tools suffer from tradeoff between usability and accuracy. To address these challenges, we design and develop FOST and aims to empower engineers and data scientists to build high-accuracy and easy-usability forecasting tools.
- Host: GitHub
- URL: https://github.com/microsoft/FOST
- Owner: microsoft
- License: mit
- Created: 2021-10-21T09:43:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-14T08:06:16.000Z (almost 2 years ago)
- Last Synced: 2024-08-03T09:07:29.429Z (4 months ago)
- Language: Python
- Homepage:
- Size: 274 KB
- Stars: 254
- Watchers: 9
- Forks: 45
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-time-series - FOST from microsoft
- awesome-time-series - fost - use tool for spatial-temporal forecasting. (📦 Packages / Python)
- awesome-machine-learning-resources - **[Library
- StarryDivineSky - microsoft/FOST - TS、facebook的Prophet等）无法处理和建模结构图数据，尤其是在空间数据中 (时空网络_交通预测_动态图 / 网络服务_其他)
README
- [**Fost**](#fost)
- [Framework of Fost](#framework-of-fost)
- [Quick Start](#quick-start)
- [Installation](#installation)
- [Train with FOST](#train-with-fost)
- [Data Format](#data-format)
- [Examples](#examples)
- [Contact Us](#contact-us)
# FOST
FOST(Forecasting open source tool) aims to provide an easy-use tool for spatial-temporal forecasting. The users only need to organize their data into a certain format and then get the prediction results with one command. FOST automatically handles the missing and abnormal values, and captures both spatial and temporal correlations efficiently.
# Framework of FOST
Following is the framework of FOST, basically it contains 4 main components:
| Module name | Description |
| ------------- | ------------------------------------------------------------ |
| Preprocessing | Preprocessing module aims at handle varies data situation, currently FOST designed sub-module to handle issues such as missing value, unalignment timestamp and feature selection. |
| Modeling | FOST contains implements for different mainstream deep learning models such as RNN, MLP and GNN, for better performance on varies custom data. Further model implements such as Transformer, N-beats are in progress. |
| Fusion | Fusion module aims at automatically select and ensemble model predictions. |
| Utils | There are many other utils in FOST, such as neural-network trainer and predictor, result plotter and so on. |
# Quick Start
## Installation
### Installation of dependency packages
#### 1. Prerequisites
This project relies on `pytorch >= 1.8` and `torch-geometric >= 1.7.2`
- torch installation reference link：https://pytorch.org/get-started/previous-versions/
- torch-geometric installation reference link: https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html
#### 2. Installation
You can install fost with pip:
```
pip install fostool
```
## Train with FOST
#### 1. Import forecasting pipeline
```python
from fostool.pipeline import Pipeline
```
#### 2. Setting data path and lookahead
You need to pass your `train.csv` and `graph.csv` for model training, see [dataformat](#data-format) for data preparing.
```python
train_path = '/path/to/your/train.csv'
graph_path = '/path/to/your/graph.csv' # graph_path is alternative
lookahead = 7 # Forward steps you would like to predict.
```
#### 3. Fit and predict
We provide a default config file in config/default.yaml. You could use your config file through config_path augment.
```python
fost = Pipeline(lookahead=lookahead, train_path=train_path, graph_path=graph_path)
fost.fit()
result = fost.predict()
```
#### 4. Plot results
```python
fost.plot(result)
```
# Data Format
> You can fetch sample data on `/examples`
### 1. train.csv
3 columns are required for `train.csv`:
+ Node: node name for current data
+ Date: date or timestamp for current data
+ TARGET: target for prediction
A valid format may look like:
| Node | Date | TARGET |
| ------- | ---------- | ---------- |
| Alaska | 1960-01-01 | 800592.0 |
| Alaska | 1961-01-01 | 933600.0 |
| Alabama | 1960-01-01 | 10141633.0 |
| Alabama | 1961-01-01 | 9885992.0 |
| Alabama | 1962-01-01 | 10497917.0 |
Columns except above will be regarded as feature columns.
### 2. graph.csv (option)
`graph.csv` should only contains 3 columns:
+ node_0: node name for fist node, node name should align with node name in `train.csv`.
+ node_1: node name for second node, node name should align with node name in `train.csv`.
+ weight: weight on connection for node_0 to node_1.
If `graph.csv` is not provided, identity graph will be used.
# Examples
We prepared several examples on `examples`:
1. [Predict simulation cosine curve](/examples/1.%20Cosine%20prediction.ipynb)
2. [Predict States Energy Data](/examples/2.%20Predict%20States%20Energy%20Data.ipynb)
3. [Save and load model](/examples/3.%20Save%20and%20load.ipynb)
# Contact Us
- If you have any issues, please create issue [here](https://github.com/microsoft/fost/issues/new/choose) or send messages in [gitter](https://gitter.im/Microsoft/fost).
- For other reasons, you are welcome to contact us by email([[email protected]](mailto:[email protected])).