Skip to content

Commit 70ba982

Browse files
committed
doc-string improvement
1 parent fd7ceed commit 70ba982

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

src/MLJDecisionTreeInterface.jl

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -338,10 +338,11 @@ where
338338
339339
- `X`: any table of input features (eg, a `DataFrame`) whose columns
340340
each have one of the following element scitypes: `Continuous`,
341-
`Count`, or `<:OrderedFactor`.
341+
`Count`, or `<:OrderedFactor`; check column scitypes with `schema(X)`
342342
343343
- `y`: is the target, which can be any `AbstractVector` whose element
344-
scitype is `<:OrderedFactor` or `<:Multiclass`.
344+
scitype is `<:OrderedFactor` or `<:Multiclass`; check the scitype
345+
with `scitype(y)`
345346
346347
Train the machine using `fit!(mach, rows=...)`.
347348
@@ -470,10 +471,11 @@ where
470471
471472
- `X`: any table of input features (eg, a `DataFrame`) whose columns
472473
each have one of the following element scitypes: `Continuous`,
473-
`Count`, or `<:OrderedFactor`.
474+
`Count`, or `<:OrderedFactor`; check column scitypes with `schema(X)`
474475
475476
- `y`: the target, which can be any `AbstractVector` whose element
476-
scitype is `<:OrderedFactor` or `<:Multiclass`.
477+
scitype is `<:OrderedFactor` or `<:Multiclass`; check the scitype
478+
with `scitype(y)`
477479
478480
Train the machine with `fit!(mach, rows=...)`.
479481
@@ -556,10 +558,11 @@ where:
556558
557559
- `X`: any table of input features (eg, a `DataFrame`) whose columns
558560
each have one of the following element scitypes: `Continuous`,
559-
`Count`, or `<:OrderedFactor`.
561+
`Count`, or `<:OrderedFactor`; check column scitypes with `schema(X)`
560562
561563
- `y`: the target, which can be any `AbstractVector` whose element
562-
scitype is `<:OrderedFactor` or `<:Multiclass`.
564+
scitype is `<:OrderedFactor` or `<:Multiclass`; check the scitype
565+
with `scitype(y)`
563566
564567
Train the machine with `fit!(mach, rows=...)`.
565568
@@ -629,10 +632,10 @@ where
629632
630633
- `X`: any table of input features (eg, a `DataFrame`) whose columns
631634
each have one of the following element scitypes: `Continuous`,
632-
`Count`, or `<:OrderedFactor`.
635+
`Count`, or `<:OrderedFactor`; check column scitypes with `schema(X)`
633636
634637
- `y`: the target, which can be any `AbstractVector` whose element
635-
scitype is `Continuous`.
638+
scitype is `Continuous`; check the scitype with `scitype(y)`
636639
637640
Train the machine with `fit!(mach, rows=...)`.
638641
@@ -709,10 +712,10 @@ where
709712
710713
- `X`: any table of input features (eg, a `DataFrame`) whose columns
711714
each have one of the following element scitypes: `Continuous`,
712-
`Count`, or `<:OrderedFactor`.
715+
`Count`, or `<:OrderedFactor`; check column scitypes with `schema(X)`
713716
714717
- `y`: the target, which can be any `AbstractVector` whose element
715-
scitype is `Continuous`.
718+
scitype is `Continuous`; check the scitype with `scitype(y)`
716719
717720
Train the machine with `fit!(mach, rows=...)`.
718721

0 commit comments

Comments
 (0)