rf-detr/mkdocs.yaml at develop · VIAME/rf-detr · 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
site_name: RF-DETR
site_url: https://roboflow.github.io/rf-detr/
site_author: Roboflow
site_description: 'SOTA Real-Time Object Detection Model'
repo_name: roboflow/rf-detr
repo_url: https://github.com/roboflow/rf-detr
edit_uri: https://github.com/roboflow/rf-detr/tree/main/docs
copyright: Roboflow 2025. All rights reserved.

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/roboflow
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/roboflow
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/roboflow-ai/mycompany/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/roboflow
  version:
    provider: mike

nav:
  - Home: index.md
  - How to:
    - Install: learn/install.md
    - Run Model:
      - Detection: learn/run/detection.md
      - Segmentation: learn/run/segmentation.md
    - Train Model:
      - Overview: learn/train/index.md
      - Dataset Formats: learn/train/dataset-formats.md
      - Training Parameters: learn/train/training-parameters.md
      - Advanced Training: learn/train/advanced.md
    - Export Model: learn/export.md
    - Deploy Model: learn/deploy.md
    - Benchmarks: learn/benchmarks.md
  - API Reference:
      - RF-DETR: reference/rfdetr.md
      - Detection Models:
        - RF-DETR Nano: reference/nano.md
        - RF-DETR Small: reference/small.md
        - RF-DETR Base (Deprecated): reference/base.md
        - RF-DETR Medium: reference/medium.md
        - RF-DETR Large: reference/large.md
        - RF-DETR XLarge: reference/xlarge.md
        - RF-DETR 2XLarge: reference/2xlarge.md
        - RF-DETR Large (Deprecated): reference/large_deprecated.md
      - Segmentation Models:
        - RF-DETR Seg Nano: reference/seg_nano.md
        - RF-DETR Seg Small: reference/seg_small.md
        - RF-DETR Seg Medium: reference/seg_medium.md
        - RF-DETR Seg Large: reference/seg_large.md
        - RF-DETR Seg XLarge: reference/seg_xlarge.md
        - RF-DETR Seg 2XLarge: reference/seg_2xlarge.md
        - RF-DETR Seg Preview (Deprecated): reference/seg_preview.md
      - Training Configs:
        - Train Config: reference/train_config.md
        - Segmentation Train Config: reference/segmentation_train_config.md
  - Changelog: https://github.com/roboflow/rf-detr/releases


theme:
  name: 'material'
  icon:
    edit: material/pencil
  logo: assets/roboflow-logo.svg
  favicon: assets/roboflow-logo.svg
  custom_dir: docs/theme

#  palette:
#    # Palette for light mode
#    - scheme: default
#      primary: "custom"
#      toggle:
#        icon: material/brightness-7
#        name: Switch to dark mode
#
#    # Palette toggle for dark mode
#    - scheme: slate
#      primary: "custom"
#      toggle:
#        icon: material/brightness-4
#        name: Switch to light mode

  font:
    text: Inter
    code: IBM Plex Mono

  features:
    - content.tabs.link
    - content.code.copy
    - navigation.expand
    - navigation.tabs
    - content.code.annotate
    - navigation.tracking
    - content.tooltips
    - navigation.tabs.sticky

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [rf-detr]
          load_external_modules: true
          options:
            parameter_headings: true
            allow_inspection: true
            show_bases: true
            group_by_category: true
            docstring_style: google
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_category_heading: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - 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

extra_css:
  - stylesheets/rf.css