EEG_DL_Classification/mkdocs.yml at main · mhmdaskari/EEG_DL_Classification · 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
site_name: EEGClassify
site_description: Reproducible EEG classification across TensorFlow, PyTorch, and JAX.
site_url: https://mhmdaskari.github.io/EEG_DL_Classification/
repo_url: https://github.com/mhmdaskari/EEG_DL_Classification
repo_name: mhmdaskari/EEG_DL_Classification

theme:
  name: material
  features:
    - toc.follow
    - navigation.top
    - navigation.footer
    - navigation.sections
    - navigation.indexes
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: teal
      accent: deep orange
      toggle:
        icon: material/lightbulb-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: deep orange
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: deep orange
      toggle:
        icon: material/lightbulb-outline
        name: Switch to system preference

nav:
  - Home: index.md
  - Installation: installation.md
  - Data: data.md
  - Notebook Examples:
      - Overview: examples/index.md
      - Data Postprocessing: examples/00_data_postprocessing.ipynb
      - TensorFlow: examples/01_tensorflow_reproduction.ipynb
      - PyTorch: examples/02_pytorch_reproduction.ipynb
      - JAX/Flax: examples/03_jax_reproduction.ipynb
  - Reproduce Results: reproduce.md
  - Results: results.md
  - API Reference:
      - Overview: api/index.md
      - Configuration: api/config.md
      - Data:
          - Loading And Comparison: api/data.md
          - Preprocessing: api/preprocessing.md
          - BCI IV-2a Conversion: api/bci2a.md
          - GAN Augmentation: api/augmentation.md
      - Models:
          - Overview: api/models/index.md
          - TensorFlow: api/models/tensorflow.md
          - PyTorch: api/models/pytorch.md
          - JAX: api/models/jax.md
      - Plotting: api/plotting.md
      - Command Line Interface: api/cli.md
      - Constants: api/constants.md

watch:
  - src
  - docs

plugins:
  - search
  - autorefs
  - offline
  - mkdocs-jupyter:
      execute: false
  - git-revision-date-localized:
      enable_creation_date: true
      strict: false
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
          paths:
            - src
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: table
            filters:
              - "!^_"
            inherited_members: false
            merge_init_into_class: true
            members_order: source
            separate_signature: true
            unwrap_annotated: true
            show_root_heading: true
            show_root_full_path: false
            show_root_toc_entry: true
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true

markdown_extensions:
  - admonition
  - toc:
      permalink: "#"
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

edit_uri: edit/main/docs/