Skip to content

Commit ac1152d

Browse files
committed
code review polished
1 parent a495da5 commit ac1152d

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

src/MLJMultivariateStatsInterface.jl

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Where
170170
are of scitype `Continuous`; check the scitype with `schema(X)`
171171
172172
- `y`: is the target, which can be any `AbstractVector` whose element
173-
scitype is `Continuous`; check the scitype with `schema(y)`
173+
scitype is `Continuous`; check the scitype with `scitype(y)`
174174
175175
# Hyper-parameters
176176
@@ -196,7 +196,6 @@ using MLJ
196196
LinearRegressor = @load LinearRegressor pkg=MultivariateStats
197197
linear_regressor = LinearRegressor()
198198
199-
200199
X, y = make_regression(100, 2) # synthetic data
201200
mach = machine(linear_regressor, X, y) |> fit!
202201
@@ -205,7 +204,7 @@ yhat = predict(mach, Xnew) # new predictions
205204
```
206205
207206
See also
208-
TODO: ADD REFERENCES
207+
[`MultitargetLinearRegressor`](@ref), [`RidgeRegressor`](@ref), [`MultitargetRidgeRegressor`](@ref)
209208
"""
210209
LinearRegressor
211210

@@ -230,7 +229,7 @@ Where
230229
are of scitype `Continuous`; check the scitype with `schema(X)`
231230
232231
- `y`: is the target, which can be any table of responses whose element
233-
scitype is `Continuous`; check the scitype with `schema(y)`
232+
scitype is `Continuous`; check the scitype with `scitype(y)`
234233
235234
# Hyper-parameters
236235
@@ -270,7 +269,7 @@ yhat = predict(mach, Xnew) # new predictions
270269
```
271270
272271
See also
273-
TODO: ADD REFERENCES
272+
[`LinearRegressor`](@ref), [`RidgeRegressor`](@ref), [`MultitargetRidgeRegressor`](@ref)
274273
"""
275274
MultitargetLinearRegressor
276275

@@ -293,7 +292,7 @@ Where
293292
are of scitype `Continuous`; check the scitype with `schema(X)`
294293
295294
- `y`: is the target, which can be any `AbstractVector` whose element
296-
scitype is `Continuous`; check the scitype with `schema(y)`
295+
scitype is `Continuous`; check the scitype with `scitype(y)`
297296
298297
# Hyper-parameters
299298
@@ -345,7 +344,7 @@ yhat = predict(mach, Xnew) # new predictions
345344
```
346345
347346
See also
348-
TODO: ADD REFERENCES
347+
[`LinearRegressor`](@ref), [`MultitargetLinearRegressor`](@ref), [`MultitargetRidgeRegressor`](@ref)
349348
"""
350349
RidgeRegressor
351350

