diff --git a/docs/how-to-guides.md b/docs/how-to-guides.md index 766abbe3..fe82caaa 100644 --- a/docs/how-to-guides.md +++ b/docs/how-to-guides.md @@ -3,12 +3,7 @@ Here a some in-depth examples to help you with the package. In particular you will find notebooks to handle: **DATA** -- ChoiceDataset -- FeaturesStorage **MODELS** -- Custom modelling - important if you want to build your own model -- RUMnet **AUXILIARY TOOLS** -- Assortment optimization diff --git a/docs/notebooks/models/conditional_logit.md b/docs/notebooks/models/conditional_logit.md new file mode 100644 index 00000000..5ad9730a --- /dev/null +++ b/docs/notebooks/models/conditional_logit.md @@ -0,0 +1 @@ +The Conditional Logit model estimation with Choice-Learn is part of the introductive tutorial and is detailed [here](../introduction/3_model_clogit.ipynb). diff --git a/docs/notebooks/models/custom_modelling.md b/docs/notebooks/models/custom_modelling.md new file mode 100644 index 00000000..b7092efa --- /dev/null +++ b/docs/notebooks/models/custom_modelling.md @@ -0,0 +1 @@ +Custom modelling with Choice-Learn is part of the introductive tutorial and is detailed [here](../introduction/3_model_clogit.ipynb). diff --git a/mkdocs.yaml b/mkdocs.yaml index 8c9dd935..d723d800 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -56,22 +56,25 @@ nav: - HomePage: index.md - Tutorials: - Introduction: tutorials.md - - Introductive Example: notebooks/introductive_example.md + - Introductive Example: notebooks/introduction/1_introductive_example.md + - Intoduction to data handling: notebooks/introduction/2_data_handling.md + - Introduction to choice modelling with the Conditional Logit: notebooks/introduction/3_model_clogit.md + - Introduction to model customization: notebooks/introduction/4_model_customization.md - How-To Guides: - Introduction: how-to-guides.md - Data Handling: - - More in-depth introduction to data handling: notebooks/choice_learn_introduction_to_data.md - - Exhaustive example of ChoiceDataset creation: notebooks/dataset_creation.md - - Optimize RAM usage with Features Storage, in-depth examples: notebooks/features_byID_example.md + - More in-depth introduction to data handling: notebooks/data/choice_learn_introduction_to_data.md + - Exhaustive example of ChoiceDataset creation: notebooks/data/dataset_creation.md + - Optimize RAM usage with Features Storage, in-depth examples: notebooks/data/features_byID_example.md - Modelling: - - Introduction to Choice Models - the SimpleMNL: notebooks/simple_mnl_example.md - - Conditional Logit Usage: notebooks/choice_learn_introduction_clogit.md - - RUMnet model Usage: notebooks/rumnet_example.md - - Building a custom choice model and handling hyper-parameters: notebooks/paramters_and_model_customization.md - - Latent Class MNLs Usage: notebooks/latent_class_model.md - - A reproductive example, the logistic regression: notebooks/logistic_regression.md + - Introduction to Choice Models - the SimpleMNL: notebooks/models/simple_mnl_example.md + - Conditional Logit Usage: notebooks/models/choice_learn_introduction_clogit.md + - RUMnet model Usage: notebooks/models/rumnet_example.md + - Building a custom choice model and handling hyper-parameters: notebooks/models/paramters_and_model_customization.md + - Latent Class MNLs Usage: notebooks/models/latent_class_model.md + - A reproductive example, the logistic regression: notebooks/models/logistic_regression.md - Toolbox for choice modellers: - - Optimizing a product assortment: notebooks/assortment_example.md + - Optimizing a product assortment: notebooks/auxiliary_tools/assortment_example.md - References: - Data: - ChoiceDataset: references/data/references_choice_dataset.md @@ -87,8 +90,8 @@ nav: - SimpleMNL Model: references/models/references_simple_mnl.md - Conditional Logit: references/models/references_clogit.md - RUMnet: references/models/references_rumnet.md - - Latent Class BaseModel: reference/models/latent_class_base_model.md + - Latent Class BaseModel: reference/models/references_latent_class_base_model.md - Latent Class MNL: references/models/references_latent_class_mnl.md - - Toolbox: - - Assortment Optimizer: references/toolbox/references_assortment_optimizer.md + - Toolbox: + - Assortment Optimizer: references/toolbox/references_assortment_optimizer.md - explanations.md diff --git a/notebooks/models/custom_modelling.md b/notebooks/models/custom_modelling.md new file mode 100644 index 00000000..b7092efa --- /dev/null +++ b/notebooks/models/custom_modelling.md @@ -0,0 +1 @@ +Custom modelling with Choice-Learn is part of the introductive tutorial and is detailed [here](../introduction/3_model_clogit.ipynb).