diff --git a/.github/workflows/mkdocs-build.yaml b/.github/workflows/mkdocs-build.yaml index 369f21f9c..665c88b06 100644 --- a/.github/workflows/mkdocs-build.yaml +++ b/.github/workflows/mkdocs-build.yaml @@ -35,6 +35,9 @@ jobs: run: | uv run mkdocs build --config-file mkdocs/mkdocs.yml --site-dir site + - name: Include new generated pages in the documentation diff + run: git add --intent-to-add mkdocs + - name: Check for changes id: changes run: | diff --git a/mkdocs/docs/packages/evo-blockmodels/typed-objects/report/ReportCell.md b/mkdocs/docs/packages/evo-blockmodels/typed-objects/report/ReportCell.md new file mode 100644 index 000000000..2d1e10d03 --- /dev/null +++ b/mkdocs/docs/packages/evo-blockmodels/typed-objects/report/ReportCell.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-blockmodels/src/evo/blockmodels/typed/report.py) +::: evo.blockmodels.typed.report.ReportCell + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-blockmodels/typed-objects/report/ReportCellStatus.md b/mkdocs/docs/packages/evo-blockmodels/typed-objects/report/ReportCellStatus.md new file mode 100644 index 000000000..4a5a6ec86 --- /dev/null +++ b/mkdocs/docs/packages/evo-blockmodels/typed-objects/report/ReportCellStatus.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-blockmodels/src/evo/blockmodels/typed/report.py) +::: evo.blockmodels.typed.report.ReportCellStatus + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationEstimator.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationEstimator.md new file mode 100644 index 000000000..7918855b3 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationEstimator.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationEstimator + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationOutputs.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationOutputs.md new file mode 100644 index 000000000..105952f13 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationOutputs.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationOutputs + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationParameters.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationParameters.md new file mode 100644 index 000000000..699fdf3cb --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationParameters.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationParameters + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationResult.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationResult.md new file mode 100644 index 000000000..5711f443a --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationResult.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationResult + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationResultModel.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationResultModel.md new file mode 100644 index 000000000..6e0a44478 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationResultModel.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationResultModel + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationRunner.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationRunner.md new file mode 100644 index 000000000..c2fdefd0a --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationRunner.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationRunner + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationSource.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationSource.md new file mode 100644 index 000000000..279bdc7f2 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationSource.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationSource + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationSourceResult.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationSourceResult.md new file mode 100644 index 000000000..642e68a87 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationSourceResult.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationSourceResult + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationStatistics.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationStatistics.md new file mode 100644 index 000000000..d8961ad66 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/CrossValidationStatistics.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationStatistics + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/IDWEstimator.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/IDWEstimator.md new file mode 100644 index 000000000..1bb10962e --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/IDWEstimator.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.IDWEstimator + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KNNEstimator.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KNNEstimator.md new file mode 100644 index 000000000..9e63d1c5f --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KNNEstimator.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.KNNEstimator + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KrigingCrossValidationStatistics.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KrigingCrossValidationStatistics.md new file mode 100644 index 000000000..a12d72822 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KrigingCrossValidationStatistics.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.KrigingCrossValidationStatistics + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KrigingEstimator.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KrigingEstimator.md new file mode 100644 index 000000000..6b904ae78 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/KrigingEstimator.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.KrigingEstimator + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/LeaveOneDrillholeOut.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/LeaveOneDrillholeOut.md new file mode 100644 index 000000000..ea0aeab8e --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/LeaveOneDrillholeOut.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.LeaveOneDrillholeOut + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/LeaveOneSampleOut.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/LeaveOneSampleOut.md new file mode 100644 index 000000000..ebe1faa77 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/LeaveOneSampleOut.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.LeaveOneSampleOut + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/ValidationStrategy.md b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/ValidationStrategy.md new file mode 100644 index 000000000..e4d9386b7 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/cross-validation/ValidationStrategy.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py) +::: evo.compute.tasks.geostatistics.cross_validation.ValidationStrategy + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingDiagnostics.md b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingDiagnostics.md new file mode 100644 index 000000000..06c2776ce --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingDiagnostics.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py) +::: evo.compute.tasks.geostatistics.kriging.KrigingDiagnostics + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingDiagnosticsResult.md b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingDiagnosticsResult.md new file mode 100644 index 000000000..26b10488f --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingDiagnosticsResult.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py) +::: evo.compute.tasks.geostatistics.kriging.KrigingDiagnosticsResult + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingTargetResult.md b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingTargetResult.md new file mode 100644 index 000000000..2eb2b8d34 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/KrigingTargetResult.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py) +::: evo.compute.tasks.geostatistics.kriging.KrigingTargetResult + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/kriging/RECOMMENDED_DIAGNOSTIC_NAMES.md b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/RECOMMENDED_DIAGNOSTIC_NAMES.md new file mode 100644 index 000000000..9626767c7 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/kriging/RECOMMENDED_DIAGNOSTIC_NAMES.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py) +::: evo.compute.tasks.geostatistics.kriging.RECOMMENDED_DIAGNOSTIC_NAMES + options: + show_labels: false diff --git a/mkdocs/docs/packages/evo-compute/typed-objects/source-target/attribute_spec.md b/mkdocs/docs/packages/evo-compute/typed-objects/source-target/attribute_spec.md new file mode 100644 index 000000000..c11a955f5 --- /dev/null +++ b/mkdocs/docs/packages/evo-compute/typed-objects/source-target/attribute_spec.md @@ -0,0 +1,4 @@ +[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/common/source_target.py) +::: evo.compute.tasks.common.source_target.attribute_spec + options: + show_labels: false diff --git a/mkdocs/site/packages/evo-blockmodels/typed-objects/report/ReportCell.html b/mkdocs/site/packages/evo-blockmodels/typed-objects/report/ReportCell.html new file mode 100644 index 000000000..f8c22d9cc --- /dev/null +++ b/mkdocs/site/packages/evo-blockmodels/typed-objects/report/ReportCell.html @@ -0,0 +1,213 @@ + + + + + + + + + + + ReportCell - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.blockmodels.typed.report.ReportCell + + +

