[doc] extended docstrings, removed reference to DRGAN for now

.gitignore

@@ -10,7 +10,6 @@ parts
 src
 develop-eggs
 sphinx
-test*
 submit*
 log*
 results*

bob/ip/pytorch_extractor/CNN8.py

@@ -69,17 +69,17 @@ class CNN8Extractor(Extractor):
   def __call__(self, image):
     """__call__(image) -> feature
 
-    Extract features
+    Extract features from an image
 
     **Parameters:**
 
     image : 3D :py:class:`numpy.ndarray` (floats)
-      The image to extract the features from.
+      The image to extract the features from. Its size must be 3x128x128
 
     **Returns:**
 
     feature : 2D :py:class:`numpy.ndarray` (floats)
-      The extracted features
+      The extracted features as a 1d array of size 512 
     """
     input_image = numpy.rollaxis(numpy.rollaxis(image, 2),2)
     input_image = self.to_tensor(input_image)

bob/ip/pytorch_extractor/CasiaNet.py

@@ -73,12 +73,12 @@ class CasiaNetExtractor(Extractor):
     **Parameters:**
 
     image : 3D :py:class:`numpy.ndarray` (floats)
-      The image to extract the features from.
+      The image to extract the features from. Its size must be 3x128x128
 
     **Returns:**
 
     feature : 2D :py:class:`numpy.ndarray` (floats)
-      The extracted features
+      The extracted features as a 1d array of size 320 
     """
     input_image = numpy.rollaxis(numpy.rollaxis(image, 2),2)
     input_image = self.to_tensor(input_image)

doc/guide.rst

-===========
- User guide
-===========
+==========
+User guide
+==========
 
 Using as a feature extractor
 ----------------------------
@@ -9,7 +9,7 @@ This package has been done with the intent of using it in conjunction with
 bob.bio.face to run face verification experiments.
 
 In particular, the goal here is to encode the identity contained in a
-face image using a model referred to as DR-GAN 
+face image using a different CNN models 
 
 For this purpose, you can specify your feature extractor in configuration
-file to be used together with the ```verifiy.py``` script from ```bob.bio.base```
+file to be used together with the ``verifiy.py`` script from ``bob.bio.base``

doc/index.rst

@@ -6,7 +6,7 @@
 ===================================================
 
 This package contains functionality to extract features from models trained with
-Tensorflow http://pytorch.org/
+PyTorch http://pytorch.org/
 
 =======
  Index

doc/py_api.rst

@@ -7,8 +7,8 @@ Classes
 -------
 
 .. autosummary::
-    bob.ip.pytorch_extractor.DRGANLight
-    bob.ip.pytorch_extractor.DRGANOriginal
+    bob.ip.pytorch_extractor.CNN8
+    bob.ip.pytorch_extractor.CasiaNet
 
 
 Detailed API