update docs

Reviewed By: alexander-kirillov

Differential Revision: D26627161

fbshipit-source-id: c7be8408351d3fbc5f8e2eaba951f4f5a45a1979

Author: ppwwyyxx

.github/workflows/check-template.yml

@@ -31,7 +31,7 @@ jobs:
             }
             const body = issue.data.body.toLowerCase();
             const hasInstructions = body.indexOf("reproduce") != -1;
-            const hasEnvironment = (body.indexOf("environment") != -1) || (body.indexOf("colab") != -1);
+            const hasEnvironment = (body.indexOf("environment") != -1) || (body.indexOf("colab") != -1) || (body.indexOf("docker") != -1);
             if (hasInstructions && hasEnvironment) {
               core.debug("Issue " + issue.data.title + " follows template.");
               return;

INSTALL.md

@@ -9,7 +9,7 @@
 
 ### Build Detectron2 from Source
 
-gcc & g++ ≥ 5 are required. [ninja](https://ninja-build.org/) is recommended for faster build.
+gcc & g++ ≥ 5.4 are required. [ninja](https://ninja-build.org/) is recommended for faster build.
 After having them, run:
 ```
 python -m pip install 'git+https://github.com/facebookresearch/detectron2.git'
@@ -61,7 +61,7 @@ Choose from this table to install [v0.3 (Nov 2020)](https://github.com/facebookr
 
 Note that:
 1. The pre-built package has to be used with corresponding version of CUDA and the official package of PyTorch.
-	 Otherwise, please build detectron2 from source.
+   Otherwise, please build detectron2 from source.
 2. New packages are released every few months. Therefore, packages may not contain latest features in the master
    branch and may not be compatible with the master branch of a research project that uses detectron2
    (e.g. those in [projects](projects)).

detectron2/data/datasets/coco_panoptic.py

@@ -76,8 +76,8 @@ def register_coco_panoptic(
             e.g. "coco_2017_train_panoptic"
         metadata (dict): extra metadata associated with this dataset.
         image_root (str): directory which contains all the images
-        panoptic_root (str): directory which contains panoptic annotation images
-        panoptic_json (str): path to the json panoptic annotation file
+        panoptic_root (str): directory which contains panoptic annotation images in COCO format
+        panoptic_json (str): path to the json panoptic annotation file in COCO format
         sem_seg_root (none): not used, to be consistent with
             `register_coco_panoptic_separated`.
         instances_json (str): path to the json instance annotation file

detectron2/utils/collect_env.py

@@ -92,7 +92,7 @@ def collect_env_info():
                 cxx = cxx.decode("utf-8").strip().split("\n")[0]
             except subprocess.SubprocessError:
                 cxx = "Not found"
-            data.append(("Compiler", cxx))
+            data.append(("Compiler ($CXX)", cxx))
 
             if has_cuda and CUDA_HOME is not None:
                 try:

docker/README.md

@@ -5,7 +5,7 @@
 cd docker/
 # Build:
 docker build --build-arg USER_ID=$UID -t detectron2:v0 .
-# Launch:
+# Launch (require GPUs):
 docker run --gpus all -it \
   --shm-size=8gb --env="DISPLAY" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" \
   --name=detectron2 detectron2:v0

docs/tutorials/datasets.md

@@ -227,7 +227,7 @@ Some additional metadata that are specific to the evaluation of certain datasets
   to contiguous ids in [0, num_categories). It is useful for evaluation only.
 
 * `json_file`: The COCO annotation json file. Used by COCO evaluation for COCO-format datasets.
-* `panoptic_root`, `panoptic_json`: Used by panoptic evaluation.
+* `panoptic_root`, `panoptic_json`: Used by COCO-format panoptic evaluation.
 * `evaluator_type`: Used by the builtin main training script to select
    evaluator. Don't use it in a new training script.
    You can just provide the [DatasetEvaluator](../modules/evaluation.html#detectron2.evaluation.DatasetEvaluator)