bump version

baggepinnen · Jun 23, 2020 · f7a4d08 · f7a4d08
1 parent eac7d2d
commit f7a4d08
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 6 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "SpectralDistances"
 uuid = "2b0dec9d-f767-4f95-9e73-7df56487de68"
 authors = ["Fredrik Bagge Carlson <baggepinnen@gmail.com>"]
-version = "0.1.6"
+version = "0.1.7"
 
 [deps]
 BackwardsLinalg = "442b4e1a-8b9d-11e9-03b0-f14b31742153"

diff --git a/docs/src/time.md b/docs/src/time.md
@@ -152,11 +152,8 @@ The distance [`ConvOptimalTransportDistance`](@ref) can operate on 2D measures o
 This distance has a special option
 - `invariant_axis::Int = 0`
 
-If this is set to 1 or 2, the distance will be approximately invariant to translations along the invariant axis. As an example, to be invariant to a spectrogram being shifted slightly in time, set `invariant_axis = 2`. If this option is used, the distance is not differentiable and this option will be ignored when calculating barycenters etc. 
+If this is set to 1 or 2, the distance will be approximately invariant to translations of the entire measure along the invariant axis. As an example, to be invariant to a spectrogram being shifted slightly in time, set `invariant_axis = 2`. If this option is used, the distance is not differentiable and this option will be ignored when calculating barycenters etc.
 
-```@docs
-ConvOptimalTransportDistance
-```
 
 ## Dynamic Time Warping
 This package interfaces with [DynamicAxisWarping.jl](https://github.com/baggepinnen/DynamicAxisWarping.jl) and provides optimized methods for [`DynamicAxisWarping.dtwnn`](@ref). Below is an example of how to search for a query pattern `Qm` in a much longer pattern `Ym`

diff --git a/src/time.jl b/src/time.jl
@@ -186,7 +186,7 @@ end
     SlidingDistancesBase.distance_profile(d::ConvOptimalTransportDistance, q::DSP.Periodograms.TFR, y::DSP.Periodograms.TFR; stride=1, kwargs...)
 
 Optimized method for [`ConvOptimalTransportDistance`](@ref). To get smooth distance profiles, a slightly higher β than for barycenters is recommended.  β around 0.01 should do fine.
-- `stride`: allows you to reduce computations by taking setting `stride > 1`.
+- `stride`: allows you to reduce computations by setting `stride > 1`.
 """
 function SlidingDistancesBase.distance_profile(d::ConvOptimalTransportDistance, q::DSP.Periodograms.TFR, y::DSP.Periodograms.TFR; stride=1, kwargs...)