Add documentation saying the tsdownsample algorithm is available

holoviz / holoviews

With Holoviews, your data visualizes itself.

https://holoviews.org

BSD 3-Clause "New" or "Revised" License

2.66k stars 397 forks source link

Add documentation saying the tsdownsample algorithm is available #6080

Open hoxbro opened 5 months ago

hoxbro commented 5 months ago

https://github.com/holoviz/holoviews/pull/6059 added tsdownsample algorithms. We should, at a minimum, update the documentation to mention it.

Right now the other downsamples are mentioned here: https://holoviews.org/user_guide/Large_Data.html#working-with-time-series

Victorasuquo commented 5 months ago

on this now

droumis commented 4 months ago

Hi @Victorasuquo , were you planning on submitting a PR to address this issue?

Victorasuquo commented 3 months ago

yes

droumis commented 3 months ago

@Victorasuquo, we are planning to release the next HoloViews version in the coming days which includes new tsdownsample algorithms, which still needs docs. Do you have a PR for us to review? Otherwise, we may have to go ahead and add a first version of these docs, and perhaps then you could improve them after that

droumis commented 3 months ago

Here are some notes:

Enhanced Downsampling Options

Starting in HoloViews version 1.19.0, integration with the tsdownsample library introduces enhanced downsampling algorithms, e.g. via downsample1d(curve, algorithm='minmax') :

lttb: Implements the Largest Triangle Three Buckets (LTTB) algorithm, optimizing the selection of points to retain the visual shape of the data.
minmax: For each segment of the data, this method retains the minimum and maximum values, ensuring that peaks and troughs are preserved.
minmax-lttb: A hybrid approach that combines the minmax strategy with LTTB.
m4: A multi-step process that leverages the min, max, first, and last values for each time segment.

Victorasuquo commented 3 months ago

okay thanks for the hints, I will continue with this

droumis commented 2 months ago

Hi @Victorasuquo, what is your timeline for this task?