visdet/mkdocs.yml at main · VisiaAI/visdet · 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
site_name: visdet Documentation
site_description: Object detection toolkit based on MMDetection
site_author: visdet Contributors
site_url: https://binitai.github.io/visdet/

repo_name: BinItAI/visdet
repo_url: https://github.com/BinItAI/visdet
edit_uri: edit/master/docs/

docs_dir: docs
site_dir: site

theme:
  name: material
  logo: assets/visia-logo-white.svg
  favicon: https://www.visia.ai/favicon.ico
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            heading_level: 2
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

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

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
  - Model Zoo:
      - Overview: model-zoo.md
      - MMDetection Support: mmdetection_model_support.md
  - User Guide:
      - Training: user-guide/training.md
      - Optimizers: user-guide/optimizers.md
      - Losses: user-guide/losses.md
      - Inference: user-guide/inference.md
      - Configuration: user-guide/configuration.md
      - YAML Config System: yaml_config_system.md
      - Assigners: user-guide/assigners.md
  - Tutorials:
      - Configuration: tutorials/config.md
      - Data Pipeline: tutorials/data_pipeline.md
      - Datasets: tutorials/customize_dataset.md
      - Models: tutorials/customize_models.md
      - Losses: tutorials/customize_losses.md
      - Runtime: tutorials/customize_runtime.md
      - Training: tutorials/training.md
      - Finetune: tutorials/finetune.md
      - Useful Hooks: tutorials/useful_hooks.md
      - How To: tutorials/how_to.md
      - Init Cfg: tutorials/init_cfg.md
      - Threshold Optimization: tutorials/threshold_optimization.md
      - PyTorch to ONNX: tutorials/pytorch2onnx.md
      - ONNX to TensorRT: tutorials/onnx2tensorrt.md
      - Test Results Submission: tutorials/test_results_submission.md
  - API Reference:
      - Overview: api-reference/index.md
      - Core: api/core.md
      - Models: api/models.md
      - Datasets: api/datasets.md
  - Development:
      - Contributing: development/contributing.md
      - Architecture: development/architecture.md
      - Model Coverage: development/model-coverage.md
  - About:
      - Roadmap: roadmap.md
      - Contributing (Legacy): about/contributing.md
      - Changelog: about/changelog.md
      - License: about/license.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/BinItAI/visdet
  version:
    provider: mike