-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
226 lines (196 loc) · 7.66 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
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# Author(s): Dhruv Srikanth
# Email(s): dsrikant (at) andrew (dot) cmu (dot) edu
# Acknowledgements:
# Copyright (c) 2023 Carnegie Mellon University, Auton Lab
# This code is subject to the license terms contained in the code repo.
# Project information
site_name: AutonFeat ⌛️
site_url: https://autonlab.github.io/AutonFeat
site_author: Dhruv Srikanth
site_description: >-
Documentation for AutonFeat, a high-performant package for time-series featurization.
docs_dir: docs
site_dir: site
use_directory_urls: true
# Repository
repo_name: AutonFeat
repo_url: https://github.com/autonlab/AutonFeat
remote_branch: gh-pages
remote_name: lab
# Copyright
copyright: null
# Configuration
theme:
name: material
locale: en
features:
- content.code.annotate
- content.code.copy
- navigation.footer
- navigation.indexes
- navigation.tabs
- navigation.top
- navigation.tracking
- navigation.collapse
- search.highlight
- search.share
- search.suggest
- toc.follow
- social
palette:
- scheme: default
primary: deep orange
accent: deep orange
toggle:
icon: material/brightness-7
name: Dark Mode
- scheme: slate
primary: deep orange
accent: deep orange
toggle:
icon: material/brightness-4
name: Light Mode
font:
text: Roboto
code: Roboto Mono
icon:
repo: fontawesome/brands/github
logo: fontawesome/regular/hourglass
favicon: fontawesome/regular/hourglass
include_homepage_in_sidebar: true
highlightjs: true
hijs_languages:
- python
# Plugins
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [autonfeat]
options:
show_source: false
heading_level: 2
# Customization
extra:
social:
# Dhruv Srikanth
- icon: fontawesome/brands/twitter
link: https://twitter.com/DhruvSrikanth
- icon: fontawesome/brands/github
link: https://github.com/DhruvSrikanth
# Auton Lab
- icon: fontawesome/brands/twitter
link: https://twitter.com/AutonLab
- icon: fontawesome/brands/github-alt
link: https://github.com/autonlab
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js # (1)!
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
# Extensions
markdown_extensions:
- toc:
permalink: true
separator: "_"
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
# Page tree
nav:
- 'About': index.md
- 'Getting Started' :
- 'Installation' : 'getting_started/installation.md'
- 'Introduction' : 'getting_started/introduction.md'
- 'Tutorials' :
- 'Tutorial Guide' : 'tutorials/tutorials.md'
- 'Single-Feature Extraction' : 'tutorials/single_feature_extraction.md'
- 'Multi-Feature Extraction' : 'tutorials/multi_feature_extraction.md'
- 'Features' :
- 'Feature Extractors' : 'api/features.md'
- 'Preprocessors' : 'api/preprocess/preprocess.md'
- 'API Reference' :
- 'Reference Guide' : 'api/api.md'
- 'Core' :
- 'Sliding Window' : 'api/core/fixed_window.md'
- 'Transform' : 'api/core/transform.md'
- 'Preprocess' : 'api/core/preprocess.md'
- 'Common' :
- 'Mean Transform' : 'api/common/mean_transform.md'
- 'Max Transform' : 'api/common/max_transform.md'
- 'Min Transform' : 'api/common/min_transform.md'
- 'Median Transform' : 'api/common/median_transform.md'
- 'Std Transform' : 'api/common/std_transform.md'
- 'Var Transform' : 'api/common/var_transform.md'
- 'Quantile Transform' : 'api/common/quantile_transform.md'
- 'Range Transform' : 'api/common/range_transform.md'
- 'N-Valid Transform' : 'api/common/n_valid_transform.md'
- 'IQR Transform' : 'api/common/iqr_transform.md'
- 'Skew Transform' : 'api/common/skewness_transform.md'
- 'Kurtosis Transform' : 'api/common/kurtosis_transform.md'
- 'Data Sparsity Transform' : 'api/common/data_sparsity_transform.md'
- 'Data Density Transform' : 'api/common/data_density_transform.md'
- 'Entropy Transform' : 'api/common/entropy_transform.md'
- 'Cross Entropy Transform' : 'api/common/cross_entropy_transform.md'
- 'Sample Entropy Transform' : 'api/common/sample_entropy_transform.md'
- 'Approximate Entropy Transform' : 'api/common/approx_entropy_transform.md'
- 'Functional' :
- 'mean' : 'api/functional/mean.md'
- 'max' : 'api/functional/max.md'
- 'min' : 'api/functional/min.md'
- 'median' : 'api/functional/median.md'
- 'std' : 'api/functional/std.md'
- 'var' : 'api/functional/var.md'
- 'quantile' : 'api/functional/quantile.md'
- 'range' : 'api/functional/range.md'
- 'n-valid' : 'api/functional/n_valid.md'
- 'iqr' : 'api/functional/iqr.md'
- 'skewness' : 'api/functional/skewness.md'
- 'kurtosis' : 'api/functional/kurtosis.md'
- 'data sparsity' : 'api/functional/data_sparsity.md'
- 'data density' : 'api/functional/data_density.md'
- 'entropy' : 'api/functional/entropy.md'
- 'cross entropy' : 'api/functional/cross_entropy.md'
- 'sample entropy' : 'api/functional/sample_entropy.md'
- 'approximate entropy' : 'api/functional/approx_entropy.md'
- 'Preprocess' :
- 'Functional' :
- 'delta' : 'api/preprocess/functional/delta_preprocessor_fn.md'
- 'delta mean' : 'api/preprocess/functional/delta_mean_preprocessor_fn.md'
- 'delta max' : 'api/preprocess/functional/delta_max_preprocessor_fn.md'
- 'delta min' : 'api/preprocess/functional/delta_min_preprocessor_fn.md'
- 'delta median' : 'api/preprocess/functional/delta_median_preprocessor_fn.md'
- 'delta std' : 'api/preprocess/functional/delta_std_preprocessor_fn.md'
- 'delta var' : 'api/preprocess/functional/delta_var_preprocessor_fn.md'
- 'delta quantile' : 'api/preprocess/functional/delta_quantile_preprocessor_fn.md'
- '1D DFT' : 'api/preprocess/functional/dft_preprocessor_fn.md'
- 'power spectrum' : 'api/preprocess/functional/power_spectrum_preprocessor_fn.md'
- 'lag' : 'api/preprocess/functional/lag_preprocessor_fn.md'
- 'Transform' :
- 'Delta Transform' : 'api/preprocess/transform/delta_preprocessor.md'
- 'Delta Mean Transform' : 'api/preprocess/transform/delta_mean_preprocessor.md'
- 'Delta Max Transform' : 'api/preprocess/transform/delta_max_preprocessor.md'
- 'Delta Min Transform' : 'api/preprocess/transform/delta_min_preprocessor.md'
- 'Delta Median Transform' : 'api/preprocess/transform/delta_median_preprocessor.md'
- 'Delta Std Transform' : 'api/preprocess/transform/delta_std_preprocessor.md'
- 'Delta Var Transform' : 'api/preprocess/transform/delta_var_preprocessor.md'
- 'Delta Quantile Transform' : 'api/preprocess/transform/delta_quantile_preprocessor.md'
- '1D DFT Transform' : 'api/preprocess/transform/dft_preprocessor.md'
- 'Power Spectrum Transform' : 'api/preprocess/transform/power_spectrum_preprocessor.md'
- 'Lag Transform' : 'api/preprocess/transform/lag_preprocessor.md'
- 'Health' : 'api/health/health.md'
- 'Utils' : 'api/utils/utils.md'
- 'Community' :
- 'Contributing': 'community/contributing.md'