deepcharles / ruptures

ruptures: change point detection in Python

BSD 2-Clause "Simplified" License

1.62k stars 163 forks source link

docs: add music segmentation example #115

Closed oboulant closed 3 years ago

codecov[bot] commented 3 years ago

Codecov Report

Merging #115 (c5d33d2) into master (bf4364a) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #115   +/-   ##
=======================================
  Coverage   95.12%   95.12%           
=======================================
  Files          41       41           
  Lines         965      965           
=======================================
  Hits          918      918           
  Misses         47       47

Impacted Files	Coverage Δ
src/ruptures/detection/kernelcpd.py	`100.00% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bf4364a...c5d33d2. Read the comment docs.

oboulant commented 3 years ago

We will have to make a new release and upload the package to Pypi for the music example to work with Binder. We need the fix on float --> double.

deepcharles commented 3 years ago

@oboulant I have simplified a bit the example:

I removed the chromagram and only kept the tempogram because the change points were cleaner.
I only used one change point detection method
I removed the section "Study of individual segments"

I added a bit of text and a data-driven way to find the number of changes.

We need to add some comments about the estimated changes (e.g. "they are good because...") and a small conclusion.

deepcharles commented 3 years ago

we should also add the author (you) somewhere. (And maybe an editor (me) field.)

deepcharles commented 3 years ago

I noticed you could do something like the following

pip install ruptures[dev,docs]

to install ruptures.

So I created a more meaningful structure in setup.cfg>[options.extras_require].

I also changes the gh actions accordingly

deepcharles commented 3 years ago

I'll let you look, but otherwise everything looks good to me

oboulant commented 3 years ago

I noticed you could do something like the following
pip install ruptures[dev,docs]
to install ruptures.

So I created a more meaningful structure in setup.cfg>[options.extras_require].

I also changes the gh actions accordingly

Very nice, I wanted to do that on a separate PR but you are right, let's do it now !

oboulant commented 3 years ago

LGTM as well !