ml-essentials/mkdocs.yml at master · ccdsiub/ml-essentials · 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# Project information
site_name: Machine Learning Essentials
site_url: https://ccdsiub.github.io/ml-essentials/
site_author: Mir Sazzat Hossain, Rafat Hasan
site_description: >-
  This is course material for the Machine Learning Essentials course at the
  Center for Computational and Data Science, Independent University, Bangladesh.

# Repository
repo_name: ccdsiub/ml-essentials
repo_url: https://github.com/ccdsiub/ml-essentials

# Copyright
copyright: Copyright &copy;
  <a href="https://ccds.io">Center for Computational and Data Science</a>
  All rights reserved.

# Configuration
theme:
  name: material
  custom_dir: overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.png
  # logo: assets/images/logo.png


extra_css:
  - assets/stylesheets/extra.css

extra_javascript:
  - assets/javascripts/extra.js
  - assets/javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - mkdocs-jupyter:
      include: ["*.py", "*.ipynb"]
      ignore: []
      execute: false # execute the notebook cells when building
      allow_errors: false # fail the build upon error in a notebook cell
      include_source: true # download the source notebooks
  - git-revision-date-localized:
      enable_creation_date: true

# Customization
extra:
  generator: false
  social:
    - icon: fontawesome/solid/envelope
      link: mailto:ccds@iub.edu.bd
    - icon: fontawesome/brands/github
      link: https://github.com/ccdsiub/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ccds-iub/
    - icon: fontawesome/solid/link
      link: https://www.ccds.ai/

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Course Material:
    - Introduction: introduction.md
    - Supervised Learning:
      - supervised-learning/index.md
      - Tree-Based Algorithms:
        - supervised-learning/tree-based/index.md
        - Decision Trees: supervised-learning/tree-based/decision-tree.ipynb
      - Regression:
        - supervised-learning/regression/index.md
        - Simple Linear Regression: supervised-learning/regression/linear-regression.ipynb
      - Classification:
        - supervised-learning/classification/index.md
        - Naive Bayes classifiers: supervised-learning/classification/naive-bayes.ipynb
        - Logistic Regression: supervised-learning/classification/logistic-regression.ipynb
        - K-Nearest Neighbors: supervised-learning/classification/k-nearest-neighbors.ipynb