Merge pull request #22 from ppwwyyxx/master

Make panopticapi a package

Author: alexander-kirillov

README.md

@@ -1,10 +1,16 @@
 # COCO 2018 Panoptic Segmentation Task API (Beta version)
 This API is an experimental version of [COCO 2018 Panoptic Segmentation Task API](http://cocodataset.org/#panoptic-2018).
 
+To install panopticapi, run:
+```
+pip install git+https://github.com/cocodataset/panopticapi.git
+```
+
 ## Summary
 **Evaluation script**
 
-*evaluation.py* calculates [PQ metrics](http://cocodataset.org/#panoptic-eval). For more information about the script usage: `python evaluation.py --help`
+[panopticapi/evaluation.py](panopticapi/evaluation.py) calculates [PQ metrics](http://cocodataset.org/#panoptic-eval).
+For more information about the script usage: `python -m panopticapi.evaluation --help`
 
 **Format converters**
 
@@ -14,17 +20,21 @@ We provide several converters for COCO panoptic format. Full description and usa
 
 **Semantic and instance segmentation heuristic combination**
 
-We provide simple script that heuristically combines semantic and instance segmentation predictions into panoptic segmentation prediction.
+We provide [a simple script](panopticapi/combine_semantic_and_instance_predictions.py)
+that heuristically combines semantic and instance segmentation predictions into panoptic segmentation prediction.
+
+The merging logic of the script is described in the panoptic segmentation [paper](https://arxiv.org/abs/1801.00868).
+In addition, this script is able to filter out stuff predicted segments that have their area below the threshold defined by `--stuff_area_limit` parameter.
 
-The merging logic of the script is described in the panoptic segmentation [paper](https://arxiv.org/abs/1801.00868). In addition, this script is able to filter out stuff predicted segments that have their area below the threshold defined by `--stuff_area_limit` parameter. For more information about the script logic and usage: `python combine_semantic_and_instance_predictions.py --help`
+For more information about the script logic and usage: `python -m panopticapi.combine_semantic_and_instance_predictions.py --help`
 
 **COCO panoptic segmentation challenge categories**
 
-Json file [panoptic_coco_categories.json](https://github.com/cocodataset/panopticapi/blob/master/panoptic_coco_categories.json) contains the list of all categories used in COCO panoptic segmentation challenge 2018.
+Json file [panoptic_coco_categories.json](panoptic_coco_categories.json) contains the list of all categories used in COCO panoptic segmentation challenge 2018.
 
 **Visualization**
 
-*visualization.py* provides an example of generating visually appealing representation of the panoptic segmentation data.
+[visualization.py](visualization.py) provides an example of generating visually appealing representation of the panoptic segmentation data.
 
 ## Contact
 If you have any questions regarding this API, please contact us at alexander.n.kirillov-at-gmail.com.

cityscapes_gt_converter/cityscapes_panoptic_converter.py

@@ -9,7 +9,7 @@
 import numpy as np
 import PIL.Image as Image
 
-from utils import IdGenerator, save_json
+from panopticapi.utils import IdGenerator, save_json
 
 try:
     # set up path for cityscapes scripts

converters/2channels2panoptic_coco_format.py

@@ -30,7 +30,7 @@
 
 import PIL.Image as Image
 
-from utils import get_traceback, IdGenerator, save_json
+from panopticapi.utils import get_traceback, IdGenerator, save_json
 
 OFFSET = 1000
 

converters/detection2panoptic_coco_format.py

@@ -17,7 +17,7 @@
 
 import PIL.Image as Image
 
-from utils import get_traceback, IdGenerator, save_json
+from panopticapi.utils import get_traceback, IdGenerator, save_json
 
 try:
     # set up path for pycocotools

converters/panoptic2detection_coco_format.py

@@ -21,7 +21,7 @@
 
 import PIL.Image as Image
 
-from utils import get_traceback, rgb2id, save_json
+from panopticapi.utils import get_traceback, rgb2id, save_json
 
 try:
     # set up path for pycocotools

converters/panoptic2semantic_segmentation.py

@@ -21,7 +21,7 @@
 
 import PIL.Image as Image
 
-from utils import get_traceback, rgb2id, save_json
+from panopticapi.utils import get_traceback, rgb2id, save_json
 
 try:
     # set up path for pycocotools

__init__.py renamed to panopticapi/__init__.py

@@ -21,17 +21,11 @@
 import multiprocessing
 import copy
 
-from utils import IdGenerator, id2rgb, save_json
+from panopticapi.utils import IdGenerator, id2rgb, save_json
 
-try:
-    import PIL.Image     as Image
-except Exception:
-    print("Failed to import the image processing packages.")
-    sys.exit(-1)
+import PIL.Image     as Image
 
 try:
-    # set up path for pycocotools
-    # sys.path.append('./cocoapi-master/PythonAPI/')
     from pycocotools import mask as COCOmask
 except Exception:
     raise Exception("Please install pycocotools module from https://github.com/cocodataset/cocoapi")

combine_semantic_and_instance_predictions.py renamed to panopticapi/combine_semantic_and_instance_predictions.py

@@ -14,7 +14,7 @@
 
 import PIL.Image as Image
 
-from utils import get_traceback, rgb2id
+from panopticapi.utils import get_traceback, rgb2id
 
 OFFSET = 256 * 256 * 256
 VOID = 0