focoos/mkdocs.yaml at main · FocoosAI/focoos · 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
site_name: Focoos AI SDK

site_url: https://focoosai.github.io/focoos/
repo_url: https://github.com/FocoosAI/focoos
edit_uri: edit/main/docs

theme:
  name: material
  palette:
    - scheme: slate
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky

extra_css:
  - assets/stylesheets/custom.css
  - https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500&family=DM+Mono&display=swap # Load Google Fonts (DM Sans Regular, Medium, and DM Mono)

plugins:
  - search
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_style: google
  - include-markdown

nav:
  - Focoos AI:
      - Welcome: index.md
      - Setup: setup.md
      - Concepts: concepts.md
      - Inference: inference.md
      - Training: training.md
      - Quantization (beta): quantization.md
      - CLI: cli.md
  - HUB:
      - Overview: hub/index.md
      - HUB: hub/hub.md
      - Remote Inference: hub/remote_inference.md
  - Models:
      - Overview: models/index.md
      - fai-detr: models/fai_detr.md
      - fai-mf: models/fai_mf.md
      - bisenetformer: models/bisenetformer.md
      - rtmo: models/rtmo.md
      - fai-cls: models/fai_cls.md

  - API Reference:
      - ModelManager: api/model_manager.md
      - FocoosModel:
        - FocoosModel: api/focoos_model.md
        - BaseModelNN: api/base_model.md

      - ModelRegistry: api/model_registry.md
      - InferModel:
        - InferModel: api/infer_model.md
        - runtimes: api/runtimes.md
      - Processor: api/processor.md
      - FocoosHUB: api/hub.md
      - Trainer:
        - evaluation: api/trainer_evaluation.md
        - hooks: api/trainer_hooks.md
      - AutoDataset: api/auto_dataset.md
      - ports: api/ports.md
      - config: api/config.md
      - cli: api/cli.md

markdown_extensions:
  - pymdownx.highlight:
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.snippets:
      restrict_base_path: false
  - admonition
  - tables
  - toc:
      permalink: "#"
  - attr_list
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-RP4PM5PGLN
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/FocoosAI/focoos
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/focoosai

copyright: Copyright &copy; 2024 FocoosAI

watch:
  - focoos