From 9e63ddbd19d26f0f165158674b7d50b4d3fd6b60 Mon Sep 17 00:00:00 2001
From: Jerry Jiarui XU <xvjiarui0826@gmail.com>
Date: Sun, 23 Aug 2020 14:42:07 +0800
Subject: [PATCH] [Doc] Add annotaion format note (#77)

---
 docs/tutorials/new_dataset.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/tutorials/new_dataset.md b/docs/tutorials/new_dataset.md
index 0ad1019e0..611890476 100644
--- a/docs/tutorials/new_dataset.md
+++ b/docs/tutorials/new_dataset.md
@@ -38,6 +38,9 @@ Only
 `data/my_dataset/ann_dir/train/xxx{seg_map_suffix}`,
 `data/my_dataset/ann_dir/train/zzz{seg_map_suffix}` will be loaded.
 
+Note: The annotations are images of shape (H, W), the value pixel should fall in range `[0, num_classes - 1]`.
+You may use `'P'` mode of [pillow](https://pillow.readthedocs.io/en/stable/handbook/concepts.html#palette) to create your annotation image with color.
+
 ## Customize datasets by mixing dataset
 
 MMSegmentation also supports to mix dataset for training.