Skip to content

Commit dffe57a

Browse files
committed
fix docstring and build documentation
1 parent 4906112 commit dffe57a

File tree

3 files changed

+30
-20
lines changed

3 files changed

+30
-20
lines changed

src/FeatureSelection.jl

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,4 @@ const MMI = MLJModelInterface
1010
include("models/featureselector.jl")
1111
include("models/rfe.jl")
1212

13-
## Pkg Traits
14-
MMI.metadata_pkg.(
15-
(
16-
DeterministicRecursiveFeatureElimination,
17-
ProbabilisticRecursiveFeatureElimination,
18-
FeatureSelector
19-
),
20-
package_name = "FeatureSelection",
21-
package_uuid = "33837fe5-dbff-4c9e-8c2f-c5612fe2b8b6",
22-
package_url = "https://github.com/JuliaAI/FeatureSelection.jl",
23-
is_pure_julia = true,
24-
package_license = "MIT"
25-
)
26-
2713
end # module

src/models/featureselector.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,20 @@ MMI.metadata_model(
8484
FeatureSelector,
8585
input_scitype = Table,
8686
output_scitype = Table,
87-
load_path = "FeatureSelction.FeatureSelector"
87+
load_path = "FeatureSelection.FeatureSelector"
8888
)
8989

90+
## Pkg Traits
91+
MMI.metadata_pkg(
92+
FeatureSelector,
93+
package_name = "FeatureSelection",
94+
package_uuid = "33837fe5-dbff-4c9e-8c2f-c5612fe2b8b6",
95+
package_url = "https://github.com/JuliaAI/FeatureSelection.jl",
96+
is_pure_julia = true,
97+
package_license = "MIT"
98+
)
99+
100+
## Docstring
90101
"""
91102
$(MMI.doc_header(FeatureSelector))
92103

src/models/rfe.jl

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,17 @@ It recursively removes features, training a base model on the remaining features
4747
evaluating their importance until the desired number of features is selected.
4848
4949
Construct an instance with default hyper-parameters using the syntax
50-
`model = RecursiveFeatureElimination(model=...)`. Provide keyword arguments to override
50+
`rfe_model = RecursiveFeatureElimination(model=...)`. Provide keyword arguments to override
5151
hyper-parameter defaults.
5252
5353
# Training data
54-
In MLJ or MLJBase, bind an instance `model` to data with
54+
In MLJ or MLJBase, bind an instance `rfe_model` to data with
5555
56-
mach = machine(model, X, y)
56+
mach = machine(rfe_model, X, y)
5757
5858
OR, if the base model supports weights, as
5959
60-
mach = machine(model, X, y, w)
60+
mach = machine(rfe_model, X, y, w)
6161
6262
Here:
6363
@@ -387,4 +387,17 @@ end
387387
## TRAINING LOSSES SUPPORT
388388
function MMI.training_losses(model::RFE, rfe_report)
389389
return MMI.training_losses(model.model, rfe_report.model_report)
390-
end
390+
end
391+
392+
## Pkg Traits
393+
MMI.metadata_pkg.(
394+
(
395+
DeterministicRecursiveFeatureElimination,
396+
ProbabilisticRecursiveFeatureElimination,
397+
),
398+
package_name = "FeatureSelection",
399+
package_uuid = "33837fe5-dbff-4c9e-8c2f-c5612fe2b8b6",
400+
package_url = "https://github.com/JuliaAI/FeatureSelection.jl",
401+
is_pure_julia = true,
402+
package_license = "MIT"
403+
)

0 commit comments

Comments
 (0)