choice-learn/mkdocs.yaml at main · artefactory/choice-learn · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: Choice-Learn
theme:
  name: "material"
  custom_dir: docs/.overrides
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/moon-waning-crescent
        name: Switch to dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: slate
      primary: teal
      accent: amber
      toggle:
        icon: material/white-balance-sunny
        name: Switch to light mode
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  logo: logo_choice_learn.png
  favicon: logo_choice_learn.png

markdown_extensions:
  - tables
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - mdx_math
  - md_in_html

extra_css:
  - docs/.overrides/assets/stylesheets/extra.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: numpy
          show_source: true
- search
- nbconvert:
      input_dir: notebooks
      output_dir: notebooks

nav:
  - HomePage: index.md
  - Tutorials:
    - Introduction: tutorials.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:
      - Intoduction to data handling: notebooks/introduction/2_data_handling.md
      - Exhaustive example of ChoiceDataset creation: notebooks/data/dataset_creation.md
      - Optimize RAM usage with Features Storage, in-depth examples: notebooks/data/features_byID_examples.md
      - Basket Data Handling: notebooks/basket_models/basket_data.md
    - Modeling Single Choices:
      - Introduction to Choice Models - the SimpleMNL: notebooks/models/simple_mnl.md
      - Conditional Logit Usage: notebooks/introduction/3_model_clogit.md
      - Nested Logit Usage: notebooks/models/nested_logit.md
      - Building a custom choice model and handling hyper-parameters: notebooks/introduction/4_model_customization.md
      - RUMnet model Usage: notebooks/models/rumnet.md
      - Latent Class MNLs Usage: notebooks/models/latent_class_model.md
      - A reproductive example, the logistic regression: notebooks/models/logistic_regression.md
      - Model Finetuning and general hyperparamters: notebooks/models/models_finetuning.md
      - SHOPPER model Usage: notebooks/basket_models/shopper.md
      - TasteNet model Usage: notebooks/models/tastenet.md
      - HaloMNL model Usage: notebooks/models/halo_mnl.md
      - Learning MNL model Usage: notebooks/models/learning_mnl.md
      - ResLogit model Usage: notebooks/models/reslogit.md
    - Modeling Basket of purchases:
      - Introduction data handling, the TripDataset: notebooks/basket_models/basket_data.md
      - Shopper model Usage: notebooks/basket_models/shopper.md
      - AleaCarta model Usage: notebooks/basket_models/alea_carta.md
    - Toolbox for choice modellers:
      - Optimizing a product assortment: notebooks/auxiliary_tools/assortment_example.md
  - References:
    - Data:
      - ChoiceDataset: references/data/references_choice_dataset.md
      - ChoiceDataset Indexer: references/data/references_indexer.md
      - Features Storage: references/data/references_storage.md
    - Available Open-Source Datasets:
      - Base Datasets: references/datasets/references_base.md
      - TaFeng Dataset: references/datasets/references_tafeng.md
      - ICDM Expedia Dataset: references/datasets/references_expedia.md
      - Bakery Dataset: references/basket_models/datasets/references_bakery.md
      - Badminton Dataset: references/basket_models/datasets/badminton_dataset.md
    - Choice Models:
      - Base Model: references/models/references_base_model.md
      - Baseline Models: references/models/references_baseline_models.md
      - SimpleMNL Model: references/models/references_simple_mnl.md
      - Conditional Logit: references/models/references_clogit.md
      - Nested Logit: references/models/references_nested_logit.md
      - Latent Class BaseModel: references/models/references_latent_class_base_model.md
      - Latent Class MNL: references/models/references_latent_class_mnl.md
      - RUMnet: references/models/references_rumnet.md
      - TasteNet: references/models/references_tastenet.md
      - Learning MNL: references/models/references_learning_mnl.md
      - ResLogit: references/models/references_reslogit.md
      - HaloMNL: references/models/references_halo_mnl.md
    - Basket Models:
      - Shopper: references/basket_models/references_shopper.md
      - The AleaCarta model: references/basket_models/references_alea_carta.md
      - Basic Attention model: references/basket_models/references_basic_attention_model.md
      - Self Attention model: references/basket_models/references_self_attention_model.md
      - Trip and TripDataset: references/basket_models/data/references_dataset.md
      - Basket preprocessing: references/basket_models/data/references_preprocessing.md
      - Permutation: references/basket_models/utils/references_permutation.md
    - Toolbox:
        - Assortment Optimizer and Pricing: references/toolbox/references_assortment_optimizer.md
    - Utils:
        - Tensorflow Operations: references/tf_ops.md
        - Metrics: references/utils/metrics.md
  - explanations.md