sleap-nn/mkdocs.yml at bff2525df5a0847d65df068f5ac296e5bd88d753 · talmolab/sleap-nn · 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
site_name: sleap-nn documentation
site_url: https://nn.sleap.ai/
repo_url: https://github.com/talmolab/sleap-nn

theme:
  name: material
  logo: assets/sleap-logo.png
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github

  palette:
    - scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - toc.follow
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - content.code.select
    - content.footnote.tooltips

plugins:
  - search
  - mkdocs-jupyter
  - mike
  - autorefs
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
        - scripts/gen_changelog.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            summary: true
            show_root_heading: true
            docstring_options:
              returns_multiple_items: false
            docstring_section_style: table

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/talmolab
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/talmop

nav:
  - Overview: index.md
  - Installation: installation.md
  - Tutorials:
    - tutorials/index.md
    - Quick Start: getting-started/quickstart.md
    - Your First Model: getting-started/first-model.md
    - Example Notebooks: tutorials/notebooks.md
  - Guides:
    - guides/index.md
    - Training:
      - guides/training.md
      - Config Generator: guides/config-generator.md
      - Negative Frames: guides/negative-frames.md
      - Monitoring: guides/monitoring.md
      - Multi-GPU: guides/multi-gpu.md
    - Inference:
      - guides/inference.md
      - Performance: guides/inference-performance.md
    - Evaluation: guides/evaluation.md
    - Tracking: guides/tracking.md
    - Export: guides/export.md
  - Reference:
    - reference/index.md
    - Configuration:
      - configuration/index.md
      - Config Picker: configuration/config-picker/index.md
      - Data Config: configuration/data.md
      - Model Config: configuration/model.md
      - Trainer Config: configuration/trainer.md
      - Sample Configs: configuration/samples.md
    - CLI: reference/cli.md
    - Model Types: reference/models.md
    - Evaluation Metrics: reference/evaluation_metrics.md
    - FAQ: help/faq.md
  - API Reference: api/
  - Changelog: changelog.md
  - Releases: https://github.com/talmolab/sleap-nn/releases