/
pydoc-markdown.yml
63 lines (63 loc) · 2.08 KB
/
pydoc-markdown.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
loaders:
- type: python
search_path: [verifyml]
renderer:
type: mkdocs
pages:
- title: Home
name: index
source: README.md
- title: Fairness
children:
- title: Fairness Assessment
source: verifyml/model_tests/README.md
- title: Credit Card Fraud Example Notebook
source: examples/credit_card_fraud_example.ipynb
- title: Automated Checks with Github Actions
name: Automated Checks with Github Actions
source: github-actions.md
- title: Contributing
name: contributing
source: CONTRIBUTING.md
- title: Development
name: development
source: DEVELOPMENT.md
- title: API Documentation
children:
- title: Model Card Toolkit
children:
- title: Model Card
contents: [model_card_toolkit.model_card.*]
- title: Model Card Toolkit
contents: [model_card_toolkit.model_card_toolkit.*]
- title: Model Tests
children:
- title: ModelTest
contents: [model_tests.ModelTest.*]
- title: FEAT
children:
- title: DataShift
contents: [model_tests.FEAT.DataShift.*]
- title: FeatureImportance
contents: [model_tests.FEAT.FeatureImportance.*]
- title: MinMaxMetricThreshold
contents: [model_tests.FEAT.MinMaxMetricThreshold.*]
- title: Perturbation
contents: [model_tests.FEAT.Perturbation.*]
- title: SHAPFeatureImportance
contents: [model_tests.FEAT.SHAPFeatureImportance.*]
- title: SubgroupDisparity
contents: [model_tests.FEAT.SubgroupDisparity.*]
mkdocs_config:
site_name: VerifyML
theme:
# nested children are automatically expanded on readthedocs theme
name: material
palette:
primary: teal
repo_url: https://github.com/cylynx/verifyml
markdown_extensions:
- toc:
permalink: True
plugins:
- mkdocs-jupyter