Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples" class="d


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples</span><span class="p">:</span> <span class="nb">int</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand All @@ -183,12 +183,13 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.min_samples" class="d


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">min_samples</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">min_samples</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The minimum number of samples required. If fewer are found, the point may be skipped.</p>
<p>The minimum number of samples required, between 1 and <code>max_samples</code>.</p>
<p>If fewer are found, the point may be skipped.</p>

</div>

Expand Down
2 changes: 1 addition & 1 deletion packages/evo-compute/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "evo-compute"
version = "0.0.6"
version = "0.0.7"
requires-python = ">=3.10"
license-files = ["LICENSE.md"]
dynamic = ["readme"]
Expand Down
19 changes: 15 additions & 4 deletions packages/evo-compute/src/evo/compute/tasks/common/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from typing import Any

from evo.objects.typed.types import Ellipsoid
from pydantic import BaseModel, Field, model_serializer
from pydantic import BaseModel, Field, model_serializer, model_validator

__all__ = [
"SearchNeighborhood",
Expand Down Expand Up @@ -70,11 +70,14 @@ class SearchNeighborhood(BaseModel):
ellipsoid: Ellipsoid
"""The ellipsoid defining the spatial extent to search for samples."""

max_samples: int
max_samples: int = Field(ge=1)
"""The maximum number of samples to use for each evaluation point."""

min_samples: int | None = None
"""The minimum number of samples required. If fewer are found, the point may be skipped."""
min_samples: int | None = Field(None, ge=1)
"""The minimum number of samples required, between 1 and ``max_samples``.

If fewer are found, the point may be skipped.
"""

max_empty_octants: int | None = Field(None, ge=0, le=8)
"""The maximum number of empty octants (sectors) allowed when searching for samples.
Expand All @@ -100,6 +103,14 @@ class SearchNeighborhood(BaseModel):
max_drillholes_per_estimate: int | None = Field(None, ge=1)
"""The maximum number of drillholes used in each estimate. Requires a downhole intervals source object."""

@model_validator(mode="after")
def _check_sample_limits(self) -> SearchNeighborhood:
if self.min_samples is not None and self.min_samples > self.max_samples:
raise ValueError(
f"min_samples must be between 1 and max_samples ({self.max_samples}), got {self.min_samples}."
)
return self

@model_serializer
def _serialize(self) -> dict[str, Any]:
result = {
Expand Down
26 changes: 26 additions & 0 deletions packages/evo-compute/tests/geostatistics/test_idw_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,32 @@ def test_search_limits_in_neighborhood(self):
self.assertEqual(d["neighborhood"]["max_empty_quadrants"], 1)
self.assertEqual(d["neighborhood"]["max_drillholes_per_estimate"], 4)

def test_sample_limit_boundaries_in_neighborhood(self):
ellipsoid = Ellipsoid(ranges=EllipsoidRanges(major=200, semi_major=150, minor=100))
d = _dump(_params(neighborhood={"ellipsoid": ellipsoid, "max_samples": 1}))
self.assertEqual(d["neighborhood"]["max_samples"], 1)
self.assertNotIn("min_samples", d["neighborhood"])

for max_samples, min_samples in [(1, 1), (20, 1), (20, 20)]:
with self.subTest(max_samples=max_samples, min_samples=min_samples):
d = _dump(
_params(
neighborhood={"ellipsoid": ellipsoid, "max_samples": max_samples, "min_samples": min_samples}
)
)
self.assertEqual(d["neighborhood"]["max_samples"], max_samples)
self.assertEqual(d["neighborhood"]["min_samples"], min_samples)

def test_invalid_sample_limits_rejected(self):
ellipsoid = Ellipsoid(ranges=EllipsoidRanges(major=200, semi_major=150, minor=100))
for limits in [
{"max_samples": 0},
{"max_samples": 20, "min_samples": 0},
{"max_samples": 20, "min_samples": 21},
]:
with self.subTest(**limits), self.assertRaises(ValidationError):
_params(neighborhood={"ellipsoid": ellipsoid, **limits})


# ---------------------------------------------------------------------------
# Result handling
Expand Down
28 changes: 28 additions & 0 deletions packages/evo-compute/tests/geostatistics/test_knn_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
import unittest
from unittest.mock import AsyncMock, MagicMock, patch

from pydantic import ValidationError

from evo.compute.tasks import SearchNeighborhood
from evo.compute.tasks.common import (
Ellipsoid,
Expand Down Expand Up @@ -133,6 +135,32 @@ def test_search_limits_in_neighborhood(self):
self.assertEqual(d["neighborhood"]["max_empty_octants"], 2)
self.assertEqual(d["neighborhood"]["max_samples_per_quadrant"], 5)

def test_sample_limit_boundaries_in_neighborhood(self):
ellipsoid = Ellipsoid(ranges=EllipsoidRanges(major=200, semi_major=150, minor=100))
d = _dump(_params(neighborhood={"ellipsoid": ellipsoid, "max_samples": 1}))
self.assertEqual(d["neighborhood"]["max_samples"], 1)
self.assertNotIn("min_samples", d["neighborhood"])

for max_samples, min_samples in [(1, 1), (20, 1), (20, 20)]:
with self.subTest(max_samples=max_samples, min_samples=min_samples):
d = _dump(
_params(
neighborhood={"ellipsoid": ellipsoid, "max_samples": max_samples, "min_samples": min_samples}
)
)
self.assertEqual(d["neighborhood"]["max_samples"], max_samples)
self.assertEqual(d["neighborhood"]["min_samples"], min_samples)

def test_invalid_sample_limits_rejected(self):
ellipsoid = Ellipsoid(ranges=EllipsoidRanges(major=200, semi_major=150, minor=100))
for limits in [
{"max_samples": 0},
{"max_samples": 20, "min_samples": 0},
{"max_samples": 20, "min_samples": 21},
]:
with self.subTest(**limits), self.assertRaises(ValidationError):
_params(neighborhood={"ellipsoid": ellipsoid, **limits})

def test_new_attribute_target(self):
d = _dump(_params(target=Target.new_attribute(GRID_URL, "result")))
self.assertEqual(d["target"]["attribute"]["operation"], "create")
Expand Down
32 changes: 32 additions & 0 deletions packages/evo-compute/tests/geostatistics/test_kriging_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -1189,3 +1189,35 @@ def test_can_construct_with_alias_neighborhood(self):
neighborhood=search,
)
self.assertIsNotNone(params.search)

def test_sample_limit_boundaries_in_neighborhood(self):
ellipsoid = Ellipsoid(ranges=EllipsoidRanges(major=100, semi_major=100, minor=50))
default_min = self._make_params(search={"ellipsoid": ellipsoid, "max_samples": 1}).model_dump(
mode="json", by_alias=True, exclude_none=True
)
self.assertEqual(default_min["neighborhood"]["max_samples"], 1)
self.assertNotIn("min_samples", default_min["neighborhood"])

for max_samples, min_samples in [(1, 1), (20, 1), (20, 20)]:
with self.subTest(max_samples=max_samples, min_samples=min_samples):
dumped = self._make_params(
search={"ellipsoid": ellipsoid, "max_samples": max_samples, "min_samples": min_samples}
).model_dump(mode="json", by_alias=True, exclude_none=True)
self.assertEqual(dumped["neighborhood"]["max_samples"], max_samples)
self.assertEqual(dumped["neighborhood"]["min_samples"], min_samples)

def test_invalid_sample_limits_rejected(self):
ellipsoid = Ellipsoid(ranges=EllipsoidRanges(major=100, semi_major=100, minor=50))
for field_name in ("search", "neighborhood"):
for limits in [
{"max_samples": 0},
{"max_samples": 20, "min_samples": 0},
{"max_samples": 20, "min_samples": 21},
]:
with self.subTest(field=field_name, **limits), self.assertRaises(ValidationError):
KrigingParameters(
source=Source(object=POINTSET_URL, attribute="grade"),
target=Target.new_attribute(GRID_URL, "kriged_grade"),
variogram=VARIOGRAM_URL,
**{field_name: {"ellipsoid": ellipsoid, **limits}},
)
33 changes: 29 additions & 4 deletions packages/evo-compute/tests/test_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ def test_raises_for_invalid_url(self):


class TestSearchNeighborhood(unittest.TestCase):
"""Tests for the octant, quadrant and drillhole limits on SearchNeighborhood."""
"""Tests for sample, octant, quadrant and drillhole limits on SearchNeighborhood."""

LIMITS = {
"max_empty_octants": 4,
Expand All @@ -319,15 +319,40 @@ class TestSearchNeighborhood(unittest.TestCase):
"max_drillholes_per_estimate": 6,
}

def _search(self, **limits) -> SearchNeighborhood:
def _search(self, max_samples: int = 24, **limits) -> SearchNeighborhood:
return SearchNeighborhood(
ellipsoid=Ellipsoid(ranges=EllipsoidRanges(major=200, semi_major=150, minor=100)),
max_samples=24,
max_samples=max_samples,
**limits,
)

def test_limits_are_omitted_unless_set(self):
self.assertEqual(set(self._search().model_dump(mode="json")), {"ellipsoid", "max_samples"})
search = self._search()
self.assertIsNone(search.min_samples)
self.assertEqual(set(search.model_dump(mode="json")), {"ellipsoid", "max_samples"})

def test_sample_limit_boundaries_are_accepted(self):
single = self._search(max_samples=1).model_dump(mode="json")
self.assertEqual(single["max_samples"], 1)
self.assertNotIn("min_samples", single)

for max_samples, min_samples in [(1, 1), (20, 1), (20, 20)]:
with self.subTest(max_samples=max_samples, min_samples=min_samples):
dumped = self._search(max_samples=max_samples, min_samples=min_samples).model_dump(mode="json")
self.assertEqual(dumped["max_samples"], max_samples)
self.assertEqual(dumped["min_samples"], min_samples)

def test_invalid_sample_limits_are_refused(self):
for kwargs in [
{"max_samples": 0},
{"max_samples": -1},
{"max_samples": 20, "min_samples": 0},
{"max_samples": 20, "min_samples": -1},
{"max_samples": 20, "min_samples": 21},
{"max_samples": 1, "min_samples": 2},
]:
with self.subTest(**kwargs), self.assertRaises(ValidationError):
self._search(**kwargs)

def test_limits_are_sent_when_set(self):
dumped = self._search(**self.LIMITS).model_dump(mode="json")
Expand Down
4 changes: 2 additions & 2 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading