Skip to content
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

Commit 3b77168

Browse files
authored
Update README.md
1 parent ff8f8f9 commit 3b77168

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# MindsDB Forecast Visualizer
22

3+
:warning: This repository is now archived and won’t be maintained further. We recommend using other libraries such as ![nixtla/utilsforecast](https://nixtlaverse.nixtla.io/utilsforecast/plotting.html) instead
4+
35
The purpose of this tool is to aid in obtaining quick visualizations for time series forecasts provided by a Lightwood predictor.
46

57
![](./docs/plot.png)
68

7-
At the moment, the tool supports predictors trained with `lightwood >= 1.0`, but support for 3rd party models is coming soon~ish.
9+
The tool supports predictors trained with `lightwood >= 1.0`.
810

911
## Documentation
1012

11-
For now, there is no documentation as the package itself is fairly minimal.
12-
13-
However, most functionality is showcased through examples. Please refer to:
14-
13+
There is no documentation. Most functionality is showcased through examples. Please refer to:
1514
* `example/train.py` to train a Lightwood forecaster for airplane arrival data (which includes 4 different time series)
1615
* `example/visualize.py` to plot predictions from this model in your web browser
1716
* `example/visualize.ipynb` to plot predictions from this model inside a jupyter notebook
1817

19-
Note: if you've cloned the repository (as opposed to `pip install`ing), make sure the path to `mindsdb_forecast_visualizer` is added to your python path environment variable before running these scripts from the package root folder.
18+
Note: if youve cloned the repository (as opposed to `pip install`ing), make sure the path to `mindsdb_forecast_visualizer` is added to your python path environment variable before running these scripts from the package root folder.

0 commit comments

Comments
 (0)