Skip to content

Commit ec5b2b7

Browse files
authored
Add parameters function (#5)
* Add 'parameters' function * Add fallback
1 parent 6d26936 commit ec5b2b7

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

src/interface.jl

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ object is valid for the `transform`.
6161
"""
6262
function assertions end
6363

64+
"""
65+
parameters(transform)
66+
67+
Returns a named tuple with the adjustable parameters of the `transform`.
68+
"""
69+
function parameters end
70+
6471
"""
6572
prep = preprocess(transform, object)
6673
@@ -108,6 +115,8 @@ isinvertible(::Type{<:Transform}) = false
108115

109116
assertions(transform::Transform) = []
110117

118+
parameters(transform::Transform) = (;)
119+
111120
preprocess(transform::Transform, object) = nothing
112121

113122
reapply(transform::Transform, object, cache) = apply(transform, object) |> first

test/runtests.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ using Test
1717
@test !TransformsBase.isrevertible(T T)
1818
@test !TransformsBase.isinvertible(T T)
1919
@test TransformsBase.assertions(T) |> isempty
20+
@test TransformsBase.parameters(T) isa NamedTuple
21+
@test TransformsBase.parameters(T) |> isempty
2022
@test TransformsBase.preprocess(T, nothing) |> isnothing
2123
@test TransformsBase.reapply(T, 1, nothing) == 1
2224

0 commit comments

Comments
 (0)