-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
132 lines (132 loc) · 4.11 KB
/
mkdocs.yml
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
site_name: "FunFact: Tensor Decomposition, Your Way"
site_url: "https://funfact.readthedocs.io/"
repo_url: "https://github.com/yhtang/FunFact/"
edit_uri: "blob/develop/docs/"
repo_name: "yhtang/FunFact"
site_dir: "site"
theme:
name: material
logo: assets/funfact.svg
favicon: assets/favicon.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: amber
# accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: "indigo"
# accent: lime
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- content.code.annotate
- navigation.tabs
- navigation.top
plugins:
- search
# - gen-files:
# scripts:
# - docs/copy_readme.py
# - docs/gen_ref_nav.py
# - docs/gen_credits.py
# - section-index
- literate-nav:
nav_file: SUMMARY.md
- autorefs
- mkdocs-jupyter:
include_source: False
- mkdocstrings:
watch:
- funfact
handlers:
python:
setup_commands:
- import sys
- from unittest.mock import MagicMock as M
- sys.modules["torch"] = M()
- sys.modules["jax"] = M()
- sys.modules["jax.numpy"] = M()
- sys.modules["jax.random"] = M()
- sys.modules["jax.tree_util"] = M()
rendering:
show_root_heading: True
show_root_full_path: False
# show_signature_annotations: True
# show_root_members_full_path: True
members_order: source
heading_level: 1
show_bases: true
show_category_heading: false
# show_if_no_docstring: true
# show_root_toc_entry: True
markdown_extensions:
- admonition
- tables
- toc:
permalink: "¶"
- pymdownx.tabbed:
alternate_style: true
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
use_pygments: true
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets
- pymdownx.details
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- javascripts/mathjax.js
# - javascripts/tablesort.js
extra_css:
- stylesheets/extra.css
nav:
- Home: index.md
- pages/installation.md
- Examples:
- Nonlinear matrix approximation: examples/matrix-approximation.ipynb
- Quantum circuit compilation: examples/quantum-compilation.ipynb
- pages/cheatsheet.md
- User Guide:
- pages/user-guide/tensor-and-indices.md
- pages/user-guide/tsrex.md
- pages/user-guide/eval.md
- pages/user-guide/factorize.md
- pages/user-guide/backends.md
- pages/user-guide/cfg.md
- API Reference:
- "funfact.index": api/index_.md
- "funfact.indices": api/indices.md
- "funfact.tensor": api/tensor.md
- "funfact.TsrEx": api/tsrex.md
- "funfact.initializers": api/initializers.md
- "funfact.conditions": api/conditions.md
- "<b>Factorization</b>":
- "funfact.factorize": api/factorize.md
- "funfact.Factorization": api/factorization.md
- "funfact.optim": api/optim.md
- "funfact.loss": api/loss.md
- "funfact.vectorize": api/vectorize.md
- "funfact.view": api/view.md
- "<b>Special tensors</b>":
- "funfact.zeros": api/zeros.md
- "funfact.ones": api/ones.md
- "funfact.eye": api/eye.md
- "<b>Backend selection</b>":
- "funfact.available_backends": api/available_backends.md
- "funfact.use": api/use.md/
- "funfact.active_backend": api/active_backend.md
- "backend 'jax'": api/backend/_jax.md
- "backend 'torch'": api/backend/_torch.md
- "backend 'numpy'": api/backend/_numpy.md
- pages/contribute.md # contribution guide