Skip to content

Commit f7289f2

Browse files
committed
restructure the side nav bar in docs
1 parent aa7f923 commit f7289f2

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

docs/make.jl

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,30 @@ makedocs(;
1010
"Quick-start guide" => "quick_start_guide.md",
1111
"The model type hierarchy" => "the_model_type_hierarchy.md",
1212
"New model type declarations" => "type_declarations.md",
13-
"Supervised models" => "supervised_models.md",
14-
"Summary of methods" => "summary_of_methods.md",
15-
"The form of data for fitting and predicting" => "form_of_data.md",
16-
"The fit method" => "the_fit_method.md",
17-
"The fitted_params method" => "the_fitted_params_method.md",
18-
"The predict method" => "the_predict_method.md",
19-
"The predict_joint method" => "the_predict_joint_method.md",
20-
"Training losses" => "training_losses.md",
21-
"Feature importances" => "feature_importances.md",
22-
"Trait declarations" => "trait_declarations.md",
23-
"Iterative models and the update! method" => "iterative_models.md",
24-
"Implementing a data front end" => "implementing_a_data_front_end.md",
25-
"Supervised models with a transform method" =>
26-
"supervised_models_with_transform.md",
27-
"Models that learn a probability distribution" => "fitting_distributions.md",
28-
"Serialization" => "serialization.md",
29-
"Document strings" => "document_strings.md",
13+
"Supervised models" => [
14+
"Introduction" => "supervised_models.md",
15+
"Summary of methods" => "summary_of_methods.md",
16+
"The form of data for fitting and predicting" => "form_of_data.md",
17+
"The fit method" => "the_fit_method.md",
18+
"The fitted_params method" => "the_fitted_params_method.md",
19+
"The predict method" => "the_predict_method.md",
20+
"The predict_joint method" => "the_predict_joint_method.md",
21+
"Training losses" => "training_losses.md",
22+
"Feature importances" => "feature_importances.md",
23+
"Trait declarations" => "trait_declarations.md",
24+
"Iterative models and the update! method" => "iterative_models.md",
25+
"Implementing a data front end" => "implementing_a_data_front_end.md",
26+
"Supervised models with a transform method" =>
27+
"supervised_models_with_transform.md",
28+
"Models that learn a probability distribution" =>
29+
"fitting_distributions.md",
30+
],
3031
"Unsupervised models" => "unsupervised_models.md",
3132
"Static models" => "static_models.md",
3233
"Outlier detection models" => "outlier_detection_models.md",
34+
"Model wrappers" => "model_wrappers.md",
35+
"Serialization" => "serialization.md",
36+
"Document strings" => "document_strings.md",
3337
"Convenience methods" => "convenience_methods.md",
3438
"Where to place code implementing new models" => "where_to_put_code.md",
3539
"How to add models to the MLJ Model Registry" => "how_to_register.md",

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ API defined there, as outlined in this document.
88

99
!!! tip
1010

11-
This is a reference document, which has become rather sprawling over the evolution of the MLJ project. We recommend starting with [Quick start guide](@ref), which covers the main points relevant to most new model implementations.
11+
This is a reference document, which has become rather sprawling over the evolution of the MLJ project. We recommend starting with [Quick start guide](@ref), which covers the main points relevant to most new model implementations. Most topics are only detailed for `Supervised` models, so if you are implementing another kind of model, you may still need to refer to the [Supervised models](@ref) section.
1212

1313
Interface code can be hosted by the package providing the core machine learning algorithm,
1414
or by a stand-alone "interface-only" package, using the template

0 commit comments

Comments
 (0)