+ + +
+ + + +

A single report/comparison cell: a numeric value plus a status.

+

The status explains why a value may be null (could not be aggregated/calculated). +See ReportCellStatus for the possible reasons.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ value + + +

+
value: Annotated[StrictInt | StrictFloat | None, Field(title='Value', examples=[2.7])]
+
+ +
+ +

Value of the cell. This is null whenever status is not OK.

+ +
+ +
+ +
+ + + +

+ status + + +

+
status: Annotated[ReportCellStatus, Field(examples=['OK'])] = OK
+
+ +
+ +

Status of the cell, describing how value should be interpreted.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-blockmodels/typed-objects/report/ReportCellStatus.html b/mkdocs/site/packages/evo-blockmodels/typed-objects/report/ReportCellStatus.html new file mode 100644 index 000000000..7012f3ec8 --- /dev/null +++ b/mkdocs/site/packages/evo-blockmodels/typed-objects/report/ReportCellStatus.html @@ -0,0 +1,199 @@ + + + + + + + + + + + ReportCellStatus - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.blockmodels.typed.report.ReportCellStatus + + +

+ + +
+ + + +

Status of a single report cell, describing how its value should be interpreted.

+
    +
  • OK: the value was calculated normally and can be used as-is.
  • +
  • PERCENT_CHANGE_FROM_ZERO: the percentage change is undefined because the + from value was zero. Only used in comparisons.
  • +
  • NO_DATA: no data was available to calculate the value.
  • +
  • INVALID: the value could not be calculated because the underlying data + contained an invalid value.
  • +
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ PERCENT_CHANGE_FROM_ZERO + + +

+
PERCENT_CHANGE_FROM_ZERO = 'PERCENT_CHANGE_FROM_ZERO'
+
+ +
+ +

