marin/mkdocs.yml at main · wmoss/marin · 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
site_name: Marin Documentation
site_description: Documentation for the Marin project
site_url: https://marin.community

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - search.highlight
    - search.share
    - search.suggest
    - content.code.annotation
    - content.code.copy
    - navigation.footer
  language: en
  palette:
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      primary: black
      accent: white
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
      primary: black
      accent: white
  icon:
    repo: fontawesome/brands/git-alt
    edit: material/pencil
    view: material/eye
  logo: static/logo.png
  favicon: static/favicon.ico

repo_url: https://github.com/marin-community/marin
repo_name: marin-community/marin
edit_uri: edit/main/docs/

# Include extra JS to setup Read the Docs addons integrations
extra_javascript:
  - javascript/readthedocs.js

extra_css:
  - css/mkdocstrings.css
  - css/custom.css
  - css/friendly.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/marin-community/marin
    - icon: fontawesome/brands/discord
      link: https://discord.gg/DhbGDq3jv4

watch:
  - docs/
  - lib/marin/src/

nav:
  - Home: index.md
  - Tutorials:
      - Installation: tutorials/installation.md
      - First Experiment: tutorials/first-experiment.md
      - Setting up a Local GPU Environment: tutorials/local-gpu.md
      - Prepare a Storage Bucket: tutorials/storage-bucket.md
      - Executor 101: tutorials/executor-101.md
      - Training an LM: tutorials/train-an-lm.md
  - Explanations:
      - The Language Modeling Pipeline: explanations/lm-pipeline.md
      - Evaluation: explanations/evaluation.md
      - Experiments: explanations/experiments.md
      - Executor: explanations/executor.md
      - Guidelines: explanations/guidelines.md
  - Experiments:
      - Daily Ferry Log: experiments/daily-ferry-log.md
      - Report Index: reports/index.md
      - Auto-Generated Summary: reports/summary.md
      - Marin 8B Retro: reports/marin-8b-retro.md
      - Marin 32B Retro: reports/marin-32b-retro.md
      - Markdownified Datasets: reports/markdownified-datasets.md
  - Developer Guide:
      - Contributing: dev-guide/contributing.md
      - Tutorial Guidelines: dev-guide/tutorial-guidelines.md
      - Internal Guidelines: dev-guide/guidelines-internal.md
      - Forking Policy: dev-guide/forking-policy.md
      - Building Docs: dev-guide/building-docs.md
      - Snapshot Tests: dev-guide/snapshot-tests.md
  - Technical Reference:
      - Specifying Hardware Resources: references/resource-config.md
      - Executor API: references/executor-api.md
      - Default Steps: references/default-steps.md
      - Training Configuration: references/train-config.md
      - HBM Optimization: references/hbm-optimization.md

markdown_extensions:
  - markdown.extensions.footnotes
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed
  - pymdownx.arithmatex
  - pymdownx.emoji
  - pymdownx.tasklist
  - pymdownx.highlight:
      anchor_linenums: true
  - admonition
  - footnotes
  - attr_list
  - toc:
      permalink: true

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
      # min_search_length: 2
      # prebuild_index: true
      # # indexing: 'full'
      # properties:
      #     - title
      #     - tags
      #     - content
      #     - sections
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [".", "lib/marin/src"]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://jax.readthedocs.io/en/latest/objects.inv
            - https://haliax.readthedocs.io/en/latest/objects.inv
            - https://levanter.readthedocs.io/en/latest/objects.inv
            - https://docs.kidger.site/equinox/objects.inv
            - https://einops.rocks/objects.inv
          options:
            annotations_path: brief
            ignore_init_summary: true
            docstring_style: google
            show_source: false
            docstring_section_style: list
            heading_level: 4
            inherited_members: true
            merge_init_into_class: false
            load_external_modules: true
            show_signature_annotations: true
            show_root_heading: true
            show_root_full_path: false
            show_bases: true
            show_submodules: true
            filters: ["!^_"]
            show_if_no_docstring: true
            show_symbol_type_heading: false
            show_symbol_type_toc: false
            show_category_heading: true
            members_order: source
            separate_signature: true
            line_length: 60
            signature_crossrefs: true

  - include-markdown