Skip to content

Commit f8f2b5b

Browse files
committed
add reference for algorithms to doc-strings
1 parent da2d2ab commit f8f2b5b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/MLJDecisionTreeInterface.jl

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,20 @@ MMI.metadata_model(
325325

326326
# # DOCUMENT STRINGS
327327

328+
const DOC_CART = "[CART algorithm](https://en.wikipedia.org/wiki/Decision_tree_learning)"*
329+
", originally published in Breiman, Leo; Friedman, J. H.; Olshen, R. A.; "*
330+
"Stone, C. J. (1984): \"Classification and regression trees\". *Monterey, "*
331+
"CA: Wadsworth & Brooks/Cole Advanced Books & Software.*"
332+
333+
const DOC_RANDOM_FOREST = "[Random Forest algorithm]"*
334+
"(https://en.wikipedia.org/wiki/Random_forest), originally published in "*
335+
"Breiman, L. (2001): \"Random Forests.\", *Machine Learning*, vol. 45, pp. 5–32"
336+
328337
"""
329338
$(MMI.doc_header(DecisionTreeClassifier))
330339
340+
`DecisionTreeClassifier` implements the $DOC_CART.
341+
331342
# Training data
332343
333344
In MLJ or MLJBase, bind an instance `model` to data with
@@ -461,6 +472,9 @@ DecisionTreeClassifier
461472
"""
462473
$(MMI.doc_header(RandomForestClassifier))
463474
475+
`RandomForestClassifier` implements the standard $DOC_RANDOM_FOREST.
476+
477+
464478
# Training data
465479
466480
In MLJ or MLJBase, bind an instance `model` to data with
@@ -548,6 +562,7 @@ RandomForestClassifier
548562
"""
549563
$(MMI.doc_header(AdaBoostStumpClassifier))
550564
565+
551566
# Training data
552567
553568
In MLJ or MLJBase, bind an instance `model` to data with
@@ -622,6 +637,9 @@ AdaBoostStumpClassifier
622637
"""
623638
$(MMI.doc_header(DecisionTreeRegressor))
624639
640+
`DecisionTreeRegressor` implements the $DOC_CART.
641+
642+
625643
# Training data
626644
627645
In MLJ or MLJBase, bind an instance `model` to data with
@@ -702,6 +720,9 @@ DecisionTreeRegressor
702720
"""
703721
$(MMI.doc_header(RandomForestRegressor))
704722
723+
`DecisionTreeRegressor` implements the standard $DOC_RANDOM_FOREST
724+
725+
705726
# Training data
706727
707728
In MLJ or MLJBase, bind an instance `model` to data with

0 commit comments

Comments
 (0)