Added some docstrings, comments; W&B WIP

src/digits.py

@@ -6,9 +6,6 @@
 from .utils import deskew_data, load_data
 
 
-# TODO: Move to Weights and Biases to track models
-#  in place of the current "dump as json" method
-
 def main():
 	if not os.path.isfile('../data/mnist_py3_deskewed.pkl.gz'):
 		x = input('Deskewed data not found, generate now? (y/n): ')

src/network.py

@@ -90,8 +90,6 @@ def train(self, data, validation_data=None, epochs=10, batch_size=20):
 				# Each batch is then used to train the network
 				self.train_batch(batch)
 
-			# After each epoch, optionally print progress
-			# TODO: wandb.log({'epoch': epoch, 'loss': loss})
 			if validation_data is not None:
 				correct = self.validate(validation_data)
 				percentage = 100 * correct / n_validation
@@ -282,6 +280,8 @@ def softmax(z):
 
 
 def main():
+	# TODO: Animated plotting to show performance change with time.
+	#  check scratch.py
 	wandb.init(project='digits')
 	# n = NeuralNetwork([784, 256, 10])
 	training, validation, test = load_data()

src/utils.py

@@ -9,6 +9,12 @@
 
 
 def load_data(deskew=True):
+	"""
+	Loads MNIST dataset from disk.
+
+	Returns the training, validation, and test data as a list of tuples,
+	where the outputs are one-hot encoded vectors.
+	"""
 	# The _py3 version of the dataset is a redumped version for Python 3
 	# which doesn't use Python 2's latin1 encoding
 	if deskew:
@@ -33,6 +39,10 @@ def load_data(deskew=True):
 
 
 def deskew_data():
+	"""
+	Deskews the MNIST dataset and saves it to disk.
+	"""
+	# Check if deskewed data already exists
 	if os.path.isfile('../data/mnist_py3_deskewed.pkl.gz'):
 		return
 
@@ -54,12 +64,18 @@ def deskew_data():
 
 
 def get_expected_y(digit):
+	"""
+	Returns a one-hot encoded vector of the inputted digit.
+	"""
 	y = np.array([0] * 10)
 	y[digit] = 1
 	return y
 
 
 def draw_digit(image):
+	"""
+	Renders and displays the image.
+	"""
 	arr = (np.array(image).reshape((28, 28)) * 255).astype('uint8')
 	Image.fromarray(arr).resize((256, 256), Image.ANTIALIAS).show()
 

wandb/settings

@@ -0,0 +1,2 @@
+[default]
+