openml-pytorch/mkdocs.yml at main · openml/openml-pytorch · 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
site_name: OpenML PyTorch Extension
theme:
  name: material
  features:
    - content.code.copy
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: indigo
      accent: indigo
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - admonition
  - codehilite
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      linenums: true
  - pymdownx.inlinehilite
  - toc:
      permalink: true
plugins:
  - search
  - mkdocs-jupyter
  - awesome-pages
  # - mknotebooks:
      # execute: false
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [openml_pytorch]
          load_external_modules: true
          options:
            docstring_section_style: table
            show_docstring_functions: true
nav:
  - Home: "index.md"
  - API Reference:
    - "Callbacks": "API reference/Callbacks.md"
    - "Custom Datasets": "API reference/Custom Datasets.md"
    - "Metrics": "API reference/Metrics.md"
    - "OpenML Connection": "API reference/OpenML Connection.md"
    - "Trainer": "API reference/Trainer.md"
  - Examples:
    - Beginner:
      - "Create Dataset and Task": "Examples/Create Dataset and Task.ipynb"
      - "Image Classification Task": "Examples/Image Classification Task.ipynb"
      - "Pretrained Transformer Image Classification Task": "Examples/Pretrained Transformer Image Classification Task.ipynb"
      - "Sequential Classification Task": "Examples/Sequential Classification Task.ipynb"
      - "Tabular Classification": "Examples/Tabular Classification.ipynb"
    - Advanced:
      - "Choose a Custom Optimizer": "Examples/Choose a Custom Optimizer.ipynb"
  - "Other Integrations": "Integrations of OpenML in PyTorch.md"
  - "Limitations of the API":  "Limitations of the API.md"
  - "Philosophy behind the API Design": "Philosophy behind the API Design.md"