Skip to content

Commit 40b409d

Browse files
committed
update yml file
1 parent 84eaadc commit 40b409d

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

_pkgdown.yml

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ navbar:
3434
aria-label: GitHub repository
3535

3636
reference:
37+
# -----------------------------------------------------------------------
3738
- title: "Main Interface"
3839
desc: >
3940
Primary entry point for the MLSampling framework. Use `create_ml_sampling_tool()`
@@ -45,6 +46,20 @@ reference:
4546
- SoilSamplingTool
4647
- create_soil_sampling_tool
4748

49+
# -----------------------------------------------------------------------
50+
- title: "ML Model Classes"
51+
desc: >
52+
R6 classes implementing the individual ML models. These are instantiated
53+
automatically by `MLSampling` but can also be used directly.
54+
contents:
55+
- BayesianDeepLearning
56+
- RandomForestOptimization
57+
- MLEnsembleManager
58+
- DesignComparison
59+
- SpatialAnalysisEngine
60+
- SpatialUncertainty
61+
62+
# -----------------------------------------------------------------------
4863
- title: "Service Classes"
4964
desc: >
5065
Supporting R6 service classes for configuration management, benchmarking,
@@ -61,6 +76,7 @@ reference:
6176
- create_resource_manager
6277
- VisualizationService
6378

79+
# -----------------------------------------------------------------------
6480
- title: "Field Data Validation"
6581
desc: >
6682
Functions for validating system requirements, field data structures,
@@ -72,6 +88,7 @@ reference:
7288
- validate_crs_consistency
7389
- validate_ml_data
7490

91+
# -----------------------------------------------------------------------
7592
- title: "Sampling & Result Validation"
7693
desc: >
7794
Validation functions for sampling location sets, optimization results,
@@ -83,6 +100,7 @@ reference:
83100
- validate_ml_optimization_result
84101
- validate_uncertainty_results
85102

103+
# -----------------------------------------------------------------------
86104
- title: "Data Structures"
87105
desc: >
88106
Factory functions for creating standardized result objects used throughout
@@ -94,21 +112,32 @@ reference:
94112
- create_ml_optimization_result
95113
- create_optimization_result
96114

115+
# -----------------------------------------------------------------------
97116
- title: "Error Handling"
98117
desc: >
99-
Structured error classes and handler utilities for robust exception management.
100-
All domain errors inherit from `MLSamplingError`.
118+
Structured error class hierarchy and handler utilities for robust exception
119+
management. All domain errors inherit from `MLSamplingError`.
101120
contents:
121+
- MLSamplingErrors
102122
- MLSamplingError
103123
- BDLError
104124
- RFError
105125
- SpatialError
106126
- ResourceError
107127
- ConfigError
108128
- ValidationError
129+
- create_error
109130
- raise_error
110131
- with_error_handling
111132

133+
# -----------------------------------------------------------------------
134+
- title: "Internal Functions"
135+
desc: >
136+
Low-level helper functions used internally by the package. Documented here
137+
for developer reference.
138+
contents:
139+
- everything()
140+
112141
articles:
113142
- title: "Getting Started"
114143
navbar: "Getting Started"

0 commit comments

Comments
 (0)