forked from deepcharles/ruptures
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
127 lines (127 loc) · 5.06 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
site_name: ruptures
repo_url: https://github.com/deepcharles/ruptures
repo_name: deepcharles/ruptures
docs_dir: docs
site_dir: site
plugins:
- search
- mkdocstrings:
watch:
- ruptures
handlers:
python:
selection:
filters:
- "!^_" # exclude all members starting with _
- "^__init__$" # but always include __init__ modules and methods
- mknotebooks:
execute: false
binder: false
- macros:
module_name: mkdocs_macros
- section-index
markdown_extensions:
- pymdownx.snippets:
- pymdownx.tabbed:
- pymdownx.emoji:
- pymdownx.superfences:
- pymdownx.arithmatex:
generic: true
- admonition:
- toc:
permalink: "#"
- codehilite
nav:
- Home:
- index.md
- Getting started:
- what-is-cpd.md
- 'Installation': install.md
- 'Basic usage': getting-started/basic-usage.ipynb
- 'Fitting and predicting': fit-and-predict.md
- 'Custom cost function': custom-cost-function.md
- User guide:
- user-guide/index.md
- Search methods:
- 'Dynamic programming': user-guide/detection/dynp.md
- 'Pelt': user-guide/detection/pelt.md
- 'Kernel change detection': user-guide/detection/kernelcpd.md
- 'Binary segmentation': user-guide/detection/binseg.md
- 'Bottom-up segmentation': user-guide/detection/bottomup.md
- 'Window sliding segmentation': user-guide/detection/window.md
- Cost functions:
- 'CostL1': user-guide/costs/costl1.md
- 'CostL2': user-guide/costs/costl2.md
- 'CostNormal': user-guide/costs/costnormal.md
- 'CostRbf': user-guide/costs/costrbf.md
- 'CostCosine': user-guide/costs/costcosine.md
- 'CostLinear': user-guide/costs/costlinear.md
- 'CostCLinear': user-guide/costs/costclinear.md
- 'CostRank': user-guide/costs/costrank.md
- 'CostMl': user-guide/costs/costml.md
- 'CostAR': user-guide/costs/costautoregressive.md
- 'Custom cost': user-guide/costs/costcustom.md
- Generate signals:
- 'Piecewise constant': user-guide/datasets/pw_constant.md
- 'Piecewise linear': user-guide/datasets/pw_linear.md
- 'Piecewise Gaussian': user-guide/datasets/pw_normal.md
- 'Piecewise sinusoidal': user-guide/datasets/pw_wavy.md
- Evaluation metrics:
- 'Precision and recall': user-guide/metrics/precisionrecall.md
- 'Hausdorff metric': user-guide/metrics/hausdorff.md
- 'Rand index': user-guide/metrics/randindex.md
- Display:
- user-guide/show/display.md
- Gallery of examples:
- examples/introduction.md
- 'Simple usages':
- 'Basic usage': examples/basic-usage.ipynb
- 'Advanced usages':
- 'Kernel change point detection: a performance comparison': examples/kernel-cpd-performance-comparison.ipynb
- 'Music segmentation': examples/music-segmentation.ipynb
- 'Text segmentation': examples/text-segmentation.ipynb
- Code reference:
- code-reference/index.md
- Base classes: code-reference/base-reference.md
- Search methods:
- Dynp: code-reference/detection/dynp-reference.md
- KernelCPD: code-reference/detection/kernelcpd-reference.md
- Pelt: code-reference/detection/pelt-reference.md
- Binseg: code-reference/detection/binseg-reference.md
- BottomUp: code-reference/detection/bottomup-reference.md
- Window: code-reference/detection/window-reference.md
- Cost functions:
- 'CostL1': code-reference/costs/costl1-reference.md
- 'CostL2': code-reference/costs/costl2-reference.md
- 'CostNormal': code-reference/costs/costnormal-reference.md
- 'CostRbf': code-reference/costs/costrbf-reference.md
- 'CostCosine': code-reference/costs/costcosine-reference.md
- 'CostLinear': code-reference/costs/costlinear-reference.md
- 'CostCLinear': code-reference/costs/costclinear-reference.md
- 'CostRank': code-reference/costs/costrank-reference.md
- 'CostMl': code-reference/costs/costml-reference.md
- 'CostAR': code-reference/costs/costautoregressive-reference.md
- Data sets:
- 'Piecewise constant': code-reference/datasets/pw_constant-reference.md
- 'Piecewise linear': code-reference/datasets/pw_linear-reference.md
- 'Piecewise normal': code-reference/datasets/pw_normal-reference.md
- 'Piecewise wavy': code-reference/datasets/pw_wavy-reference.md
- Metrics:
- 'Precision and recall': code-reference/metrics/precisionrecall.md
- 'Hausdorff metric': code-reference/metrics/hausdorff.md
- 'Rand index': code-reference/metrics/randindex.md
- Display:
- 'Display function': code-reference/show/display.md
- About:
- 'Release notes': release-notes.md
- 'Contributing': contributing.md
- 'License': license.md
theme:
name: material
features:
- navigation.tabs
- search.highlight
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js