Merge pull request #208 from rafaqz/threading_docs

document use_multithreading keyword
JuliaAI · Jan 16, 2023 · f57a156 · f57a156
2 parents 835f3cd + bf0ef4a
commit f57a156
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/classification/main.jl b/src/classification/main.jl
@@ -268,6 +268,7 @@ function prune_tree(
 end
 
 
+
 apply_tree(leaf::Leaf, feature::AbstractVector) = leaf.majority
 apply_tree(
     tree::Root{S, T},
@@ -447,6 +448,15 @@ function apply_forest(forest::Ensemble{S, T}, features::AbstractVector{S}) where
     end
 end
 
+"""
+    apply_forest(forest::Ensemble, features::AbstractMatrix; use_multithreading=false)
+
+Apply learned model `forest` to `features`.
+
+# Keywords 
+
+- `use_multithreading::Bool`: `true` to use multiple cores, if available. `false` by default.
+"""
 function apply_forest(
         forest::Ensemble{S, T},
         features::AbstractMatrix{S};