From cfd87b59cbeef61deb3bbbe8958b7ddb13ae02a8 Mon Sep 17 00:00:00 2001 From: "jeremie.desgagne.bouchard" Date: Wed, 4 Oct 2023 23:48:54 -0400 Subject: [PATCH 1/3] fix docs --- docs/src/assets/style.css | 4 ++-- docs/src/internals.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 docs/src/internals.md diff --git a/docs/src/assets/style.css b/docs/src/assets/style.css index a7ae282..dd4615a 100644 --- a/docs/src/assets/style.css +++ b/docs/src/assets/style.css @@ -1,7 +1,7 @@ #documenter .docs-sidebar{ /* background-color: #023572 */ - background-color: white; - border-right: 2px solid darkgray; + /* background-color: white; */ + /* border-right: 2px solid darkgray; */ } /* #documenter .docs-sidebar .docs-logo > img { diff --git a/docs/src/internals.md b/docs/src/internals.md new file mode 100644 index 0000000..cf6649a --- /dev/null +++ b/docs/src/internals.md @@ -0,0 +1,21 @@ +# Internals + +## Metrics + +```@docs +EvoLinear.Metrics.tweedie_deviance +EvoLinear.Metrics.logloss +EvoLinear.Metrics.gamma_deviance +EvoLinear.Metrics.poisson_deviance +EvoLinear.Metrics.mae +EvoLinear.Metrics.mse +``` + +## Others + +```@docs +EvoLinear.Linear.update_∇! +EvoLinear.Splines.EvoSplineRegressor +EvoLinear.Linear.predict_linear +EvoLinear.Linear.predict_proj +``` From 9148e22f3a7a6a77bab0a1fe77ee6651e54712fa Mon Sep 17 00:00:00 2001 From: "jeremie.desgagne.bouchard" Date: Thu, 5 Oct 2023 00:20:52 -0400 Subject: [PATCH 2/3] fix docs --- docs/make.jl | 1 + docs/src/api.md | 18 +++++++----------- docs/src/internals.md | 12 ------------ 3 files changed, 8 insertions(+), 23 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 804d5ad..604d603 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,6 +8,7 @@ makedocs( pages=[ "Home" => "index.md", "API" => "api.md", + "Internals" => "internals.md", ], format=Documenter.HTML( sidebar_sitename=true, diff --git a/docs/src/api.md b/docs/src/api.md index 17c2919..67c9536 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -4,23 +4,19 @@ ```@docs EvoLinearRegressor +EvoSplineRegressor ``` ## Training & Inference ```@docs EvoLinear.fit -EvoLinear.predict_linear -EvoLinear.predict_proj +EvoLinear.predict ``` -## Evaluation metrics +## Metrics -```@docs -EvoLinear.mse -EvoLinear.mae -EvoLinear.logloss -EvoLinear.poisson_deviance -EvoLinear.gamma_deviance -EvoLinear.tweedie_deviance -``` \ No newline at end of file +```@autodocs +Modules = [EvoLinear.Metrics] +Order = [:type, :function, :constant] +``` diff --git a/docs/src/internals.md b/docs/src/internals.md index cf6649a..1636112 100644 --- a/docs/src/internals.md +++ b/docs/src/internals.md @@ -1,21 +1,9 @@ # Internals -## Metrics - -```@docs -EvoLinear.Metrics.tweedie_deviance -EvoLinear.Metrics.logloss -EvoLinear.Metrics.gamma_deviance -EvoLinear.Metrics.poisson_deviance -EvoLinear.Metrics.mae -EvoLinear.Metrics.mse -``` - ## Others ```@docs EvoLinear.Linear.update_∇! -EvoLinear.Splines.EvoSplineRegressor EvoLinear.Linear.predict_linear EvoLinear.Linear.predict_proj ``` From f910651d9aa0dae2749db19b8ccbfbed4bc0061b Mon Sep 17 00:00:00 2001 From: "jeremie.desgagne.bouchard" Date: Thu, 5 Oct 2023 00:58:04 -0400 Subject: [PATCH 3/3] doc fixes --- docs/src/api.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/src/api.md b/docs/src/api.md index 67c9536..2ca13c1 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -7,11 +7,10 @@ EvoLinearRegressor EvoSplineRegressor ``` -## Training & Inference +## Training ```@docs EvoLinear.fit -EvoLinear.predict ``` ## Metrics