revert renaming of TensorBoardLogger and update docs

leVirve · Jul 31, 2018 · 8dc0fe0 · 8dc0fe0
1 parent 229f8f1
commit 8dc0fe0
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 21 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -42,6 +42,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -100,6 +101,18 @@
 #
 # html_sidebars = {}
 
+# -- Mock imports ------------------------------------------------------------
+autodoc_mock_imports = [
+    'torchvision',
+    'tensorboardX',
+    'tqdm',
+    'pyaml',
+    'numpy',
+    'scipy',
+    'torch',
+    'cv2',
+    'PIL',
+]
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -159,14 +172,10 @@
 
 
 # -- Extension configuration -------------------------------------------------
-autodoc_mock_imports = [
-    'torchvision',
-    'tensorboardX',
-    'tqdm',
-    'pyaml',
-    'numpy',
-    'scipy',
-    'torch',
-    'cv2',
-    'PIL',
-]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('http://docs.scipy.org/doc/numpy/', None),
+    'torch': ('http://pytorch.org/docs/master', None),
+    'tensorboardX': ('https://tensorboardx.readthedocs.io/en/latest', None),
+}
diff --git a/onegan/estimator.py b/onegan/estimator.py
@@ -14,7 +14,7 @@
 import onegan
 import onegan.loss as losses
 from onegan.option import AttrDict
-from onegan.extension import History, TensorBoard, GANCheckpoint
+from onegan.extension import History, TensorBoardLogger, GANCheckpoint
 
 
 class Events(Enum):
@@ -411,7 +411,7 @@ def __init__(self, model, optimizer, metric, name, **kwargs):
         self.name = name
 
         self.saver = GANCheckpoint(name=name, save_interval=kwargs.get('save_epochs', 5))
-        self.logger = TensorBoard(name=name, max_num_images=kwargs.get('max_num_images', 30))
+        self.logger = TensorBoardLogger(name=name, max_num_images=kwargs.get('max_num_images', 30))
 
         self.build_criterion()
 

diff --git a/onegan/extension/__init__.py b/onegan/extension/__init__.py
@@ -11,5 +11,5 @@
 from .tensorcollect import *  # noqa
 
 
-__all__ = ('Checkpoint', 'TensorBoard', 'TensorCollector',
+__all__ = ('Checkpoint', 'TensorBoardLogger', 'TensorCollector',
            'ImageSaver', 'Colorizer', 'History')
diff --git a/onegan/extension/tensorboard.py b/onegan/extension/tensorboard.py
@@ -29,12 +29,12 @@ def wrapper(instance, kw_images, epoch, prefix=''):
     return wrapper
 
 
-class TensorBoard(Extension):
-    r""" Convenient TensorBoard wrapping tensorboardX
+class TensorBoardLogger(Extension):
+    r""" Convenient TensorBoard wrapping on tensorboardX
 
     Args:
-        logdir (str): the root folder for tensorboard logging events (default: 'exp/logs')
-        name (str): subfolder name for current event writer (default: `default`)
+        logdir (str): the root folder for tensorboard logging events (default: ``exp/logs``)
+        name (str): subfolder name for current event writer (default: ``default``)
         max_num_images (int): number of images to log on the image panel (default: 20)
     """
 
@@ -84,7 +84,7 @@ def histogram(self, tensors_dict, epoch, bins='auto'):
         Args:
             tensors_dict: :class:`dict` of tensors
             epoch: step for TensorBoard logging
-            bins: `bins` for tensorboarSdX.add_histogram
+            bins: `bins` for :py:meth:`tensorboardX.SummaryWriter.add_histogram`
         """
         [self.writer.add_histogram(f'{tag}', tensor, epoch, bins=bins) for tag, tensor in tensors_dict.items()]
 

diff --git a/readthedocs.yml b/readthedocs.yml
@@ -2,5 +2,4 @@ build:
   image: latest
 
 python:
-  version: 3.6
-  setup_py_install: true
+  version: 3.6