Only used in comparisons.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/continuous-distribution/UpperTail.html b/mkdocs/site/packages/evo-compute/typed-objects/continuous-distribution/UpperTail.html index 13f4e3ad3..8fcdcbacf 100644 --- a/mkdocs/site/packages/evo-compute/typed-objects/continuous-distribution/UpperTail.html +++ b/mkdocs/site/packages/evo-compute/typed-objects/continuous-distribution/UpperTail.html @@ -39,7 +39,7 @@ diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationEstimator.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationEstimator.html new file mode 100644 index 000000000..903442ebb --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationEstimator.html @@ -0,0 +1,147 @@ + + + + + + + + + + + CrossValidationEstimator - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationEstimator + + +

+
CrossValidationEstimator: TypeAlias = Annotated[
+    KrigingEstimator | KNNEstimator | IDWEstimator, Field(discriminator="type")
+]
+
+ +
+ +

Tagged union of supported cross-validation estimators.

+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationOutputs.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationOutputs.html new file mode 100644 index 000000000..20b0d448b --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationOutputs.html @@ -0,0 +1,228 @@ + + + + + + + + + + + CrossValidationOutputs - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationOutputs + + +

+ + +
+ + + +

Per-sample attributes written back onto the source object.

+

Both estimate and error accept:

+
    +
  • a str — create a new attribute with that name.
  • +
  • a typed attribute from the source object — update it if it already exists + (must be a floating-point attribute), otherwise create it.
  • +
  • a :class:~evo.compute.tasks.common.CreateAttribute or + :class:~evo.compute.tasks.common.UpdateAttribute for explicit control.
  • +
+

Samples that produced no valid estimate carry NaN in the written +estimate and error attributes. The error attribute stores the +signed error estimate - true, so a positive value is an overestimate.

+

Example::

+
>>> outputs = CrossValidationOutputs(
+...     estimate="cv_estimate",
+...     error="cv_error",
+... )
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ estimate + + +

+
estimate: Annotated[CreateAttribute | UpdateAttribute, Field(discriminator='operation')]
+
+ +
+ +

Attribute to create or update on the source object with each sample's cross-validated estimate.

+ +
+ +
+ +
+ + + +

+ error + + +

+
error: Annotated[CreateAttribute | UpdateAttribute, Field(discriminator='operation')] | None = None
+
+ +
+ +

Optional attribute to create or update with the signed error (estimate - true).

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationParameters.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationParameters.html new file mode 100644 index 000000000..5175c61c8 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationParameters.html @@ -0,0 +1,300 @@ + + + + + + + + + + + CrossValidationParameters - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationParameters + + +

+ + +
+ + + +

Parameters for the geostatistics/cross-validation compute task.

+

Example::

+
>>> from evo.compute.tasks import Filter, FilterCondition, KrigingDiagnostics, SearchNeighborhood, run
+>>> from evo.compute.tasks.geostatistics.cross_validation import (
+...     CrossValidationOutputs,
+...     CrossValidationParameters,
+...     KrigingEstimator,
+...     LeaveOneSampleOut,
+... )
+>>>
+>>> params = CrossValidationParameters(
+...     source=pointset.attributes["Cu_pct"],
+...     source_filter=Filter(
+...         where=FilterCondition(
+...             attribute=pointset.attributes["domain"],
+...             operator="in",
+...             values=["Early Diorite"],
+...         ),
+...     ),
+...     validation=LeaveOneSampleOut(),
+...     estimator=KrigingEstimator(
+...         variogram=variogram,
+...         neighborhood=SearchNeighborhood(ellipsoid=ellipsoid, max_samples=24),
+...         diagnostics=KrigingDiagnostics(kriging_variance=True, slope_of_regression=True),
+...     ),
+...     outputs=CrossValidationOutputs(estimate="Cu_cv_est", error="Cu_cv_err"),
+... )
+>>> result = await run(manager, params, preview=True)
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ source + + +

+
source: Annotated[CrossValidationSource, BeforeValidator(_convert_cross_validation_source)]
+
+ +
+ +

Source object and attribute containing the known sample values to cross-validate.

+ +
+ +
+ +
+ + + +

+ validation + + +

+
validation: ValidationStrategy
+
+ +
+ +

Hold-out strategy (:class:LeaveOneSampleOut or :class:LeaveOneDrillholeOut).

