loadax/mkdocs.yml at main · walln/loadax · 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
site_name: Loadax Documentation
site_url: https://walln.github.io/loadax/
site_author: Nick Wall

theme:
  name: material
  custom_dir: docs/theme
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb-outline
        name: "Switch to dark mode"
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb
        name: "Switch to light mode"
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.top
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - search.suggest
    - toc.follow

repo_name: walln/loadax
repo_url: https://github.com/walln/loadax
edit_uri: edit/main/docs/

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: "On this page"
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true

extra:
  version:
    provider: mike

plugins:
  - mike:
      alias_type: symlink
      canonical_version: latest
  - search
  - mermaid2
  - exclude:
      glob:
      - __pycache__/*
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
            # extensions:
            #  -  docs/plugins/griffe_doclinks.py
          import:
            - url: https://docs.python.org/3/objects.inv
              domains: [py, std]


nav:
  - Getting Started:
      - Welcome to Loadax: index.md
      - Multi-Host Training: multi-host.md
      - Roadmap: roadmap.md
  - API Documentation:
      - Dataloader:
          - Dataloader: api/loader.md
          - Utilties:
              - Progress: api/progress.md
      - Sharding:
          - Mesh: api/sharding/mesh.md
          - Placement: api/sharding/placement.md
          - Presets: api/sharding/presets.md
      - Datasets:
          - Dataset: api/dataset/dataset.md
          - SimpleDataset: api/dataset/simple.md
          - Transformations:
              - MappedDataset: api/dataset/transformations/mapped.md
              - CombinedDataset: api/dataset/transformations/combined.md
              - PartialDataset: api/dataset/transformations/partial.md
              - SampledDataset: api/dataset/transformations/sampled.md
              - ShardedDataset: api/dataset/transformations/sharded.md
          - Integrations:
              - HuggingFace: api/dataset/integration/huggingface.md

watch:
  - src/