deepfense-framework/mkdocs.yml at master · Yaselley/deepfense-framework · 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
site_name: DeepFense
site_description: A modular framework for deepfake audio detection.
site_author: DeepFense Team
site_url: https://deepfense.github.io/

repo_url: https://github.com/Yaselley/deepfense-framework
repo_name: deepfense-framework

theme:
  name: readthedocs
  logo: logo/logo.png
  favicon: logo/logo.png
  highlightjs: true
  hljs_languages:
    - yaml
    - python
    - bash

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search

nav:
  - Home: index.md
  - Getting Started:
    - Installation: 01_installation.md
    - Quick Start: 02_quickstart.md
    - Full Tutorial: 03_full_tutorial.md
  - Reference:
    - Architecture: 04_architecture.md
    - Configuration: 05_configuration.md
    - Library Usage: 06_library_usage.md
    - HuggingFace Hub: 07_huggingface_hub.md
    - Pipeline Flow: pipeline_flow.md
    - Data Transforms: data_transforms.md
    - CLI: cli_reference.md
  - Components:
    - Frontends: components/frontends.md
    - Backends: components/backends.md
    - Losses: components/losses.md
    - Augmentations: components/augmentations.md
    - Optimizers & Schedulers: components/optimizers_schedulers.md
  - User Guides:
    - Extending DeepFense: user_guide/extending.md
    - Adding Frontends: user_guide/adding_frontends.md
    - Adding Backends: user_guide/adding_backends.md
    - Adding Losses: user_guide/adding_losses.md
    - Adding Datasets: user_guide/adding_datasets.md
    - Adding Augmentations: user_guide/adding_augmentations.md
    - Adding Optimizers: user_guide/adding_optimizers.md
    - Adding Schedulers: user_guide/adding_schedulers.md
    - Adding Metrics: user_guide/adding_metrics.md
    - Training Workflow: user_guide/training.md
    - Training with CLI: user_guide/training_with_cli.md
    - Inference: user_guide/inference.md