Merge pull request #55 from SFI-Visual-Intelligence/mag-branch

Dataloader and Main file

Author: Seilmast

.gitignore

@@ -1,11 +1,11 @@
 __pycache__/
 .ipynb_checkpoints/
-Data/
-Results/
-Experiments/
+Data/*
+Results/*
+Experiments/*
 _build/
-bin/
-wandb/
+bin/*
+wandb/*
 wandb_api.py
 
 #Magnus specific

utils/dataloaders/svhn.py

@@ -1,12 +1,66 @@
 from torch.utils.data import Dataset
+from scipy.io import loadmat
+import os 
+from torchvision.datasets import SVHN
 
-
-class SVHN(Dataset):
-    def __init__(self):
+class SVHNDataset(Dataset):
+    def __init__(self,
+                 datapath: str,
+                 transforms=None,
+                 download_data=True,
+                 split='train'):
+        """
+        Initializes the SVHNDataset object.
+        Args:
+            datapath (str): Path to where the data lies. If download_data is set to True, this is where the data will be downloaded.
+            transforms: Torch composite of transformations which are to be applied to the dataset images.
+            download_data (bool): If True, downloads the dataset to the specified datapath.
+            split (str): The dataset split to use, either 'train' or 'test'.
+        Raises:
+            AssertionError: If the split is not 'train' or 'test'.
+        """
         super().__init__()
-
+        assert split == 'train' or split == 'test'
+        
+        if download_data:
+            self._download_data(datapath, split)
+        
+        data = loadmat(os.path.join(datapath, f'{split}_32x32.mat'))
+        
+        # Images on the form N x H x W x C
+        self.images = data['X'].transpose(3, 1, 0, 2)
+        self.labels = data['y'].flatten()
+        self.labels[self.labels == 10] = 0
+        
+        self.transforms = transforms
+    def _download_data(self, path: str, split: str):
+        """
+        Downloads the SVHN dataset.
+        Args:
+            path (str): The directory where the dataset will be downloaded.
+            split (str): The dataset split to download, either 'train' or 'test'.
+        """
+        print(f'Downloading SVHN data into {path}')
+        SVHN(path, split=split, download=True) 
+    
     def __len__(self):
-        return
-
+        """
+        Returns the number of samples in the dataset.
+        Returns:
+            int: The number of samples.
+        """
+        return len(self.labels)
     def __getitem__(self, index):
-        return
+        """
+        Retrieves the image and label at the specified index.
+        Args:
+            index (int): The index of the sample to retrieve.
+        Returns:
+            tuple: A tuple containing the image and its corresponding label.
+        """
+        img, lab = self.images[index], self.labels[index]
+        
+        if self.transforms is not None:
+            img = self.transforms(img)
+        
+        return img, lab

utils/metrics/EntropyPred.py

@@ -1,12 +1,32 @@
+import numpy as np
 import torch.nn as nn
+from scipy.stats import entropy
 
 
 class EntropyPrediction(nn.Module):
-    def __init__(self):
+    def __init__(self, averages: str = 'average'):
+        """
+        Initializes the EntropyPrediction module.
+        Args:
+            averages (str): Specifies the method of aggregation for entropy values. 
+                            Must be either 'average' or 'sum'.
+        Raises:
+            AssertionError: If the averages parameter is not 'average' or 'sum'.
+        """
         super().__init__()
-
+        
+        assert averages == 'average' or averages == 'sum'
+        self.averages = averages
+        self.stored_entropy_values = []
+        
     def __call__(self, y_true, y_false_logits):
-        return
-
-    def __reset__(self):
-        pass
+        """
+        Computes the entropy between true labels and predicted logits, storing the results.
+        Args:
+            y_true: The true labels.
+            y_false_logits: The predicted logits.
+        Side Effects:
+            Appends the computed entropy values to the stored_entropy_values list.
+        """
+        entropy_values = entropy(y_true, qk=y_false_logits)
+        return entropy_values

utils/models/magnus_model.py

@@ -23,7 +23,6 @@ def __init__(self,
             MagnusModel (nn.Module): Neural network as described above in this docstring.
         """
 
-        
         super().__init__()
         self.imagesize = imagesize 
         self.imagechannels = imagechannels