+ +
+ +
+ +
+ + + +

+ estimator + + +

+
estimator: CrossValidationEstimator
+
+ +
+ +

Estimator configuration (:class:KrigingEstimator, :class:KNNEstimator, or :class:IDWEstimator).

+ +
+ +
+ +
+ + + +

+ outputs + + +

+
outputs: CrossValidationOutputs
+
+ +
+ +

Per-sample output attributes to write back onto the source object.

+ +
+ +
+ +
+ + + +

+ source_filter + + +

+
source_filter: Filter | None = Field(None, exclude=True)
+
+ +
+ +

Optional filter restricting cross-validation to a subset of the source samples.

+

Excluded from top-level serialization and injected into source["filter"].

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationResult.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationResult.html new file mode 100644 index 000000000..d93b5397f --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationResult.html @@ -0,0 +1,461 @@ + + + + + + + + + + + CrossValidationResult - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationResult + + +

+ + +
+ + + +

Rich result object for the cross-validation task.

+

Provides typed access to the updated source object, output attributes, +kriging diagnostics, common summary statistics, and kriging-only +standardized error statistics.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ message + + +

+
message: str
+
+ +
+ +

A message describing what happened in the task.

+ +
+ +
+ +
+ + + +

+ source + + +

+
source: CrossValidationSourceResult
+
+ +
+ +

Metadata and written attribute references for the updated source object.

+ +
+ +
+ +
+ + + +

+ source_name + + +

+
source_name: str
+
+ +
+ +

The name of the source object updated with cross-validation attributes.

+ +
+ +
+ +
+ + + +

+ source_reference + + +

+
source_reference: str
+
+ +
+ +

Reference URL to the updated source object.

+ +
+ +
+ +
+ + + +

+ estimate_attribute + + +

+
estimate_attribute: TaskAttribute
+
+ +
+ +

The attribute containing each sample's cross-validated estimate.

+ +
+ +
+ +
+ + + +

+ estimate_name + + +

+
estimate_name: str
+
+ +
+ +

The name of the attribute containing each sample's cross-validated estimate.

+ +
+ +
+ +
+ + + +

+ error_attribute + + +

+
error_attribute: TaskAttribute | None
+
+ +
+ +

The attribute containing each sample's signed error, or None if not requested.

+ +
+ +
+ +
+ + + +

+ error_name + + +

+
error_name: str | None
+
+ +
+ +

The name of the signed-error attribute, or None if not requested.

+ +
+ +
+ +
+ + + +

+ diagnostics + + +

+
diagnostics: dict[str, TaskAttribute]
+
+ +
+ +

The kriging diagnostic attributes that were written, keyed by diagnostic name.

+

Empty when no diagnostics were requested or when the estimator is KNN or IDW.

+ +
+ +
+ +
+ + + +

+ statistics + + +

+
statistics: CrossValidationStatistics
+
+ +
+ +

Summary statistics comparing held-out true values with their estimates.

+ +
+ +
+ +
+ + + +

+ kriging_statistics + + +

+
kriging_statistics: KrigingCrossValidationStatistics | None
+
+ +
+ +

Kriging standardized error statistics, or None for KNN and IDW.

+ +
+ +
+ +
+ + + +

+ schema + + +

+
schema: ObjectSchema
+
+ +
+ +

The schema type of the source object (e.g., 'pointset' or 'downhole-intervals').

+ +
+ +
+ + + + +
+ + +

+ get_source_object + + +

+
get_source_object() -> BaseObject
+
+ +
+ +

Load and return the updated source geoscience object.

+ + +
+ +
+ +
+ + +

+ to_dataframe + + +

+
to_dataframe(*columns: str) -> pd.DataFrame
+
+ +
+ +

Load the updated source object and return its data as a DataFrame.

+

Args: + *columns: Optional column names to select. If omitted, returns all columns.

+

Returns: + A pandas DataFrame containing the source data and written cross-validation attributes.

+

Raises: + TypeError: If the source object type does not support DataFrame export.

