Skip to content

Commit

Permalink
doc: update readme;
Browse files Browse the repository at this point in the history
  • Loading branch information
WenjieDu committed Sep 28, 2022
1 parent 0121c3b commit 7833ed8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,19 @@
</a>
<!-- PyPI download number -->
<a alt='PyPI download number' href='https://pypi.org/project/tsdb'>
<img src='https://static.pepy.tech/personalized-badge/tsdb?period=total&units=international_system&left_color=gray&right_color=blue&left_text=Total%20Downloads'>
<img src='https://static.pepy.tech/personalized-badge/tsdb?period=total&units=international_system&left_color=gray&right_color=blue&left_text=Downloads'>
</a>
<!-- Code of Conduct -->
<a alt='CODE_OF_CONDUCT' href='CODE_OF_CONDUCT.md'>
<img src='https://img.shields.io/badge/Contributor%20Covenant-v2.1-4baaaa.svg'>
</a>
<!-- Visit number -->
<img src='https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FWenjieDu%2FTime_Series_Database&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Visits&edge_flat=false'>
</p>

> 📣 TSDB now supports a total of 1️⃣1️⃣9️⃣ time-series datasets ‼️
Project TSDB is created to help researchers and engineers get rid of data collecting and downloading, and focus back on data processing details. TSDB provides all-in-one-stop convenience for downloading and loading open-source time-series datasets (available datasets listed [below](https://github.com/WenjieDu/TSDB#-list-of-available-datasets)).

**❕️Note that** due to people have very different requirements for data processing, data-loading functions in TSDB only contain the most general steps (e.g. removing invalid samples) and won't process the data (not even normalize it). So, no worries, TSDB won't affect your data preprocessing. If you only want the raw datasets, TSDB can help you download and save raw datasets as well (take a look at [Usage Examples](https://github.com/WenjieDu/TSDB#-usage-example) below).
❗️Please note that due to people have very different requirements for data processing, data-loading functions in TSDB only contain the most general steps (e.g. removing invalid samples) and won't process the data (not even normalize it). So, no worries, TSDB won't affect your data preprocessing. If you only want the raw datasets, TSDB can help you download and save raw datasets as well (take a look at [Usage Examples](https://github.com/WenjieDu/TSDB#-usage-example) below).

🤝 If you need TSDB to integrate an open-source dataset or want to add it into TSDB yourself, please feel free to request for it by creating an issue or make a PR to merge your code.

Expand Down Expand Up @@ -67,4 +65,9 @@ That's all. Simple and efficient. Enjoy it! 😃
| [UCR & UEA Datasets](datasets/UCR_UEA_Datasets) (all 115 datasets) | Classification |

## ❖ License
Please note that TSDB is open source under [license GPL-3.0](https://en.wikipedia.org/wiki/GNU_General_Public_License#Version_3).
Please note that TSDB is open source under [license GPL-3.0](https://en.wikipedia.org/wiki/GNU_General_Public_License#Version_3).

<details>
<summary>🏠 Visits</summary>
<img align='left' src='https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FWenjieDu%2FTime_Series_Database&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Visits+since+April+2022&edge_flat=false'>
</details>
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
setup(
name='tsdb',
version=version,
description='TSDB (Time Series DataBase): A Python Toolbox Helping Load Open-Source Time-Series Datasets',
description='TSDB (Time-Series DataBase): A Python Toolbox Helping Load Open-Source Time-Series Datasets',
long_description=README,
long_description_content_type='text/markdown',
license='GPL-3.0',
Expand Down

0 comments on commit 7833ed8

Please sign in to comment.