cluster-experiments/mkdocs.yml at main · david26694/cluster-experiments · 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
site_name: Cluster Experiments Docs
repo_url: https://github.com/david26694/cluster-experiments
site_url: https://david26694.github.io/cluster-experiments/
site_description: Functions to design and run clustered experiments
site_author: David Masip
use_directory_urls: false
edit_uri: blob/main/docs/
docs_dir: docs
site_dir: site

nav:
  - Home: index.md
  - Quickstart:
      - Quickstart: quickstart.md
      - Power Analysis Guide: normal_power_lines.ipynb

  - Examples:
      - Basic Usage:
          - Simple A/B Test: examples/simple_ab_test.ipynb
          - Experiment Analysis Workflow: experiment_analysis.ipynb
          - AA Test (Clustered): aa_test.ipynb
          - Relative Lift Analysis: relative.ipynb
      - End-to-End Examples:
          - Power Analysis: e2e_mde.ipynb
          - Switchback Design: e2e_mde_switchback.ipynb
          - Delta Method: e2e_mde_delta.ipynb
      - Analysis Methods:
          - Different Hypothesis Tests: analysis_with_different_hypotheses.ipynb
          - Paired T-Test: paired_ttest.ipynb
          - Delta Method Analysis: delta_method.ipynb
      - Variance Reduction:
          - CUPAC Example: cupac_example.ipynb
      - Cluster Experiments:
          - Cluster Randomization: examples/cluster_randomization.ipynb
      - Switchback Experiments:
          - Stratified Switchback: switchback.ipynb
          - Calendar Visualization: plot_calendars.ipynb
          - 4-Hour Switches: plot_calendars_hours.ipynb
          - Washover Example: washover_example.ipynb
      - Power Analysis:
          - Normal Power Comparison: normal_power.ipynb
          - Power Time-Lines: normal_power_lines.ipynb
      - Advanced Topics:
          - Multiple Treatments: multivariate.ipynb
          - Synthetic Control: synthetic_control.ipynb
          - Custom Classes: create_custom_classes.ipynb

  - API Reference:
      - Experiment Analysis:
          - Analysis Plan: api/analysis_plan.md
          - Analysis Results: api/analysis_results.md
          - Experiment Analysis Methods: api/experiment_analysis.md
          - Hypothesis Test: api/hypothesis_test.md
      - Metrics & Variants:
          - Metric: api/metric.md
          - Variant: api/variant.md
          - Dimension: api/dimension.md
      - Power Analysis:
          - Power Analysis: api/power_analysis.md
          - Power Config: api/power_config.md
      - Randomization:
          - Splitters: api/random_splitter.md
      - Variance Reduction:
          - CUPAC Model: api/cupac_model.md
      - Switchback:
          - Washover: api/washover.md
      - Perturbators: api/perturbator.md

  - Contributing: CONTRIBUTING.md
  - License: license.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/david26694/cluster-experiments

plugins:
  - mkdocstrings:
      watch:
        - cluster_experiments
  - mkdocs-jupyter
  - search

extra_css:
  - stylesheets/overrides.css
  - stylesheets/style.css

copyright: Copyright &copy; 2022 Maintained by David Masip.

theme:
  name: material
  font:
    text: Ubuntu
    code: Ubuntu Mono
  features:
    - content.tabs
    - content.code.annotate
    - content.code.copy
    - navigation.instant
    - navigation.tracking
    - navigation.top
  palette:
    primary: indigo
    accent: blue

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.snippets
  - pymdownx.highlight:
      use_pygments: true
  - md_in_html

  - toc:
      permalink: true