Skip to content

Commit 6811983

Browse files
committed
📚 docs(readme): Improve README with clearer descriptions and examples
Updated the README to provide a more concise overview of the package and its primary functionalities, along with informative references and usage examples. Signed-off-by: Mao-Kai Lan <maokailan24@gmail.com>
1 parent 4e29a19 commit 6811983

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
[![Dependabot Updates](https://github.com/mukappalambda/dmd/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/mukappalambda/dmd/actions/workflows/dependabot/dependabot-updates)
44
[![Ruff](https://github.com/mukappalambda/dmd/actions/workflows/ruff.yml/badge.svg)](https://github.com/mukappalambda/dmd/actions/workflows/ruff.yml)
55

6-
This python code illustrates how to apply Dynamic Mode Decomposition (DMD) to univariate time series forecasting tasks.
76

8-
Two examples are provided here.
7+
This Python package provides an implementation of Dynamic Mode Decomposition (DMD) specifically designed for univariate time series forecasting. DMD offers a data-driven approach for analyzing the dynamics of complex systems, making it suitable for forecasting and system identification applications.
98

10-
For the explanation of DMD, please refer to this HackMD notes: [Dynamic Mode Decomposition](https://hackmd.io/@mklan/HyLXh7UH_).
9+
Two example scripts are included to demonstrate typical usage scenarios.
1110

12-
The major reference is this arXiv article: [On Dynamic Mode Decomposition: Theory and Applications](https://arxiv.org/abs/1312.0041).
11+
For an in-depth explanation of DMD, please refer to the following HackMD note: [Dynamic Mode Decomposition](https://hackmd.io/@mklan/HyLXh7UH_).
12+
13+
The primary reference for this implementation is the arXiv article: [On Dynamic Mode Decomposition: Theory and Applications](https://arxiv.org/abs/1312.0041).
1314

1415
---
1516

0 commit comments

Comments
 (0)