@@ -368,7 +367,7 @@ Where
368367
are of scitype `Continuous`; check the scitype with `schema(X)`
369368
370369
- `y`: is the target, which can be any table of responses whose element
371-
scitype is `Continuous`; check the scitype with `schema(y)`
370+
scitype is `Continuous`; check the scitype with `scitype(y)`
372371
373372
# Hyper-parameters
374373
@@ -425,7 +424,7 @@ yhat = predict(mach, Xnew) # new predictions
425424
```
426425
427426
See also
428-
TODO: ADD REFERENCES
427+
[`LinearRegressor`](@ref), [`MultitargetLinearRegressor`](@ref), [`RidgeRegressor`](@ref)
429428
"""
430429
MultitargetRidgeRegressor
431430

@@ -503,7 +502,7 @@ projection = transform(mach, X)
503502
```
504503
505504
See also
506-
TODO: ADD REFERENCES
505+
[`KernelPCA`](@ref), [`ICA`](@ref), [`FactorAnalysis`](@ref), [`PPCA`](@ref)
507506
"""
508507
PCA
509508
"""
@@ -580,7 +579,7 @@ projection = transform(mach, X)
580579
```
581580
582581
See also
583-
TODO: ADD REFERENCES
582+
[`PCA`](@ref), [`ICA`](@ref), [`FactorAnalysis`](@ref), [`PPCA`](@ref)
584583
"""
585584
KernelPCA
586585
"""
@@ -653,7 +652,7 @@ projection = transform(mach, X)
653652
```
654653
655654
See also
656-
TODO: ADD REFERENCES
655+
[`PCA`](@ref), [`KernelPCA`](@ref), [`FactorAnalysis`](@ref), [`PPCA`](@ref)
657656
"""
658657
ICA
659658
"""
@@ -681,7 +680,7 @@ Where
681680
are of scitype `Continuous`; check the scitype with `schema(X)`
682681
- `y`: is the target, which can be any `AbstractVector` whose element
683682
scitype is `<:OrderedFactor(2)` or `<:Multiclass(2)`; check the scitype
684-
with `schema(y)`
683+
with `scitype(y)`
685684
686685
# Hyper-parameters
687686
@@ -753,7 +752,7 @@ labels = predict_mode(mach, x)
753752
```
754753
755754
See also
756-
TODO: ADD REFERENCES
755+
[`BayesianLDA`](@ref), [`SubspaceLDA`](@ref), [`BayesianSubspaceLDA`](@ref)
757756
"""
758757
LDA
759758
"""
@@ -786,7 +785,7 @@ Where
786785
are of scitype `Continuous`; check the scitype with `schema(X)`
787786
- `y`: is the target, which can be any `AbstractVector` whose element
788787
scitype is `<:OrderedFactor(2)` or `<:Multiclass(2)`; check the scitype
789-
with `schema(y)`
788+
with `scitype(y)`
790789
791790
# Hyper-parameters
792791
@@ -861,7 +860,7 @@ labels = predict_mode(mach, x)
861860
```
862861
863862
See also
864-
TODO: ADD REFERENCES
863+
[`LDA`](@ref), [`SubspaceLDA`](@ref), [`BayesianSubspaceLDA`](@ref)
865864
"""
866865
BayesianLDA
867866
"""
@@ -893,7 +892,7 @@ Where
893892
are of scitype `Continuous`; check the scitype with `schema(X)`
894893
- `y`: is the target, which can be any `AbstractVector` whose element
895894
scitype is `<:OrderedFactor(2)` or `<:Multiclass(2)`; check the scitype
896-
with `schema(y)`
895+
with `scitype(y)`
897896
898897
# Hyper-parameters
899898
@@ -956,7 +955,7 @@ labels = predict_mode(mach, X)
956955
```
957956
958957
See also
959-
TODO: ADD REFERENCES
958+
[`LDA`](@ref), [`BayesianLDA`](@ref), [`BayesianSubspaceLDA`](@ref)
960959
"""
961960
SubspaceLDA
962961
"""
@@ -987,7 +986,7 @@ Where
987986
are of scitype `Continuous`; check the scitype with `schema(X)`
988987
- `y`: is the target, which can be any `AbstractVector` whose element
989988
scitype is `<:OrderedFactor(2)` or `<:Multiclass(2)`; check the scitype
990-
with `schema(y)`
989+
with `scitype(y)`
991990
992991
# Hyper-parameters
993992
@@ -1052,7 +1051,7 @@ labels = predict_mode(mach, X)
10521051
```
10531052
10541053
See also
1055-
TODO: ADD REFERENCES
1054+
[`LDA`](@ref), [`BayesianLDA`](@ref), [`SubspaceLDA`](@ref)
10561055
"""
10571056
BayesianSubspaceLDA
10581057
"""
@@ -1124,7 +1123,7 @@ projection = transform(mach, X)
11241123
```
11251124
11261125
See also
1127-
TODO: ADD REFERENCES
1126+
[`KernelPCA`](@ref), [`ICA`](@ref), [`PPCA`](@ref), [`PCA`](@ref)
11281127
"""
11291128
FactorAnalysis
11301129
"""
@@ -1196,7 +1195,7 @@ projection = transform(mach, X)
11961195
```
11971196
11981197
See also
1199-
TODO: ADD REFERENCES
1198+
[`KernelPCA`](@ref), [`ICA`](@ref), [`FactorAnalysis`](@ref), [`PCA`](@ref)
12001199
"""
12011200
PPCA
12021201
end

0 commit comments

Comments
 (0)