forked from wwu-mmll/photonai
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
133 lines (129 loc) · 5.96 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
site_name: ""
docs_dir: documentation/docs
nav:
- 'Getting Started':
- 'Basic Usage': index.md
- 'PHOTONAI Framework': getting_started/photonai.md
- 'Simple Regression': getting_started/regression.md
- 'Simple Classification': getting_started/default_classification.md
- 'Access established ml-packages': getting_started/algorithm_index.md
- 'Hyperparameter Optimization': getting_started/hpos.md
- 'Include custom algorithm': getting_started/custom_algorithm.md
- 'Inspect and visualize results': getting_started/output.md
- 'Pipeline Architecture':
- 'Switch (OR)': photon_elements/switch.md
- 'Stack (AND)': photon_elements/stack.md
- Feature Subset Pipelines: photon_elements/feature_subset_pipelines.md
# - Subpipelines: examples/subpipelines.md
- Classifier Ensemble: photon_elements/classifier_ensemble.md
- 'Examples':
- 'General':
- 'Simple Classification': examples/default_classification.md
- 'Simple Regression': examples/regression.md
- 'Compare estimators': examples/compare_estimators.md
- 'Over- /Undersampling': examples/imbalanced_data.md
- 'Remove confounders': examples/confounder_removal.md
- 'Use a DNN with multiclass prediction': examples/dnn_multiclass_prediction.md
- 'Specific Use Cases':
- 'Sample Pairing': examples/sample_pairing.md
- 'No Hyperparameter Optimization': examples/no_outer_cv.md
- 'Use site-specific validation': examples/group_driven_cv_split.md
- 'Permutation Importances': examples/permutation_importances.md
# - Permutation Test: examples/permutation_test.md
- 'Optimize a MLP': examples/scikit_learn_mlp.md
- 'Features':
- 'Custom Metrics': features/custom_metrics.md
- 'Hyperparameter Optimization Shortcuts': features/performance_constraints.md
- 'Load and use a .photon model': features/save_load.md
- 'Stream additional data': features/additional_data.md
- 'Inspect the dataflow at runtime': features/callbacks.md
- 'Caching': features/caching.md
- 'Transform in Batches': features/batching.md
- 'Learning Curves': features/learning_curves.md
- 'Result Queries': features/result_handler.md
- 'Preprocessing' : features/preprocessing.md
# Multidim y?
# - 'Permutation Test': features/permutation_test.md
- 'Algorithms':
- 'Access pre-registered algorithms': algorithms/algorithms_index.md
- 'Transformers': algorithms/transformers.md
- 'Estimators': algorithms/estimators.md
- 'Hyperparameter Optimizers': algorithms/hpos.md
- 'Registry': algorithms/registry.md
- 'API':
- Overview: api/architecture.md
- 'Base':
- Branch: api/base/branch.md
- Hyperpipe: api/base/hyperpipe.md
- OutputSettings: api/base/output_settings.md
- PipelineElement: api/base/pipeline_element.md
- Preprocessing: api/base/preprocessing.md
- Registry: api/base/registry.md
- Stack: api/base/stack.md
- Switch: api/base/switch.md
- 'Default Elements':
- ClassificationPipe: api/base/classification_pipe.md
- RegressionPipe: api/base/regression_pipe.md
- ClassifierSwitch: api/base/classifier_switch.md
- RegressorSwitch: api/base/regressor_switch.md
- 'Modelwrapper':
- 'BaseModelWrapper': api/modelwrapper/base_model_wrapper.md
- 'Feature Selection':
- FClassifSelectPercentile: api/modelwrapper/feature_selection/FClassifSelectPercentile.md
- FRegressionFilterPValue: api/modelwrapper/feature_selection/FRegressionFilterPValue.md
- FRegressionSelectPercentile: api/modelwrapper/feature_selection/FRegressionSelectPercentile.md
- LassoFeatureSelection: api/modelwrapper/feature_selection/LassoFeatureSelection.md
- ModelSelector: api/modelwrapper/feature_selection/ModelSelector.md
- 'Keras':
- 'KerasDnnClassifier': api/modelwrapper/keras/dnn_classifier.md
- 'KerasDnnRegressor': api/modelwrapper/keras/dnn_regressor.md
- 'LabelEncoder': api/modelwrapper/label_encoder.md
- 'ImbalancedDataTransformer': api/modelwrapper/imblearn.md
- 'Optimization':
- GridSearch: api/optimization/grid_search.md
- RandomGridSearch: api/optimization/random_grid_search.md
- RandomSearch: api/optimization/random_search.md
- Scikit-Optimize: api/optimization/skopt.md
- SMAC: api/optimization/smac.md
- Nevergrad: api/optimization/nevergrad.md
- 'Hyperparameter':
- BooleanSwitch: api/optimization/hyperparameter/boolean_switch.md
- Categorical: api/optimization/hyperparameter/categorical.md
- FloatRange: api/optimization/hyperparameter/float_range.md
- IntegerRange: api/optimization/hyperparameter/integer_range.md
- 'Processing':
- Results Handler: api/processing/results_handler.md
- 'Custom Elements':
- Custom Transformer: api/custom_transformer.md
- Custom Estimator: api/custom_estimator.md
- 'About':
- Website: 'https://www.photon-ai.com'
- Preprint: 'https://arxiv.org/abs/2002.05426'
- 'Contributions': contribution.md
extra_css:
- assets/stylesheets/extra.css
- assets/stylesheets/fonts.css
theme:
name: material
custom_dir: documentation/overrides
repo_url: https://github.com/wwu-mmll/photonai
favicon: favicon.png
features:
- navigation.tabs
font: false
markdown_extensions:
- attr_list
- pymdownx.highlight:
linenums: true
- pymdownx.superfences
plugins:
- search
- macros:
include_dir: ./
- mkdocstrings:
handlers:
python:
selection:
filters:
- "!^_"
- "^__init__$"