+ + +
+ +
+ + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationResultModel.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationResultModel.html new file mode 100644 index 000000000..645b8c397 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationResultModel.html @@ -0,0 +1,251 @@ + + + + + + + + + + + CrossValidationResultModel - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationResultModel + + +

+ + +
+ + + +

Pydantic model for the raw cross-validation task result payload.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ message + + +

+
message: str
+
+ +
+ +

A message describing what happened in the task.

+ +
+ +
+ +
+ + + +

+ source + + +

+
source: CrossValidationSourceResult
+
+ +
+ +

The source object updated with the cross-validation output attributes.

+ +
+ +
+ +
+ + + +

+ statistics + + +

+
statistics: CrossValidationStatistics
+
+ +
+ +

Summary statistics comparing held-out true values with their estimates.

+ +
+ +
+ +
+ + + +

+ kriging_statistics + + +

+
kriging_statistics: KrigingCrossValidationStatistics | None = None
+
+ +
+ +

Standardized kriging statistics (present for kriging only; None for KNN and IDW).

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationRunner.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationRunner.html new file mode 100644 index 000000000..c4052804f --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationRunner.html @@ -0,0 +1,175 @@ + + + + + + + + + + + CrossValidationRunner - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationRunner + + +

+ + +
+ + + +

Runner for cross-validation compute tasks.

+

Automatically registered — used by :func:~evo.compute.tasks.run for +dispatch, or directly::

+
result = await CrossValidationRunner(context, params, preview=True)
+
+ + + + + + + + + + + +
+ + + + + + + + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationSource.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationSource.html new file mode 100644 index 000000000..d11b7d3f8 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationSource.html @@ -0,0 +1,194 @@ + + + + + + + + + + + CrossValidationSource - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationSource + + +

+ + +
+ + + +

The samples to cross-validate and the attribute holding their known values.

+

Can be constructed explicitly or converted automatically from a typed +attribute such as pointset.attributes["grade"] or +downhole_intervals.attributes["grade"].

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ filter + + +

+
filter: Filter | None = None
+
+ +
+ +

Optional filter restricting which source locations are cross-validated and used as neighbours.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationSourceResult.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationSourceResult.html new file mode 100644 index 000000000..ac9b95c7b --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationSourceResult.html @@ -0,0 +1,311 @@ + + + + + + + + + + + CrossValidationSourceResult - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationSourceResult + + +

+ + +
+ + + +

The source object updated with the per-sample cross-validation attributes.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ reference + + +

+
reference: str
+
+ +
+ +

Reference URL to the updated source geoscience object.

+ +
+ +
+ +
+ + + +

+ name + + +

+
name: str
+
+ +
+ +

Name of the source geoscience object.

+ +
+ +
+ +
+ + + +

+ description + + +

+
description: str | None = None
+
+ +
+ +

Optional description of the source geoscience object.

+ +
+ +
+ +
+ + + +

+ schema_id + + +

+
schema_id: str
+
+ +
+ +

Schema identifier of the source geoscience object.

+ +
+ +
+ +
+ + + +

+ estimate + + +

+
estimate: TaskAttribute
+
+ +
+ +

Attribute written with each sample's cross-validated estimate.

+ +
+ +
+ +
+ + + +

+ error + + +

+
error: TaskAttribute | None = None
+
+ +
+ +

Attribute written with each sample's signed error, when requested.

+ +
+ +
+ +
+ + + +

+ diagnostics + + +

+
diagnostics: KrigingDiagnosticsResult | None = None
+
+ +
+ +

Kriging diagnostic attributes written alongside the estimate, when requested.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationStatistics.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationStatistics.html new file mode 100644 index 000000000..53e636b28 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/CrossValidationStatistics.html @@ -0,0 +1,477 @@ + + + + + + + + + + + CrossValidationStatistics - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.CrossValidationStatistics + + +

+ + +
+ + + +

Summary statistics comparing held-out true values with their estimates.

+

Statistics are computed over samples that produced a valid estimate +(valid_count). Samples without a valid estimate are counted in +invalid_count, carry NaN in the written attributes, and are excluded +from the summary statistics. Any statistic that is undefined for the +available valid samples (such as correlation when fewer than two samples +are valid or variance is zero) is None.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ evaluated_count + + +

