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

fixed docstrings

parent a613225a
No related branches found
No related tags found
1 merge request!5updated .gitlab-ci.yml with latest one
Pipeline #26147 passed
...@@ -23,9 +23,9 @@ class CasiaWebFaceDataset(Dataset): ...@@ -23,9 +23,9 @@ class CasiaWebFaceDataset(Dataset):
The path to the data The path to the data
transform : `torchvision.transforms` transform : `torchvision.transforms`
The transform(s) to apply to the face images The transform(s) to apply to the face images
data_files : list of str data_files : list of :obj:`str`
The list of data files The list of data files
id_labels : list of int id_labels : list of :obj:`int`
The list of identities, for each data file The list of identities, for each data file
""" """
...@@ -108,11 +108,11 @@ class CasiaDataset(Dataset): ...@@ -108,11 +108,11 @@ class CasiaDataset(Dataset):
The path to the data The path to the data
transform : `torchvision.transforms` transform : `torchvision.transforms`
The transform(s) to apply to the face images The transform(s) to apply to the face images
data_files: list of str data_files: list of :obj:`str`
The list of data files The list of data files
id_labels : list of int id_labels : list of :obj:`int`
The list of identities, for each data file The list of identities, for each data file
pose_labels : list of int pose_labels : list of :obj:`int`
The list containing the pose labels The list containing the pose labels
""" """
......
...@@ -24,7 +24,7 @@ class CNNTrainer(object): ...@@ -24,7 +24,7 @@ class CNNTrainer(object):
The network to train The network to train
batch_size: int batch_size: int
The size of your minibatch The size of your minibatch
use_gpu: boolean use_gpu: bool
If you would like to use the gpu If you would like to use the gpu
verbosity_level: int verbosity_level: int
The level of verbosity output to stdout The level of verbosity output to stdout
...@@ -40,7 +40,7 @@ class CNNTrainer(object): ...@@ -40,7 +40,7 @@ class CNNTrainer(object):
The network to train The network to train
batch_size: int batch_size: int
The size of your minibatch The size of your minibatch
use_gpu: boolean use_gpu: bool
If you would like to use the gpu If you would like to use the gpu
verbosity_level: int verbosity_level: int
The level of verbosity output to stdout The level of verbosity output to stdout
......
...@@ -22,7 +22,7 @@ class ConditionalGANTrainer(object): ...@@ -22,7 +22,7 @@ class ConditionalGANTrainer(object):
The generator network The generator network
discriminator : :py:class:`torch.nn.Module` discriminator : :py:class:`torch.nn.Module`
The discriminator network The discriminator network
image_size: list of int image_size: list of :obj:`int`
The size of the images in this format: [channels,height, width] The size of the images in this format: [channels,height, width]
batch_size: int batch_size: int
The size of your minibatch The size of your minibatch
...@@ -49,7 +49,7 @@ class ConditionalGANTrainer(object): ...@@ -49,7 +49,7 @@ class ConditionalGANTrainer(object):
The generator network The generator network
netD : :py:class:`torch.nn.Module` netD : :py:class:`torch.nn.Module`
The discriminator network The discriminator network
image_size: list of int image_size: list of :obj:`int`
The size of the images in this format: [channels,height, width] The size of the images in this format: [channels,height, width]
batch_size: int batch_size: int
The size of your minibatch The size of your minibatch
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment