data_leakage_detect/mkdocs.yml at main · ai-forever/data_leakage_detect · 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
site_name: FiMMIA Documentation
site_description: Framework for Multimodal Membership Inference Attacks
site_url: https://fimmia.readthedocs.io/
repo_name: ai-forever/data_leakage_detect
repo_url: https://github.com/ai-forever/data_leakage_detect
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - 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
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            merge_init_into_class: true
            separate_signature: true
            heading_level: 3

nav:
  - Home: index.md
  - Installation: installation.md
  - Quick Start: quickstart.md
  - Usage:
    - CLI Reference: usage/cli-reference.md
    - Python API: usage/python-api.md
    - Pipeline Guide: usage/pipeline.md
  - API Reference:
    - FiMMIA: api/fimmia.md
    - Shift Detection: api/shift_detection.md
  - Tutorials:
    - Training: tutorials/training.md
    - Inference: tutorials/inference.md
    - Examples: tutorials/examples.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ai-forever/data_leakage_detect
  version:
    provider: mike