onlinecml/mkdocs.yml at master · athammad/onlinecml · 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
site_name: OnlineCML
site_description: Online Causal Machine Learning in Python
site_url: https://docs.onlinecml.org
repo_url: https://github.com/athammad/onlinecml
repo_name: athammad/onlinecml

theme:
  name: material
  logo: assets/logo_small.png
  favicon: assets/logo_small.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocs-jupyter:
      execute: false
      include_source: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            heading_level: 2

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting_started/installation.md
    - Quickstart: getting_started/quickstart.md
  - Theory:
    - Potential Outcomes: theory/potential_outcomes.md
    - Three Assumptions: theory/three_assumptions.md
    - Robinson Transformation: theory/robinson_transformation.md
    - Online Learning Basics: theory/online_learning_basics.md
  - API Reference:
    - Base: api_reference/base.md
    - Propensity: api_reference/propensity.md
    - Reweighting: api_reference/reweighting.md
    - Meta-Learners: api_reference/metalearners.md
    - Forests: api_reference/forests.md
    - Matching: api_reference/matching.md
    - Policy: api_reference/policy.md
    - Diagnostics: api_reference/diagnostics.md
    - Datasets: api_reference/datasets.md
    - Evaluation: api_reference/evaluation.md
  - Examples:
    - Quickstart: examples/01_quickstart.ipynb
    - IPW vs AIPW: examples/02_ipw_vs_aipw.ipynb
    - Meta-Learner Comparison: examples/03_metalearner_comparison.ipynb
    - Online Matching: examples/04_online_matching.ipynb
    - Policy Exploration: examples/05_policy_exploration.ipynb
    - Exploration Policies Deep Dive: examples/06_exploration_policies.ipynb
    - Diagnostics: examples/07_diagnostics.ipynb
    - Concept Drift: examples/08_concept_drift.ipynb
    - Marketing Case Study: examples/09_marketing_case_study.ipynb
    - Clinical Trial: examples/10_clinical_trial.ipynb
    - Online vs Batch: examples/11_vs_econml_batch.ipynb
    - Causal Trees & Forests: examples/12_causal_tree_forest.ipynb
  - Contributing:
    - How to Contribute: contributing/contributing.md
    - Adding an Estimator: contributing/adding_estimator.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js