Move tensorboard to the dev only dependency in vissl (facebookresearc…

…h#205) Summary: Pull Request resolved: facebookresearch#205 making tensorboard dev only dependency and when user uses tensorboard, we will throw the assert if tensorboard is not installed. In the assert message, we give instruction for how to install tensorboard. Reviewed By: bottler Differential Revision: D26725359 fbshipit-source-id: 6b2c663583c22a98aad5b389016575f2237fe34a
ArrowLuo · Mar 1, 2021 · 962be15 · 962be15
1 parent 179e293
commit 962be15
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 19 deletions.
diff --git a/dev/packaging/vissl_conda/vissl/meta.yaml b/dev/packaging/vissl_conda/vissl/meta.yaml
@@ -16,7 +16,6 @@ requirements:
     - pytorch
     - apex
     - torchvision>=0.5
-    - tensorboard>=1.15
     - scipy
     - scikit-learn
     - parameterized

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -9,7 +9,7 @@ sphinx_rtd_theme
 sphinx_markdown_tables
 mock
 opencv-python
-tensorboard==1.15.0
+tensorboard
 hydra-core>=1.0
 faiss-gpu
 cython

diff --git a/docs/source/visualization.rst b/docs/source/visualization.rst
@@ -28,21 +28,26 @@ parameters exposed by VISSL for Tensorboard:
 
 .. code-block:: yaml
 
-    TENSORBOARD_SETUP:
-      # whether to use tensorboard for the visualization
-      USE_TENSORBOARD: False
-      # log directory for tensorboard events
-      LOG_DIR: "."
-      EXPERIMENT_LOG_DIR: "tensorboard"
-      # flush logs every n minutes
-      FLUSH_EVERY_N_MIN: 5
-      # whether to log the model parameters to tensorboard
-      LOG_PARAMS: True
-      # whether ttp log the model parameters gradients to tensorboard
-      LOG_PARAMS_GRADIENTS: True
-      # if we want to log the model parameters every few iterations, set the iteration
-      # frequency. -1 means the params will be logged only at the end of epochs.
-      LOG_PARAMS_EVERY_N_ITERS: 310
+    HOOKS:
+        TENSORBOARD_SETUP:
+        # whether to use tensorboard for the visualization
+        USE_TENSORBOARD: False
+        # log directory for tensorboard events
+        LOG_DIR: "."
+        EXPERIMENT_LOG_DIR: "tensorboard"
+        # flush logs every n minutes
+        FLUSH_EVERY_N_MIN: 5
+        # whether to log the model parameters to tensorboard
+        LOG_PARAMS: True
+        # whether ttp log the model parameters gradients to tensorboard
+        LOG_PARAMS_GRADIENTS: True
+        # if we want to log the model parameters every few iterations, set the iteration
+        # frequency. -1 means the params will be logged only at the end of epochs.
+        LOG_PARAMS_EVERY_N_ITERS: 310
+
+.. note::
+
+    Please install tensorboard manually: if pip environment: :code:`pip install tensorboard` or if using conda and you prefer conda install of tensorboard:  :code:`conda install -c conda-forge tensorboard`.
 
 Example usage
 ---------------

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,3 @@
-tensorboard==1.15.0
 hydra-core>=1.0
 cython
 scikit-learn

diff --git a/setup.py b/setup.py
@@ -57,6 +57,7 @@ def get_version():
             "bs4",
             "faiss-gpu",
             "pycocotools>=2.0.1",
+            "tensorboard>=1.15",
         ]
     },
 )
diff --git a/vissl/hooks/__init__.py b/vissl/hooks/__init__.py
@@ -107,7 +107,12 @@ def default_hook_generator(cfg: AttrDict) -> List[ClassyHook]:
     if cfg.HOOKS.MEMORY_SUMMARY.PRINT_MEMORY_SUMMARY:
         hooks.extend([LogGpuMemoryHook(cfg.HOOKS.MEMORY_SUMMARY.LOG_ITERATION_NUM)])
     if cfg.HOOKS.TENSORBOARD_SETUP.USE_TENSORBOARD:
-        assert is_tensorboard_available(), "Tensorboard must be installed to use it."
+        assert is_tensorboard_available(), (
+            "Tensorboard must be installed to use it. Please install tensorboard using:"
+            "If pip environment: `pip install tensorboard` "
+            "If using conda and you prefer conda install of tensorboard: "
+            "`conda install -c conda-forge tensorboard`"
+        )
         tb_hook = get_tensorboard_hook(cfg)
         hooks.extend([tb_hook])
     if cfg.MODEL.GRAD_CLIP.USE_GRAD_CLIP: