docs typo

Evovest · Oct 5, 2023 · cf6e3c0 · cf6e3c0 · jeremiedb · Oct 5, 2023
1 parent 0d502e0
commit cf6e3c0
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/src/fit.jl b/src/fit.jl
@@ -412,9 +412,16 @@ end
 
 
 """
-    fit_evotree(params::EvoTypes{L};
-        x_train::AbstractMatrix, y_train::AbstractVector, w_train=nothing, offset_train=nothing,
-        x_eval=nothing, y_eval=nothing, w_eval=nothing, offset_eval=nothing,
+    fit_evotree(
+        params::EvoTypes{L};
+        x_train::AbstractMatrix, 
+        y_train::AbstractVector, 
+        w_train=nothing, 
+        offset_train=nothing,
+        x_eval=nothing, 
+        y_eval=nothing, 
+        w_eval=nothing, 
+        offset_eval=nothing,
         early_stopping_rounds=9999,
         print_every_n=9999,
         verbosity=1)

diff --git a/src/init.jl b/src/init.jl
@@ -125,7 +125,15 @@ function init_core(params::EvoTypes{L}, ::Type{CPU}, data, fnames, y_train, w, o
 end
 
 """
-    init(params::EvoTypes{T,U,S}, X::AbstractMatrix, Y::AbstractVector, W = nothing)
+    init(
+        params::EvoTypes,
+        dtrain,
+        device::Type{<:Device}=CPU;
+        target_name,
+        fnames=nothing,
+        w_name=nothing,
+        offset_name=nothing
+    )
 
 Initialise EvoTree
 """
@@ -180,7 +188,15 @@ end
 
 
 """
-    init_evotree(params::EvoTypes{T,U,S}, X::AbstractMatrix, Y::AbstractVector, W = nothing)
+    init(
+        params::EvoTypes,
+        x_train::AbstractMatrix,
+        y_train::AbstractVector,
+        device::Type{<:Device}=CPU;
+        fnames=nothing,
+        w_train=nothing,
+        offset_train=nothing
+    )
 
 Initialise EvoTree
 """

diff --git a/src/structs.jl b/src/structs.jl
@@ -3,7 +3,9 @@ abstract type CPU <: Device end
 abstract type GPU <: Device end
 
 """
-    Carries training information for a given tree node
+    TrainNode{S,V,M}
+    
+Carries training information for a given tree node
 """
 mutable struct TrainNode{S,V,M}
     gain::Float64