Energizados/mkdocs.yml at master · EL-BID/Energizados · 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
site_name: Energizados
site_description: Machine learning framework for detecting non-technical losses in energy distribution
repo_url: https://github.com/EL-BID/Energizados
repo_name: EL-BID/Energizados
edit_uri: edit/master/docs/

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  # i18n: Uncomment and install mkdocs-material-extensions when adding Spanish/Portuguese
  # - i18n:
  #     docs_structure: folder
  #     languages:
  #       - locale: en
  #         default: true
  #         name: English
  #         build: true
  #       - locale: es
  #         name: Español
  #         build: true
  #       - locale: pt
  #         name: Português
  #         build: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  version:
    provider: mike
  # alternate: Uncomment when i18n plugin is enabled
  # alternate:
  #   - name: English
  #     link: /en/
  #     lang: en
  #   - name: Español
  #     link: /es/
  #     lang: es
  #   - name: Português
  #     link: /pt/
  #     lang: pt

nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/overview.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Your First Project: getting-started/first-project.md
  - User Guide:
      - Project Structure: user-guide/project-structure.md
      - CLI Reference: user-guide/cli-reference.md
      - Configuration:
          - ETLs: user-guide/configuration/etl.md
          - Training: user-guide/configuration/train.md
          - Evaluation: user-guide/configuration/evaluation.md
          - Inference: user-guide/configuration/infer.md
      - EDA Module: user-guide/eda.md
      - Understanding Results: user-guide/understanding-results.md
      - Offline & Proxied Environments: user-guide/offline-and-proxy.md
      - Troubleshooting: user-guide/troubleshooting.md
  - Tutorials:
      - Guía paso a paso (ES): tutorials/step-by-step_es.md
      - End-to-End Example: tutorials/end-to-end-example.md
      - Model Selection Guide: tutorials/model-selection-guide.md
      - Ensemble Models: tutorials/ensemble-models.md
  - Advanced:
      - Architecture: advanced/architecture.md
      - Development Setup: advanced/development-setup.md
      - Extending the Framework:
          - Custom ETL: advanced/extending/custom-etl.md
          - Custom Model: advanced/extending/custom-model.md
          - Custom Feature Engineering: advanced/extending/custom-feature-engineering.md
          - Custom Preprocessing: advanced/extending/custom-preprocessing.md
          - Custom Inference: advanced/extending/custom-inference.md
      - Contributing: advanced/contributing.md
      - PyPI Publishing: advanced/pypi-publishing.md