models/mkdocs.yml at main · ml4t/models · 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
site_name: ML4T Models
site_description: Finance-native model implementations for latent factors and portfolio learning
site_url: https://ml4trading.io/docs/models/
repo_url: https://github.com/ml4t/models
repo_name: ml4t/models

theme:
  name: material
  custom_dir: docs/overrides

  palette:
    scheme: default
    primary: custom
    accent: custom

  font: false

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/ml4t-theme.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            signature_crossrefs: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quickstart: getting-started/quickstart.md
  - User Guide:
    - user-guide/index.md
    - Data Contracts: user-guide/data-contracts.md
    - Training Procedures: user-guide/training-procedures.md
    - Latent-Factor Pipelines: user-guide/latent-factor-pipelines.md
    - Latent-Factor Models: user-guide/latent-factor-models.md
    - Stochastic Discount Factor: user-guide/stochastic-discount-factor.md
    - Direct Asset Prediction: user-guide/direct-asset-prediction.md
    - Portfolio Learning: user-guide/portfolio-learning.md
    - Integration: user-guide/integration.md
  - API Reference:
    - api/index.md
  - Book Guide:
    - book-guide/index.md
  - Reference:
    - Architecture: reference/architecture.md
    - API Stability: reference/api-stability.md
    - Release Gates: reference/release-gates.md
    - Model Families: reference/model-families.md
    - Academic References: reference/academic-references.md

extra:
  ml4t_docs_hub_url: /docs/
  ml4t_libraries_url: /libraries/
  ml4t_chapters_url: /chapters/
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/stefan-jansen
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/mlaboratory
  generator: false

copyright: Copyright &copy; 2024-2026 Stefan Jansen