FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(config): refresh the generated calibration reference · HydroModPy/HydroModPy@fe2dd91 · GitHub

/ HydroModPy Public

Commit fe2dd91

Browse files
bastien-boivin
committed
docs(config): refresh the generated calibration reference
1 parent 68e3a39 commit fe2dd91

5 files changed

Lines changed: 131 additions & 82 deletions

File tree

‎docs/source/_static/hmp-config-search.json‎

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18778,7 +18778,7 @@
1877818778
"section": "calibration",
1877918779
"anchor": "calibration-method",
1878018780
"page": "calibration.html",
18781-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L624",
18781+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L631",
1878218782
"description": "Optimization method. Optuna is installed by default; install the calibration extra for cma_es and Optuna's cmaes sampler."
1878318783
},
1878418784
{
@@ -18790,7 +18790,7 @@
1879018790
"section": "calibration",
1879118791
"anchor": "calibration-max-iter",
1879218792
"page": "calibration.html",
18793-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L631",
18793+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L638",
1879418794
"description": "Maximum number of calibration iterations."
1879518795
},
1879618796
{
@@ -18802,7 +18802,7 @@
1880218802
"section": "calibration",
1880318803
"anchor": "calibration-batch-size",
1880418804
"page": "calibration.html",
18805-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L636",
18805+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L643",
1880618806
"description": "Number of suggestions drawn per ask (for parallel optimizers)."
1880718807
},
1880818808
{
@@ -18814,7 +18814,7 @@
1881418814
"section": "calibration",
1881518815
"anchor": "calibration-parallel",
1881618816
"page": "calibration.html",
18817-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L641",
18817+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L648",
1881818818
"description": "Number of trials evaluated concurrently inside one batch via a thread pool. parallel=1 keeps the legacy sequential loop."
1881918819
},
1882018820
{
@@ -18826,7 +18826,7 @@
1882618826
"section": "calibration",
1882718827
"anchor": "calibration-warmup-periods",
1882818828
"page": "calibration.html",
18829-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L649",
18829+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L656",
1883018830
"description": "Spin-up (burn-in) periods excluded from every objective block. The first warmup_periods of each observed/simulated series are dropped before the metric, so the window where the state still depends on the initial condition does not bias the "
1883118831
},
1883218832
{
@@ -18838,7 +18838,7 @@
1883818838
"section": "calibration",
1883918839
"anchor": "calibration-scoring-window",
1884018840
"page": "calibration.html",
18841-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L661",
18841+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L668",
1884218842
"description": "Dates bounding the samples every metric is computed on. Mutually exclusive with warmup_periods, which counts samples instead of dates."
1884318843
},
1884418844
{
@@ -18874,7 +18874,7 @@
1887418874
"section": "calibration",
1887518875
"anchor": "calibration-phases",
1887618876
"page": "calibration.html",
18877-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L668",
18877+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L675",
1887818878
"description": "Stages run one after the other, each calibrating its own parameters and freezing them for the next. Declaring this table is what switches the runner to staged mode; without it nothing changes for an existing configuration. The default is No"
1887918879
},
1888018880
{
@@ -19021,6 +19021,18 @@
1902119021
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L580",
1902219022
"description": "Extra keyword arguments forwarded to this phase's optimizer."
1902319023
},
19024+
{
19025+
"path": "calibration.phases.overrides",
19026+
"name": "overrides",
19027+
"type": "dict[str, Any]",
19028+
"profile": "user",
19029+
"stability": "stable",
19030+
"section": "calibration",
19031+
"anchor": "calibration-phases-overrides",
19032+
"page": "calibration.html",
19033+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L584",
19034+
"description": "Configuration values this phase runs with, as dotted paths into the project configuration. The two stages of a stream-network calibration are one steady and one transient, which is a property of the model and not of the search, so a phase h"
19035+
},
1902419036
{
1902519037
"path": "calibration.phases.scoring_window",
1902619038
"name": "scoring_window",
@@ -19030,7 +19042,7 @@
1903019042
"section": "calibration",
1903119043
"anchor": "calibration-phases-scoring-window",
1903219044
"page": "calibration.html",
19033-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L584",
19045+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L591",
1903419046
"description": "Dates bounding the samples this phase scores on."
1903519047
},
1903619048
{
@@ -19066,7 +19078,7 @@
1906619078
"section": "calibration",
1906719079
"anchor": "calibration-phases-depends-on",
1906819080
"page": "calibration.html",
19069-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L588",
19081+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L595",
1907019082
"description": "Name of the phase that must run first. Its frozen parameters enter this one as fixed values."
1907119083
},
1907219084
{
@@ -19078,7 +19090,7 @@
1907819090
"section": "calibration",
1907919091
"anchor": "calibration-phases-freeze-on-success",
1908019092
"page": "calibration.html",
19081-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L593",
19093+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L600",
1908219094
"description": "Hold the parameters this phase calibrated fixed for the phases that depend on it. Success means the phase converged, not that its validity indicator is good."
1908319095
},
1908419096
{
@@ -19090,7 +19102,7 @@
1909019102
"section": "calibration",
1909119103
"anchor": "calibration-seed",
1909219104
"page": "calibration.html",
19093-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L679",
19105+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L686",
1909419106
"description": "Random seed for reproducibility."
1909519107
},
1909619108
{
@@ -19102,7 +19114,7 @@
1910219114
"section": "calibration",
1910319115
"anchor": "calibration-save-runs",
1910419116
"page": "calibration.html",
19105-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L683",
19117+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L690",
1910619118
"description": "How much to persist per iteration: - 'none': 1 DuckDB row per iteration, no Zarr. - 'best_n': same + promote top N to full simulations after the loop. - 'all': every iteration becomes a full simulation (Zarr included)."
1910719119
},
1910819120
{
@@ -19114,7 +19126,7 @@
1911419126
"section": "calibration",
1911519127
"anchor": "calibration-save-best-n",
1911619128
"page": "calibration.html",
19117-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L692",
19129+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L699",
1911819130
"description": "Number of top iterations to promote when save_runs='best_n'."
1911919131
},
1912019132
{
@@ -19126,7 +19138,7 @@
1912619138
"section": "calibration",
1912719139
"anchor": "calibration-use-cache",
1912819140
"page": "calibration.html",
19129-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L697",
19141+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L704",
1913019142
"description": "Enable params_hash content-addressable cache."
1913119143
},
1913219144
{
@@ -19138,7 +19150,7 @@
1913819150
"section": "calibration",
1913919151
"anchor": "calibration-lightweight-extraction",
1914019152
"page": "calibration.html",
19141-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L701",
19153+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L708",
1914219154
"description": "Skip Parquet/Zarr writes for lumped models (GR4J, ...) and read simulated series from the per-trial RAM cache instead. Only the promoted runs go through the catalog write path."
1914319155
},
1914419156
{
@@ -19150,7 +19162,7 @@
1915019162
"section": "calibration",
1915119163
"anchor": "calibration-objective",
1915219164
"page": "calibration.html",
19153-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L707",
19165+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L714",
1915419166
"description": "Metric key used by the default ScalarObjective."
1915519167
},
1915619168
{
@@ -19162,7 +19174,7 @@
1916219174
"section": "calibration",
1916319175
"anchor": "calibration-variable",
1916419176
"page": "calibration.html",
19165-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L711",
19177+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L718",
1916619178
"description": "Observed variable (for ObservationSet)."
1916719179
},
1916819180
{
@@ -19174,7 +19186,7 @@
1917419186
"section": "calibration",
1917519187
"anchor": "calibration-optimizer-kwargs",
1917619188
"page": "calibration.html",
19177-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L715",
19189+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L722",
1917819190
"description": "Extra keyword arguments forwarded to the optimizer adapter."
1917919191
},
1918019192
{
@@ -19186,7 +19198,7 @@
1918619198
"section": "calibration",
1918719199
"anchor": "calibration-parameters",
1918819200
"page": "calibration.html",
19189-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L719",
19201+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L726",
1919019202
"description": "Per-parameter declarations (bounds, transform, prior, path)."
1919119203
},
1919219204
{
@@ -19282,7 +19294,7 @@
1928219294
"section": "calibration",
1928319295
"anchor": "calibration-outputs",
1928419296
"page": "calibration.html",
19285-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L723",
19297+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L730",
1928619298
"description": "Named observables extracted from each candidate run."
1928719299
},
1928819300
{
@@ -19798,7 +19810,7 @@
1979819810
"section": "calibration",
1979919811
"anchor": "calibration-objective-blocks",
1980019812
"page": "calibration.html",
19801-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L727",
19813+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L734",
1980219814
"description": "Weighted blocks making up a composite objective. When empty, a single implicit block is built from 'objective' and 'variable'."
1980319815
},
1980419816
{
@@ -19894,7 +19906,7 @@
1989419906
"section": "calibration",
1989519907
"anchor": "calibration-persist-iteration-detail",
1989619908
"page": "calibration.html",
19897-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L732",
19909+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L739",
1989819910
"description": "'none' skips component metrics; 'summary' keeps block totals; 'full' also stores per-block raw and normalized costs."
1989919911
},
1990019912
{
@@ -19906,7 +19918,7 @@
1990619918
"section": "calibration",
1990719919
"anchor": "calibration-persist-model-distribution",
1990819920
"page": "calibration.html",
19909-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L737",
19921+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L744",
1991019922
"description": "Persist the candidate distribution alongside the session."
1991119923
},
1991219924
{
@@ -19918,7 +19930,7 @@
1991819930
"section": "calibration",
1991919931
"anchor": "calibration-rerun-best-with-outputs",
1992019932
"page": "calibration.html",
19921-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L741",
19933+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L748",
1992219934
"description": "Replay the best candidate with full outputs after the loop."
1992319935
},
1992419936
{
@@ -19930,7 +19942,7 @@
1993019942
"section": "calibration",
1993119943
"anchor": "calibration-materialize-candidates",
1993219944
"page": "calibration.html",
19933-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L745",
19945+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L752",
1993419946
"description": "Write a standalone override TOML for each candidate under 'candidates_root' so runs can be replayed later."
1993519947
},
1993619948
{
@@ -19942,7 +19954,7 @@
1994219954
"section": "calibration",
1994319955
"anchor": "calibration-candidates-root",
1994419956
"page": "calibration.html",
19945-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L750",
19957+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L757",
1994619958
"description": "Directory for per-candidate overlay TOMLs. Required when materialize_candidates is True."
1994719959
},
1994819960
{
@@ -19954,7 +19966,7 @@
1995419966
"section": "calibration",
1995519967
"anchor": "calibration-persistence",
1995619968
"page": "calibration.html",
19957-
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L755",
19969+
"source": "https://github.com/HydroModPy/HydroModPy/blob/main/hydromodpy/calibration/config.py#L762",
1995819970
"description": "Single switch governing every persistence sink (catalog, Zarr, Parquet, lockfile) for calibration outputs."
1995919971
},
1996019972
{

‎docs/source/_static/hydromodpy-openapi.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1740,6 +1740,13 @@
17401740
"type": "object",
17411741
"x-hmp-profile": "dev"
17421742
},
1743+
"overrides": {
1744+
"additionalProperties": true,
1745+
"description": "Configuration values this phase runs with, as dotted paths into the project configuration. The two stages of a stream-network calibration are one steady and one transient, which is a property of the model and not of the search, so a phase has to be able to say it.",
1746+
"title": "Overrides",
1747+
"type": "object",
1748+
"x-hmp-profile": "user"
1749+
},
17431750
"scoring_window": {
17441751
"anyOf": [
17451752
{

‎docs/source/_static/hydromodpy-schema.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1518,6 +1518,13 @@
15181518
"type": "object",
15191519
"x-hmp-profile": "dev"
15201520
},
1521+
"overrides": {
1522+
"additionalProperties": true,
1523+
"description": "Configuration values this phase runs with, as dotted paths into the project configuration. The two stages of a stream-network calibration are one steady and one transient, which is a property of the model and not of the search, so a phase has to be able to say it.",
1524+
"title": "Overrides",
1525+
"type": "object",
1526+
"x-hmp-profile": "user"
1527+
},
15211528
"scoring_window": {
15221529
"anyOf": [
15231530
{

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL