velora/mkdocs.yml at main · Achronus/velora · 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
site_name: Velora
site_description: A Liquid Reinforcement Learning (RL) framework
site_url: https://velora.achronus.dev/

theme:
  name: "material"
  language: en
  palette:
    scheme: slate
    primary: blue
    accent: cyan
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - navigation.path
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  logo: assets/imgs/logo.png
  favicon: favicon.png
  icon:
    repo: fontawesome/brands/github

repo_name: Achronus/velora
repo_url: https://github.com/Achronus/velora
edit_uri: edit/main/docs

extra_css:
  - "assets/css/icons.css"
  - https://unpkg.com/katex@0/dist/katex.min.css

extra_javascript:
  - "assets/js/katex.js"
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

nav:
  - Velora: index.md
  - Getting Started:
      - Getting Started: starting/index.md
      - Roadmap: starting/roadmap.md
      - Appreciation: starting/homage.md
      - Brief History & Motivation: starting/history.md
      - License: starting/license.md
  - Learn:
      - User Guide - Tutorials:
          - User Guide - Tutorials: learn/tutorial/index.md
          - Agent Basics: learn/tutorial/agent.md
          - Callbacks: learn/tutorial/callback.md
          - Saving & Loading Models: learn/tutorial/save.md
          - Agents:
              - Agents: learn/tutorial/agents/index.md
              - NeuroFlow - Discrete: learn/tutorial/agents/nf.md
              - NeuroFlow - Continuous: learn/tutorial/agents/nf-ct.md
          - Training Metrics: learn/tutorial/metrics.md
          - Gymnasium: learn/tutorial/gym.md
          - Utilities: learn/tutorial/utils.md
      - Customization:
          - Customization: learn/customize/index.md
          - Wiring: learn/customize/wiring.md
          - Liquid Networks: learn/customize/liquid.md
          - Buffers: learn/customize/buffers.md
          - Modules:
            - Modules: learn/customize/modules/index.md
            - Actor: learn/customize/modules/actor.md
            - Critic: learn/customize/modules/critic.md
            - Entropy: learn/customize/modules/entropy.md
          - Backbones: learn/customize/backbone.md
      - Theory:
          - Theory: learn/theory/index.md
          - Liquid Neural Networks: learn/theory/lnn.md
      - API Reference:
          - API Reference: learn/reference/index.md
          - models:
            - activation: learn/reference/models/activation.md
            - backbone: learn/reference/models/backbone.md
            - base: learn/reference/models/base.md
            - config: learn/reference/models/config.md
            - lnn: learn/reference/models/lnn.md
            - nf: learn/reference/models/nf.md
            - modules: learn/reference/models/modules.md
            - sac: learn/reference/models/sac.md
          - buffer: learn/reference/buffer.md
          - callbacks: learn/reference/callbacks.md
          - gymnasium: learn/reference/gym.md
          - metrics: learn/reference/metrics.md
          - state: learn/reference/state.md
          - training: learn/reference/training.md
          - utils: learn/reference/utils.md
          - wiring: learn/reference/wiring.md
  - Help: help.md
  - Changelog:
      - v0.2.0: changelog/v0.2.0.md
      - v0.1.1: changelog/v0.1.1.md
      - v0.0.3 (Beta): changelog/v0.0.3.md
      - v0.0.2 (Beta): changelog/v0.0.2.md
      - v0.0.1 (Alpha): changelog/v0.0.1.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Achronus/velora
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/velora

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - tables
  - md_in_html
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - docs/assets/icons
  - pymdownx.highlight:
      pygments_lang_class: true
      auto_title: true
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true
      title: Page Contents

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [velora]
          inventories:
            - url: https://docs.python.org/3.12/objects.inv
              domains: [std, py]
            - url: https://pytorch.org/docs/stable/objects.inv
            - url: https://docs.pydantic.dev/latest/objects.inv
            - url: https://gymnasium.farama.org/objects.inv
          options:
            annotations_path: source
            show_source: true
            show_root_toc_entry: false
            show_object_full_path: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_object_full_path: false
            docstring_style: google