neuralnet.py This is the file where you will be doing all of your work.
You are given a NeuralNet class which implements a torch.nn.module.
This class consists of __init__(), set_parameters(), get_parameters(), forward(), and step()
functions.
In the __init__() function you will need to construct the network architecture.
There are multiple ways to do this. One way is to use nn.Linear() and nn.Sequential() .
Keep in mind that nn.Linear() uses a Kaiming He uniform initialization to initialize the weight matrices and 0 for
the bias terms. Another way you could do things is by explicitly defining weight matrices W1,W2,... and bias
terms b1,b2,... by defining them as a torch.tensor(). This way is more hands on and will allow you to choose
your own initialization. However, for this assignment Kaiming He uniform initialization should suffice and should be a good choice.
Additionally, you can initialize a torch.optim optimizer object in this function to use
to optimize your network in the step() function.
The forward() function should do a forward pass through your network. This means
it should explicitly evaluate \(F_{W}(x)\) . This can be done by simply calling your nn.Sequential()
object defined in __init__() or in the torch.tensor() case by explicitly multiplying the weight matrices by your data.
The step() function should perform one iteration of training. This means it should
perform one gradient update through your training data. You can do this by calling loss_fn(yhat,y).backward()
then either update the weights directly yourself, or you can use a torch.optim object that you
may have initialized in __init__() to help you update the network. Be sure to call zero_grad()
on your optimizer in order to clear the gradient buffer.
More details on what each of these methods in the NeuralNet class should do is given in
the skeleton code.
The function fit() takes as input the training data, training labels, development set, and maximum number of iterations. The training data provided is the output from reader.py.
The training labels is a torch tensor consisting of labels corresponding to each image in the training data.
The development set is the torch tensor of images that you are going to test your implementation on.
The maximium number of iterations is the number you specified with --max_iter (it is 10 by default).
fit() outputs the predicted labels. The fit function should construct a NeuralNet object,
and iteratively call the neural net's step() function to train the network. This should be
done by feeding in batches of data determined by batch size. (You will use a batch size of 100 for this assignment.)
Do not modify the provided code. You will only have to modify neuralnet.py.
To understand more about how to run the MP, run python3 mp6.py -h in your terminal.
Definitely use the PyTorch docs to help you with implementation details.
You can also use this PyTorch Tutorial as a reference to help you
with your implementation. There are also other guides out there such as this one.
Deliverables
This MP will be submitted via gradescope.
When you believe your model has attained an acceptable accuracy on the development set,
save your trained model by using the torch.save() function. You should save your model
in a file named net.model, and submit it together with your neuralnet.py
Please upload only neuralnet.py and net.model to gradescope.