+
evaluated_count: int
+
+ +
+ +

Number of samples cross-validated after applying any source filter.

+ +
+ +
+ +
+ + + +

+ valid_count + + +

+
valid_count: int
+
+ +
+ +

Number of cross-validated samples that produced a finite estimate.

+ +
+ +
+ +
+ + + +

+ invalid_count + + +

+
invalid_count: int
+
+ +
+ +

Number of cross-validated samples that produced no estimate.

+ +
+ +
+ +
+ + + +

+ mean_true + + +

+
mean_true: float | None
+
+ +
+ +

Mean of the held-out true values over the valid samples.

+ +
+ +
+ +
+ + + +

+ mean_estimate + + +

+
mean_estimate: float | None
+
+ +
+ +

Mean of the cross-validated estimates over the valid samples.

+ +
+ +
+ +
+ + + +

+ variance_true + + +

+
variance_true: float | None
+
+ +
+ +

Population variance of the held-out true values over the valid samples.

+ +
+ +
+ +
+ + + +

+ variance_estimate + + +

+
variance_estimate: float | None
+
+ +
+ +

Population variance of the cross-validated estimates over the valid samples.

+ +
+ +
+ +
+ + + +

+ mean_error + + +

+
mean_error: float | None
+
+ +
+ +

Mean of estimate - true. Positive values indicate overestimation bias.

+ +
+ +
+ +
+ + + +

+ mean_absolute_error + + +

+
mean_absolute_error: float | None
+
+ +
+ +

Mean of |estimate - true|.

+ +
+ +
+ +
+ + + +

+ mean_squared_error + + +

+
mean_squared_error: float | None
+
+ +
+ +

Mean of (estimate - true) ** 2.

+ +
+ +
+ +
+ + + +

+ root_mean_squared_error + + +

+
root_mean_squared_error: float | None
+
+ +
+ +

Square root of mean_squared_error, in the units of the estimated attribute.

+ +
+ +
+ +
+ + + +

+ error_variance + + +

+
error_variance: float | None
+
+ +
+ +

Population variance of estimate - true.

+ +
+ +
+ +
+ + + +

+ correlation + + +

+
correlation: float | None
+
+ +
+ +

Pearson correlation coefficient between true values and estimates, or None when undefined.

+ +
+ +
+ +
+ + + +

+ regression_slope + + +

+
regression_slope: float | None
+
+ +
+ +

Slope of true values regressed on estimates, or None when undefined.

+ +
+ +
+ +
+ + + +

+ regression_intercept + + +

+
regression_intercept: float | None
+
+ +
+ +

Intercept of true values regressed on estimates, or None when regression_slope is None.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/IDWEstimator.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/IDWEstimator.html new file mode 100644 index 000000000..d92a1ae86 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/IDWEstimator.html @@ -0,0 +1,257 @@ + + + + + + + + + + + IDWEstimator - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.IDWEstimator + + +

+ + +
+ + + +

Re-estimate held-out locations using inverse-distance weighting.

+

Example::

+
>>> estimator = IDWEstimator(
+...     neighborhood=SearchNeighborhood(ellipsoid=ellipsoid, max_samples=20),
+...     power=2.0,
+... )
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ type + + +

+
type: Literal['idw'] = 'idw'
+
+ +
+ +

Discriminator selecting the inverse-distance-weighting estimator.

+ +
+ +
+ +
+ + + +

+ neighborhood + + +

+
neighborhood: _CrossValidationNeighborhood = Field(validation_alias=AliasChoices('neighborhood', 'search'))
+
+ +
+ +

Search neighborhood deciding which remaining samples estimate each held-out location.

+ +
+ +
+ +
+ + + +

+ power + + +

+
power: float = Field(gt=0.0, allow_inf_nan=False)
+
+ +
+ +

Distance-weighting exponent (must be strictly positive, e.g. 1.0 or 2.0).

+ +
+ +
+ +
+ + + +

+ search + + +

+
search: SearchNeighborhood
+
+ +
+ +

