search

thaler-lab / Wasserstein

Python/C++ library for computing Wasserstein distances efficiently.
https://thaler-lab.github.io/Wasserstein
Other
21 stars 8 forks source link

docs: Correct argument order in CorrelationDimension example #6

Closed matthewfeickert closed 8 months ago

matthewfeickert commented 1 year ago

In https://github.com/pkomiske/Wasserstein/commit/8f4592e5a084ce935681323a93f34c0894fbc1ca for v0.3.2 the order of arguments for wasserstein.CorrelationDimension was changed to have nbins first to

better match boost histogram usage.

This PR applies that correction to the "Wasserstein Demo.ipynb" notebook.

As expected once one knows about this arg order change, without it the user will be met with

TypeError: in method 'new_CorrelationDimensionFloat64', argument 1 of type 'unsigned int'
matthewfeickert commented 1 year ago

@pkomiske this is ready for review.

matthewfeickert commented 1 year ago

@pkomiske small reminder ping.

matthewfeickert commented 8 months ago

@rikab this is ready for review.

matthewfeickert commented 8 months ago

Thanks @rikab!