Skip to content

Commit

Permalink
docs: update README and some docs;
Browse files Browse the repository at this point in the history
  • Loading branch information
WenjieDu committed Jun 27, 2024
1 parent 8c87e6d commit e571f13
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<h3 align="center">Welcome to TSDB</h3>

*<p align='center'>a Python toolbox to ease loading public time-series datasets</p>*
*<p align='center'>a Python toolbox to ease loading 172 public time-series datasets</p>*

<p align='center'>
<a href='https://github.com/WenjieDu/TSDB'>
Expand Down Expand Up @@ -46,7 +46,7 @@
</a>
</p>

> 📣 TSDB now supports a total of 1️⃣7️⃣0️⃣ time-series datasets ‼️
> 📣 TSDB now supports a total of 1️⃣7️⃣2️⃣ time-series datasets ‼️
<a href='https://github.com/WenjieDu/PyPOTS'><img src='https://pypots.com/figs/pypots_logos/PyPOTS/logo_FFBG.svg' width='160' align='left' /></a>
TSDB is a part of
Expand Down Expand Up @@ -88,7 +88,9 @@ data = tsdb.load('physionet_2012')
tsdb.download_and_extract('physionet_2012', './save_it_here')
# datasets you once loaded are cached, and you can check them with list_cached_data()
tsdb.list_cache()
# you can delete only one specific dataset and preserve others
# you can delete only one specific dataset's pickled cache
tsdb.delete_cache(dataset_name='physionet_2012', only_pickle=True)
# you can delete only one specific dataset raw files and preserve others
tsdb.delete_cache(dataset_name='physionet_2012')
# or you can delete all cache with delete_cached_data() to free disk space
tsdb.delete_cache()
Expand All @@ -112,6 +114,8 @@ That's all. Simple and efficient. Enjoy it! 😃
| [Electricity Load Diagrams](dataset_profiles/electricity_load_diagrams) | Forecasting, Imputation |
| [Electricity Transformer Temperature (ETT)](dataset_profiles/electricity_transformer_temperature) | Forecasting, Imputation |
| [Vessel AIS](dataset_profiles/vessel_ais) | Forecasting, Imputation, Classification |
| [PeMS Traffic](dataset_profiles/pems_traffic) | Forecasting, Imputation |
| [Solar Alabama](dataset_profiles/solar_alabama) | Forecasting, Imputation |
| [UCR & UEA Datasets](dataset_profiles/ucr_uea_datasets) (all 163 datasets) | Classification |


Expand Down
File renamed without changes.
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 Data Beans): a Python toolbox helping load open-source time-series datasets",
description="TSDB (Time Series Data Beans): a Python toolbox helping load 172 open-source time-series datasets",
long_description=README,
long_description_content_type="text/markdown",
license="BSD-3-Clause",
Expand Down
2 changes: 1 addition & 1 deletion tsdb/loading_funcs/solar_alabama.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
https://www.nrel.gov/grid/solar-power-data.html
For more information please refer to:
https://github.com/WenjieDu/TSDB/tree/main/dataset_profiles/solar_al
https://github.com/WenjieDu/TSDB/tree/main/dataset_profiles/solar_alabama
"""

# Created by Wenjie Du <wenjay.du@gmail.com>
Expand Down

0 comments on commit e571f13

Please sign in to comment.