battery-intelligence-lab / dtw-cpp Goto Github PK

DTWC++

Home Page: https://battery-intelligence-lab.github.io/dtw-cpp/

C++ 59.14% CMake 27.11% TeX 8.21% Python 5.53%

dynamic-time-warping time-series-clustering

dtw-cpp's Introduction

DTW-C++

There is separate detailed documentation available for this project; this readme.md file only gives a short summary. If you have any issues running the code in the main branch, please switch to the dtw-cpp_v0.0.2 branch instead.

Introduction

DTW-C++ is a dynamic time warping (DTW) and clustering library for time series data, written in C++. Users can input multiple time series and find clusters of similar time series. Time series may be the same lengths, or different lengths. The number of clusters to find may be fixed, or a range of numbers to try may be specified. DTW-C++ finds clusters in time series data using k-medoids or mixed integer programming (MIP); k-medoids is generally faster, but may get stuck in local optima; MIP can find globally optimal clusters.

Contributors

_{Becky Perriment}
💡💻👀⚠️

_{Volkan Kumtepeli}
💡💻👀⚠️🚇🐢

_{David Howey}
💡👀

dtw-cpp's People

Contributors

Stargazers

Watchers

Forkers

feixuedudiao

dtw-cpp's Issues

No warning when data not loaded

The software does not give a warning when data is not loaded. It would be helpful to have such a warning for debugging purposes

Third-party software installation guidelines

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881.

The third-party software (e.g., CMake, OpenMP, Gurobi) installation guidelines are missing and could be integrated into the documentation.

Benchmarking dependencies and references

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881

No "requirments.txt" (or something equivalent) is provided to run the python benchmarks; however, they use third-party libraries.
In the bibliography, the library "dtaidistance" (github, zenodo) references an old version from 2020 (v2.0.0), while there is a more modern version from 2022(v2.3.10). Is the 2020 version used mistakenly?

Community guideline improvement

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881.

The "develop" folder contains community guidelines. It could improved to better cover the second item in "Community Guidlines" in the JOSS' checklist.

Build finished with error code 2

Installation documentation

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881.

In installation
cd DTWC++ is wrong it should be cd dtw-cpp

running is itself the installation, and overview, installation, running should be in order. Also -j32 should not be assumed where you could use this command in in linux to determine number of processors.

cmake --build . -j$(( $(nproc) * 2 -1))

Minor comments in executive file location

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881 (comment). Could you please add the directory of dtwc_main to help the user to specify the location? To be specifically, in https://battery-intelligence-lab.github.io/dtw-cpp/1_getting_started/direct_use.html, you may add the ./dtw-cpp/bin to direct people to the correct path. Thanks!

Issues locating Gurobi environmental variable

Trouble locating gurobi environmental variable without hardcoding

Memory profiler overhead in benchmarks

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881

For other libraries, benchmark code includes a memory profiler (trace malloc), while the authors' library does not include a memory profiler.

When obtaining benchmarks, is the overhead caused by the memory profiler considered?

Reference duplication

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881.

The reference "The UCR Time Series Classification Archive" is duplicated [1, 2] in the bibliography.

battery-intelligence-lab / dtw-cpp Goto Github PK

dtw-cpp's Introduction

DTW-C++

Introduction

Contributors

dtw-cpp's People

Contributors

Stargazers

Watchers

Forkers

dtw-cpp's Issues

Recommend Projects

Recommend Topics

Recommend Org