Skip to content

Commit ec0eb11

Browse files
authored
Merge pull request #12 from JuliaAI/bugfix2
fix docstring and build documentation - take II
2 parents 820f4cd + 1372315 commit ec0eb11

File tree

3 files changed

+28
-18
lines changed

3 files changed

+28
-18
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: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,17 @@ MMI.metadata_model(
8787
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: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ It recursively removes features, training a base model on the remaining features
4848
evaluating their importance until the desired number of features is selected.
4949
5050
Construct an instance with default hyper-parameters using the syntax
51-
`model = RecursiveFeatureElimination(model=...)`. Provide keyword arguments to override
51+
`rfe_model = RecursiveFeatureElimination(model=...)`. Provide keyword arguments to override
5252
hyper-parameter defaults.
5353
5454
# Training data
55-
In MLJ or MLJBase, bind an instance `model` to data with
55+
In MLJ or MLJBase, bind an instance `rfe_model` to data with
5656
57-
mach = machine(model, X, y)
57+
mach = machine(rfe_model, X, y)
5858
5959
OR, if the base model supports weights, as
6060
61-
mach = machine(model, X, y, w)
61+
mach = machine(rfe_model, X, y, w)
6262
6363
Here:
6464
@@ -387,3 +387,16 @@ end
387387
function MMI.training_losses(model::RFE, rfe_report)
388388
return MMI.training_losses(model.model, rfe_report.model_report)
389389
end
390+
391+
## Pkg Traits
392+
MMI.metadata_pkg.(
393+
(
394+
DeterministicRecursiveFeatureElimination,
395+
ProbabilisticRecursiveFeatureElimination,
396+
),
397+
package_name = "FeatureSelection",
398+
package_uuid = "33837fe5-dbff-4c9e-8c2f-c5612fe2b8b6",
399+
package_url = "https://github.com/JuliaAI/FeatureSelection.jl",
400+
is_pure_julia = true,
401+
package_license = "MIT"
402+
)

0 commit comments

Comments
 (0)