Skip to content

Commit

Permalink
Add note to LC docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Glenn Moynihan committed Apr 16, 2021
1 parent e29d95f commit da21841
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/linear_combination.jl
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
"""
LinearCombination(coefficients) <: Transform
Calculates the linear combination of a collection of terms weighted be some `coefficients`.
Calculates the linear combination of a collection of terms weighted by some `coefficients`.
When applied to an N-dimensional array, `LinearCombination` reduces along the `dim` provided
and returns an (N-1)-dimensional array.
If no `inds` are specified, then the transform is applied to all elements.
!!!note
The current default is that `dims=1` but this behaviour will be deprecated in a future
release and the `dims` keyword argument will have to be specified explicitly.
https://github.com/invenia/FeatureTransforms.jl/issues/82
"""
struct LinearCombination <: Transform
coefficients::Vector{Real}
Expand Down

0 comments on commit da21841

Please sign in to comment.