Backwards-compatible alias for :attr:neighborhood.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KNNEstimator.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KNNEstimator.html new file mode 100644 index 000000000..3addcec54 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KNNEstimator.html @@ -0,0 +1,236 @@ + + + + + + + + + + + KNNEstimator - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.KNNEstimator + + +

+ + +
+ + + +

Re-estimate held-out locations with the arithmetic mean of their nearest neighbours.

+

Example::

+
>>> estimator = KNNEstimator(
+...     neighborhood=SearchNeighborhood(ellipsoid=ellipsoid, max_samples=12),
+... )
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ type + + +

+
type: Literal['knn'] = 'knn'
+
+ +
+ +

Discriminator selecting the k-nearest-neighbour estimator.

+ +
+ +
+ +
+ + + +

+ neighborhood + + +

+
neighborhood: _CrossValidationNeighborhood = Field(validation_alias=AliasChoices('neighborhood', 'search'))
+
+ +
+ +

Search neighborhood deciding which remaining samples estimate each held-out location.

+ +
+ +
+ +
+ + + +

+ search + + +

+
search: SearchNeighborhood
+
+ +
+ +

Backwards-compatible alias for :attr:neighborhood.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KrigingCrossValidationStatistics.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KrigingCrossValidationStatistics.html new file mode 100644 index 000000000..dde158748 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KrigingCrossValidationStatistics.html @@ -0,0 +1,253 @@ + + + + + + + + + + + KrigingCrossValidationStatistics - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.KrigingCrossValidationStatistics + + +

+ + +
+ + + +

Standardized error summary statistics returned for kriging cross-validation only.

+

Computed over valid samples that also have a positive kriging variance +(standardized_count). Absent (None on the result) for KNN and IDW.

+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ standardized_count + + +

+
standardized_count: int
+
+ +
+ +

Number of valid samples with a positive kriging variance.

+ +
+ +
+ +
+ + + +

+ mean_kriging_variance + + +

+
mean_kriging_variance: float | None
+
+ +
+ +

Mean kriging variance over the standardized samples, or None when standardized_count == 0.

+ +
+ +
+ +
+ + + +

+ mean_standardized_error + + +

+
mean_standardized_error: float | None
+
+ +
+ +

Mean of (estimate - true) / sqrt(kriging_variance), or None when standardized_count == 0.

+ +
+ +
+ +
+ + + +

+ standardized_error_variance + + +

+
standardized_error_variance: float | None
+
+ +
+ +

Population variance of the standardized error, or None when standardized_count == 0.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KrigingEstimator.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KrigingEstimator.html new file mode 100644 index 000000000..e8836eb30 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/KrigingEstimator.html @@ -0,0 +1,327 @@ + + + + + + + + + + + KrigingEstimator - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.KrigingEstimator + + +

+ + +
+ + + +

Re-estimate held-out locations using simple or ordinary kriging.

+

Carries the variogram, kriging method, search neighborhood, and optional +per-sample :class:~evo.compute.tasks.geostatistics.kriging.KrigingDiagnostics +written onto the source object alongside the cross-validated estimate.

+

Example::

+
>>> from evo.compute.tasks import KrigingDiagnostics, SearchNeighborhood
+>>> from evo.compute.tasks.geostatistics.kriging import KrigingMethod
+>>>
+>>> estimator = KrigingEstimator(
+...     variogram=variogram,
+...     neighborhood=SearchNeighborhood(ellipsoid=ellipsoid, max_samples=20),
+...     kriging_method=KrigingMethod.ORDINARY,
+...     diagnostics=KrigingDiagnostics(kriging_variance=True, num_samples=True),
+... )
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ type + + +

+
type: Literal['kriging'] = 'kriging'
+
+ +
+ +

Discriminator selecting the kriging estimator.

+ +
+ +
+ +
+ + + +

+ variogram + + +

+
variogram: GeoscienceObjectReference
+
+ +
+ +

Model of the covariance within the domain (Variogram object or reference URL).

+ +
+ +
+ +
+ + + +

+ neighborhood + + +

+
neighborhood: _CrossValidationNeighborhood = Field(validation_alias=AliasChoices('neighborhood', 'search'))
+
+ +
+ +

Search neighborhood deciding which remaining samples estimate each held-out location.

+ +
+ +
+ +
+ + + +

+ kriging_method + + +

+
kriging_method: Annotated[SimpleKriging | OrdinaryKriging, Field(discriminator="type")] = Field(
+    default_factory=OrdinaryKriging, validation_alias=AliasChoices("kriging_method", "method")
+)
+
+ +
+ +

The kriging method to use. Defaults to ordinary kriging.

+ +
+ +
+ +
+ + + +

+ diagnostics + + +

+
diagnostics: KrigingDiagnostics | None = None
+
+ +
+ +

Optional per-sample kriging diagnostic attributes to write onto the source object.

+ +
+ +
+ +
+ + + +

+ search + + +

+
search: SearchNeighborhood
+
+ +
+ +

Backwards-compatible alias for :attr:neighborhood.

+ +
+ +
+ +
+ + + +

+ method + + +

+
method: SimpleKriging | OrdinaryKriging
+
+ +
+ +

Backwards-compatible alias for :attr:kriging_method.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/LeaveOneDrillholeOut.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/LeaveOneDrillholeOut.html new file mode 100644 index 000000000..53ee2d979 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/LeaveOneDrillholeOut.html @@ -0,0 +1,198 @@ + + + + + + + + + + + LeaveOneDrillholeOut - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.LeaveOneDrillholeOut + + +

+ + +
+ + + +

Hold out one drillhole at a time, estimating its samples from the remaining holes.

+

Requires a :class:~evo.objects.typed.DownholeIntervals source object to +supply drillhole IDs. Each query excludes every sample sharing its drillhole +ID before neighbour quotas are applied, while keeping samples from other +holes eligible.

+

Example::

+
>>> validation = LeaveOneDrillholeOut()
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ type + + +

+
type: Literal['drillhole'] = 'drillhole'
+
+ +
+ +

Discriminator selecting leave-one-drillhole-out validation.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/LeaveOneSampleOut.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/LeaveOneSampleOut.html new file mode 100644 index 000000000..5622d6ace --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/LeaveOneSampleOut.html @@ -0,0 +1,197 @@ + + + + + + + + + + + LeaveOneSampleOut - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.LeaveOneSampleOut + + +

+ + +
+ + + +

Hold out each sample and any samples coincident with its location.

+

Estimates every selected sample in one pass, excluding the sample's own +location (including coincident samples strictly closer than 1e-8 world +units) before applying neighbour quotas.

+

Example::

+
>>> validation = LeaveOneSampleOut()
+
+ + + + + + + + + + + +
+ + + + + + + +
+ + + +

+ type + + +

+
type: Literal['sample'] = 'sample'
+
+ +
+ +

Discriminator selecting leave-one-sample-out validation.

+ +
+ +
+ + + + + + +
+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/ValidationStrategy.html b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/ValidationStrategy.html new file mode 100644 index 000000000..31792f497 --- /dev/null +++ b/mkdocs/site/packages/evo-compute/typed-objects/cross-validation/ValidationStrategy.html @@ -0,0 +1,145 @@ + + + + + + + + + + + ValidationStrategy - Evo Python SDK + + + + + + + + + + + + + + +
+
+
+
+ +

GitHub source +

+ + +
+ + + +

+ evo.compute.tasks.geostatistics.cross_validation.ValidationStrategy + + +

+
ValidationStrategy: TypeAlias = Annotated[LeaveOneSampleOut | LeaveOneDrillholeOut, Field(discriminator='type')]
+
+ +
+ +

Tagged union of supported cross-validation hold-out strategies.

+ +
+ +
+
+
+ + + + + + diff --git a/mkdocs/site/packages/evo-compute/typed-objects/declustering/DeclusteringParameters.html b/mkdocs/site/packages/evo-compute/typed-objects/declustering/DeclusteringParameters.html index 151553591..a4de9dfde 100644 --- a/mkdocs/site/packages/evo-compute/typed-objects/declustering/DeclusteringParameters.html +++ b/mkdocs/site/packages/evo-compute/typed-objects/declustering/DeclusteringParameters.html @@ -34,7 +34,7 @@