Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DataModules: improve error messages #1441

Merged
merged 6 commits into from
Jul 7, 2023
Merged

DataModules: improve error messages #1441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
02470ab
DataModules: better error messages
adamjstewart Jun 21, 2023
1c56293
Fix batch size bug
adamjstewart Jun 22, 2023
9fb4710
Fix type hints
adamjstewart Jun 22, 2023
2d947c2
Use in one additional place
adamjstewart Jun 22, 2023
694bf44
Fix BatchGeoSampler batch size
adamjstewart Jun 22, 2023
79bd605
Increase test coverage
adamjstewart Jun 22, 2023
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
76 changes: 69 additions & 7 deletions tests/datamodules/test_geo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@


class CustomGeoDataset(GeoDataset):
def __init__(self, split: str = "train", download: bool = False) -> None:
def __init__(
self, split: str = "train", length: int = 1, download: bool = False
) -> None:
super().__init__()
self.index.insert(0, (0, 1, 2, 3, 4, 5))
for i in range(length):
self.index.insert(i, (0, 1, 2, 3, 4, 5))
self.res = 1

def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
Expand Down Expand Up @@ -58,14 +61,16 @@ def setup(self, stage: str) -> None:


class CustomNonGeoDataset(NonGeoDataset):
def __init__(self, split: str = "train", download: bool = False) -> None:
pass
def __init__(
self, split: str = "train", length: int = 1, download: bool = False
) -> None:
self.length = length

def __getitem__(self, index: int) -> dict[str, Tensor]:
return {"image": torch.arange(3 * 2 * 2).view(3, 2, 2)}

def __len__(self) -> int:
return 1
return self.length

def plot(self, *args: Any, **kwargs: Any) -> plt.Figure:
return plt.figure()
Expand Down Expand Up @@ -134,7 +139,8 @@ def test_plot(self, datamodule: CustomGeoDataModule) -> None:

def test_no_datasets(self) -> None:
dm = CustomGeoDataModule()
msg = "CustomGeoDataModule.setup does not define a '{}_dataset'"
msg = r"CustomGeoDataModule\.setup must define one of "
msg += r"\('{0}_dataset', 'dataset'\)\."
with pytest.raises(MisconfigurationException, match=msg.format("train")):
dm.train_dataloader()
with pytest.raises(MisconfigurationException, match=msg.format("val")):
Expand All @@ -144,6 +150,48 @@ def test_no_datasets(self) -> None:
with pytest.raises(MisconfigurationException, match=msg.format("predict")):
dm.predict_dataloader()

def test_no_samplers(self) -> None:
dm = CustomGeoDataModule()
dm.dataset = CustomGeoDataset()
msg = r"CustomGeoDataModule\.setup must define one of "
msg += r"\('{0}_batch_sampler', '{0}_sampler', 'batch_sampler', 'sampler'\)\."
with pytest.raises(MisconfigurationException, match=msg.format("train")):
dm.train_dataloader()
with pytest.raises(MisconfigurationException, match=msg.format("val")):
dm.val_dataloader()
with pytest.raises(MisconfigurationException, match=msg.format("test")):
dm.test_dataloader()
with pytest.raises(MisconfigurationException, match=msg.format("predict")):
dm.predict_dataloader()

def test_zero_length_dataset(self) -> None:
dm = CustomGeoDataModule()
dm.dataset = CustomGeoDataset(length=0)
msg = r"CustomGeoDataModule\.dataset has length 0."
with pytest.raises(MisconfigurationException, match=msg):
dm.train_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.val_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.test_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.predict_dataloader()

def test_zero_length_sampler(self) -> None:
dm = CustomGeoDataModule()
dm.dataset = CustomGeoDataset()
dm.sampler = RandomGeoSampler(dm.dataset, 1, 1)
dm.sampler.length = 0
msg = r"CustomGeoDataModule\.sampler has length 0."
with pytest.raises(MisconfigurationException, match=msg):
dm.train_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.val_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.test_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.predict_dataloader()


class TestNonGeoDataModule:
@pytest.fixture
Expand Down Expand Up @@ -193,7 +241,8 @@ def test_plot(self, datamodule: CustomNonGeoDataModule) -> None:

def test_no_datasets(self) -> None:
dm = CustomNonGeoDataModule()
msg = "CustomNonGeoDataModule.setup does not define a '{}_dataset'"
msg = r"CustomNonGeoDataModule\.setup must define one of "
msg += r"\('{0}_dataset', 'dataset'\)\."
with pytest.raises(MisconfigurationException, match=msg.format("train")):
dm.train_dataloader()
with pytest.raises(MisconfigurationException, match=msg.format("val")):
Expand All @@ -202,3 +251,16 @@ def test_no_datasets(self) -> None:
dm.test_dataloader()
with pytest.raises(MisconfigurationException, match=msg.format("predict")):
dm.predict_dataloader()

def test_zero_length_dataset(self) -> None:
dm = CustomNonGeoDataModule()
dm.dataset = CustomNonGeoDataset(length=0)
msg = r"CustomNonGeoDataModule\.dataset has length 0."
with pytest.raises(MisconfigurationException, match=msg):
dm.train_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.val_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.test_dataloader()
with pytest.raises(MisconfigurationException, match=msg):
dm.predict_dataloader()
Loading