Skip to content

Commit 615f03e

Browse files
EssamWisamEssamWisam
committed
👨‍🔧 Fix for docstrings
1 parent f60f640 commit 615f03e

File tree

10 files changed

+76
-28
lines changed

10 files changed

+76
-28
lines changed

‎src/MLJTransforms.jl‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ using Tables
55
# https://github.com/JuliaAI/MLJBase.jl/issues/1002
66
import ScientificTypes: elscitype, schema, coerce, ScientificTimeType
77
using MLJModelInterface # exports `scitype`, which will call `ScientificTypes.scitype`,
8-
# once MLJBase is loaded (but this is not a dependency!)
8+
# once MLJBase is loaded (but this is not a dependency!)
99
using CategoricalArrays
1010
using TableOperations
1111
using StatsBase
@@ -29,27 +29,27 @@ include("utils.jl")
2929
include("encoders/target_encoding/errors.jl")
3030
include("encoders/target_encoding/target_encoding.jl")
3131
include("encoders/target_encoding/interface_mlj.jl")
32-
export TargetEncoder
32+
export TargetEncoder
3333

3434
# Ordinal encoding
3535
include("encoders/ordinal_encoding/ordinal_encoding.jl")
3636
include("encoders/ordinal_encoding/interface_mlj.jl")
37-
export OrdinalEncoder
37+
export OrdinalEncoder
3838

3939
# Frequency encoding
4040
include("encoders/frequency_encoding/frequency_encoding.jl")
4141
include("encoders/frequency_encoding/interface_mlj.jl")
4242
export frequency_encoder_fit, frequency_encoder_transform, FrequencyEncoder
43-
export FrequencyEncoder
43+
export FrequencyEncoder
4444

4545
# Cardinality reduction
4646
include("transformers/cardinality_reducer/cardinality_reducer.jl")
4747
include("transformers/cardinality_reducer/interface_mlj.jl")
4848
export cardinality_reducer_fit, cardinality_reducer_transform, CardinalityReducer
49-
export CardinalityReducer
49+
export CardinalityReducer
5050
include("encoders/missingness_encoding/missingness_encoding.jl")
5151
include("encoders/missingness_encoding/interface_mlj.jl")
52-
export MissingnessEncoder
52+
export MissingnessEncoder
5353

5454
# Contrast encoder
5555
include("encoders/contrast_encoder/contrast_encoder.jl")
@@ -65,7 +65,6 @@ include("transformers/other_transformers/one_hot_encoder.jl")
6565
include("transformers/other_transformers/standardizer.jl")
6666
include("transformers/other_transformers/univariate_boxcox_transformer.jl")
6767
include("transformers/other_transformers/univariate_discretizer.jl")
68-
include("transformers/other_transformers/metadata_shared.jl")
6968

7069
export UnivariateDiscretizer,
7170
UnivariateStandardizer, Standardizer, UnivariateBoxCoxTransformer,

‎src/transformers/other_transformers/continuous_encoder.jl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,14 @@ metadata_model(ContinuousEncoder,
7575
output_scitype = Table(Continuous),
7676
load_path = "MLJTransforms.ContinuousEncoder")
7777

78+
# Package metadata for docstring generation
79+
metadata_pkg(ContinuousEncoder,
80+
package_name = "MLJTransforms",
81+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
82+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
83+
is_pure_julia = true,
84+
package_license = "MIT")
85+
7886
"""
7987
$(MLJModelInterface.doc_header(ContinuousEncoder))
8088

‎src/transformers/other_transformers/fill_imputer.jl‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,14 @@ metadata_model(FillImputer,
194194
output_scitype = Table,
195195
load_path = "MLJTransforms.FillImputer")
196196

197+
# Package metadata for docstring generation
198+
metadata_pkg(UnivariateFillImputer,
199+
package_name = "MLJTransforms",
200+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
201+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
202+
is_pure_julia = true,
203+
package_license = "MIT")
204+
197205
"""
198206
$(MLJModelInterface.doc_header(UnivariateFillImputer))
199207
@@ -294,7 +302,13 @@ For imputing tabular data, use [`FillImputer`](@ref).
294302
"""
295303
UnivariateFillImputer
296304

297-
305+
# Package metadata for docstring generation
306+
metadata_pkg(FillImputer,
307+
package_name = "MLJTransforms",
308+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
309+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
310+
is_pure_julia = true,
311+
package_license = "MIT")
298312

299313
"""
300314
$(MLJModelInterface.doc_header(FillImputer))

‎src/transformers/other_transformers/interaction_transformer.jl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ metadata_model(InteractionTransformer,
4040
human_name = "interaction transformer",
4141
load_path = "MLJTransforms.InteractionTransformer")
4242

43+
# Package metadata for docstring generation
44+
metadata_pkg(InteractionTransformer,
45+
package_name = "MLJTransforms",
46+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
47+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
48+
is_pure_julia = true,
49+
package_license = "MIT")
50+
4351
"""
4452
$(MLJModelInterface.doc_header(InteractionTransformer))
4553

‎src/transformers/other_transformers/metadata_shared.jl‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎src/transformers/other_transformers/one_hot_encoder.jl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,14 @@ metadata_model(OneHotEncoder,
165165
human_name = "one-hot encoder",
166166
load_path = "MLJTransforms.OneHotEncoder")
167167

168+
# Package metadata for docstring generation
169+
metadata_pkg(OneHotEncoder,
170+
package_name = "MLJTransforms",
171+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
172+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
173+
is_pure_julia = true,
174+
package_license = "MIT")
175+
168176
"""
169177
$(MLJModelInterface.doc_header(OneHotEncoder))
170178

‎src/transformers/other_transformers/standardizer.jl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,14 @@ metadata_model(Standardizer,
236236
output_scitype = Union{Table, AbstractVector{<:Continuous}},
237237
load_path = "MLJTransforms.Standardizer")
238238

239+
# Package metadata for docstring generation
240+
metadata_pkg(Standardizer,
241+
package_name = "MLJTransforms",
242+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
243+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
244+
is_pure_julia = true,
245+
package_license = "MIT")
246+
239247
"""
240248
$(MLJModelInterface.doc_header(Standardizer))
241249

‎src/transformers/other_transformers/univariate_boxcox_transformer.jl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ metadata_model(UnivariateBoxCoxTransformer,
9393
human_name = "single variable Box-Cox transformer",
9494
load_path = "MLJTransforms.UnivariateBoxCoxTransformer")
9595

96+
# Package metadata for docstring generation
97+
metadata_pkg(UnivariateBoxCoxTransformer,
98+
package_name = "MLJTransforms",
99+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
100+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
101+
is_pure_julia = true,
102+
package_license = "MIT")
103+
96104
"""
97105
$(MLJModelInterface.doc_header(UnivariateBoxCoxTransformer))
98106

‎src/transformers/other_transformers/univariate_discretizer.jl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,13 @@ metadata_model(UnivariateDiscretizer,
9696
human_name = "single variable discretizer",
9797
load_path = "MLJTransforms.UnivariateDiscretizer")
9898

99+
# Package metadata for docstring generation
100+
metadata_pkg(UnivariateDiscretizer,
101+
package_name = "MLJTransforms",
102+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
103+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
104+
is_pure_julia = true,
105+
package_license = "MIT")
99106

100107
"""
101108
$(MLJModelInterface.doc_header(UnivariateDiscretizer))

‎src/transformers/other_transformers/univariate_time_type_to_continuous.jl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,14 @@ metadata_model(UnivariateTimeTypeToContinuous,
131131
"continuous representations of temporally typed data",
132132
load_path = "MLJTransforms.UnivariateTimeTypeToContinuous")
133133

134+
# Package metadata for docstring generation
135+
metadata_pkg(UnivariateTimeTypeToContinuous,
136+
package_name = "MLJTransforms",
137+
package_uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6",
138+
package_url = "https://github.com/JuliaAI/MLJTransforms.jl",
139+
is_pure_julia = true,
140+
package_license = "MIT")
141+
134142
"""
135143
$(MLJModelInterface.doc_header(UnivariateTimeTypeToContinuous))
136144

0 commit comments

Comments
 (0)