docs(network): add docstring for Resnet
@@ -39,6 +39,19 @@ class FCNN(nn.Module):
class Resnet(nn.Module):
+ """A residual network with a trainable linear skip connection between input and output
+
+ :param n_input_units: number of units in the input layer, defaults to 1.
+ :type n_input_units: int
+ :param n_input_units: number of units in the output layer, defaults to 1.
+ :type n_input_units: int
+ :param n_hidden_units: number of hidden units in each hidden layer, defaults to 32.
+ :type n_hidden_units: int
+ :param n_hidden_layers: number of hidden layers, defaults to 1.
+ :type n_hidden_layers: int
+ :param actv: the activation layer constructor after each hidden layer, defaults to `torch.nn.Tanh`.
+ :type actv: class
+ """
def __init__(self, n_input_units=1, n_output_units=1, n_hidden_units=32, n_hidden_layers=1, actv=nn.Tanh):
super(Resnet, self).__init__()
