Skip to content
Snippets Groups Projects
Commit 90be3642 authored by Guillaume HEUSCH's avatar Guillaume HEUSCH
Browse files

[architectures] fixed docstrings

parent 9944b123
No related branches found
No related tags found
No related merge requests found
import torch import torch
import torch.nn as nn import torch.nn as nn
import torch.nn.functional as F import torch.nn.functional as F
...@@ -25,11 +24,11 @@ class CASIANet(nn.Module): ...@@ -25,11 +24,11 @@ class CASIANet(nn.Module):
The number of classes. The number of classes.
drop_rate: float drop_rate: float
The probability for dropout. The probability for dropout.
conv: pyclass torch.nn.Module conv: :py:class:`torch.nn.Module`
The output of the convolutional / maxpool layers The output of the convolutional / maxpool layers
avgpool: pyclass torch.nn.Module avgpool: :py:class:`torch.nn.Module`
The output of the average pooling layer (used as embedding) The output of the average pooling layer (used as embedding)
classifier: pyclass torch.nn.Module classifier: :py:class:`torch.nn.Module`
The output of the last linear (logits) The output of the last linear (logits)
""" """
...@@ -58,13 +57,13 @@ class CASIANet(nn.Module): ...@@ -58,13 +57,13 @@ class CASIANet(nn.Module):
Parameters Parameters
---------- ----------
x: torch Tensor x: :py:class:`torch.Tensor`
The data to forward through the network The data to forward through the network
Returns Returns
------- -------
x: torch Tensor x: :py:class:`torch.Tensor`
The last layer of the network The last layer of the network
""" """
......
...@@ -15,12 +15,12 @@ class CNN8(nn.Module): ...@@ -15,12 +15,12 @@ class CNN8(nn.Module):
The number of classes. The number of classes.
drop_rate: float drop_rate: float
The probability for dropout. The probability for dropout.
conv: :py:class:: torch.nn.Module conv: :py:class:`torch.nn.Module`
The output of the convolutional / maxpool layers The output of the convolutional / maxpool layers
avgpool: :py:class:: torch.nn.Module avgpool: :py:class:`torch.nn.Module`
The output of the average pooling layer (used as embedding) The output of the average pooling layer (used as embedding)
classifier: :py:class:: torch.nn.Module classifier: :py:class:`torch.nn.Module`
The output of the last linear (logits) The output of the last linear (logits)
""" """
...@@ -48,13 +48,13 @@ class CNN8(nn.Module): ...@@ -48,13 +48,13 @@ class CNN8(nn.Module):
Parameters Parameters
---------- ----------
x: torch Tensor x: :py:class:`torch.Tensor`
The data to forward through the network The data to forward through the network
Returns Returns
------- -------
x: torch Tensor x: :py:class:`torch.Tensor`
The last layer of the network The last layer of the network
""" """
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment