Biodiversity/mkdocs.yml at main · microsoft/Biodiversity · 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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
site_name: Microsoft Biodiversity
site_url: https://microsoft.github.io/Biodiversity/
site_description: "Microsoft AI for Good Lab Biodiversity hub: open-source conservation AI for wildlife monitoring. Home of MegaDetector, PyTorch-Wildlife, SPARROW, and MegaDetector-Acoustic."
docs_dir: docs
site_dir: site
repo_url: https://github.com/microsoft/Biodiversity
repo_name: microsoft/Biodiversity
copyright: Copyright (c) 2023 Microsoft Corporation

theme:
  name: material
  custom_dir: overrides
  favicon: assets/cat.png
  logo: assets/cat.png
  icon:
    menu: material/menu
    alternate: material/translate
    search: material/magnify
    share: material/share-variant
    close: material/close
    top: material/arrow-up
    edit: material/pencil
    view: material/eye
    repo: fontawesome/brands/git-alt
    admonition:
      note: material/note
      abstract: material/lightbulb
      info: material/information
      tip: material/lightbulb-on
      success: material/check-circle
      question: material/help-circle
      warning: material/alert
      failure: material/alert-circle
      danger: material/alert-octagon
      bug: material/bug
      example: material/format-list-bulleted
      quote: material/format-quote-open
    tag:
      default: material/tag
      info: material/information
      warning: material/alert
      danger: material/alert-octagon
    previous: material/arrow-left
    next: material/arrow-right
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: deep orange
      toggle:
        icon: material/paw-off
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: deep orange
      toggle:
        icon: material/paw
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - toc.follow
    # - toc.integrate
    - navigation.top
    - search.suggest
    - search.share
    - navigation.footer

nav:
  - PyTorch-Wildlife:
    - Overview: index.md
    - Core Features: core_features.md
    - MegaDetector: megadetector.md
    - MegaDetector-Acoustic: bioacoustics.md
    - Installation: installation.md
    - Tags: tags.md
    - Existing Collaborators: collaborators.md
    - Contributors: contributors.md
    - Cite Us: cite.md
  - What's New?:
    - Latest Release: releases/release_notes.md
    - Past Releases: releases/past_releases.md
    - PW-Engine Preview: pw_engine_overview.md
  - Model Zoo:
    - MegaDetector: model_zoo/megadetector.md
    - Other Detectors: model_zoo/other_detectors.md
    - Classifiers: model_zoo/classifiers.md
    - Bioacoustics: model_zoo/bioacoustics.md
  - Demo and UI:
    - Demo Data: demo_and_ui/demo_data.md
    - Notebook: demo_and_ui/notebook.md
    - Gradio App: demo_and_ui/gradio.md
    - AddaxAI (formerly known as EcoAssist): demo_and_ui/ecoassist.md
    - TimeLapse: demo_and_ui/timelapse.md
    - BoquilaHUB: demo_and_ui/boquilahub.md
  - Contribute:
    - Contribute Guidelines: contribute.md
    - License: license.md
    - Developer Guide: build_mkdocs.md
  - Reference - Code API:
      - Base Module:
        - Overview: base/overview.md
        - Data:
          - Datasets: base/data/datasets.md
          - Transforms: base/data/transforms.md
        - Models:
          - Classification:
              - Base Classifier:
                  - base/models/classification/base_classifier.md
              - ResNet Base:
                  - base/models/classification/resnet_base/base_classifier.md
                  - base/models/classification/resnet_base/amazon.md
                  - base/models/classification/resnet_base/custom_weights.md
                  - base/models/classification/resnet_base/opossum.md
                  - base/models/classification/resnet_base/serengeti.md
              - TIMM Base:
                  - base/models/classification/timm_base/base_classifier.md
                  - base/models/classification/timm_base/DFNE.md
                  - base/models/classification/timm_base/Deepfaune.md
          - Detection:
              - Base Detector:
                  - base/models/detection/base_detector.md
              - HerdNet:
                  - base/models/detection/herdnet.md
                  - base/models/detection/herdnet/dla.md
                  - base/models/detection/herdnet/model.md
                  - Animaloc:
                      - Data:
                          - base/models/detection/herdnet/animaloc/data/patches.md
                          - base/models/detection/herdnet/animaloc/data/types.md
                      - Eval:
                          - base/models/detection/herdnet/animaloc/eval/lmds.md
                          - base/models/detection/herdnet/animaloc/eval/stitchers.md
              - Ultralytics Based:
                  - base/models/detection/ultralytics_based/Deepfaune.md
                  - MegaDetector v5:
                      - base/models/detection/ultralytics_based/megadetectorv5.md
                  - MegaDetector v6:
                      - base/models/detection/ultralytics_based/megadetectorv6.md
                      - base/models/detection/ultralytics_based/megadetectorv6_distributed.md
                  - YOLOv5 Base:
                      - base/models/detection/ultralytics_based/yolov5_base.md
                  - YOLOv8 Base:
                      - base/models/detection/ultralytics_based/yolov8_base.md
                  - YOLOv8 Distributed:
                      - base/models/detection/ultralytics_based/yolov8_distributed.md
        - Utils:
            - base/utils/misc.md
            - base/utils/post_process.md

      - Model Fine-tuning:
        - Overview: fine_tuning_modules/overview.md
        - Classification Fine-tuning:
            - Overview: fine_tuning_modules/classification/overview.md
        - Detection Fine-tuning:
            - Overview: fine_tuning_modules/detection/overview.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - md_in_html
  - attr_list
  - sane_lists
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true


plugins:
  - callouts
  - search
  - meta
  - tags
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
      fallback_to_build_date: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google