nuImages v0.1

README.md

@@ -1,16 +1,23 @@
 # nuScenes devkit
-Welcome to the devkit of the [nuScenes](https://www.nuscenes.org) dataset.
+Welcome to the devkit of the [nuScenes](https://www.nuscenes.org) and nuImages datasets.
 ![](https://www.nuscenes.org/public/images/road.jpg)
 
 ## Overview
 - [Changelog](#changelog)
-- [Dataset download](#dataset-download)
-- [Map expansion](#map-expansion)
 - [Devkit setup](#devkit-setup)
-- [Getting started](#getting-started)
+- [nuImages](#nuimages)
+  - [nuImages setup](#nuimages-setup) 
+  - [Getting started with nuImages](#getting-started-with-nuimages)
+- [nuScenes](#nuscenes)
+  - [nuScenes setup](#nuscenes-setup)
+  - [Prediction challenge](#prediction-challenge)
+  - [CAN bus expansion](#can-bus-expansion)
+  - [Map expansion](#map-expansion)
+  - [Getting started with nuScenes](#getting-started-with-nuscenes)
 - [Citation](#citation)
 
 ## Changelog
+- Apr. 30, 2020: nuImages v0.1 code release.
 - Mar. 24, 2020: Devkit v1.0.7: nuScenes prediction challenge code released.
 - Feb. 12, 2020: Devkit v1.0.6: CAN bus expansion released.
 - Dec. 11, 2019: Devkit v1.0.5: Remove weight factor from AMOTA tracking metrics.
@@ -23,7 +30,43 @@ Welcome to the devkit of the [nuScenes](https://www.nuscenes.org) dataset.
 - Oct. 4, 2018: Code to parse RADAR data released.
 - Sep. 12, 2018: Devkit for teaser dataset released.
 
-## Dataset download
+
+## Devkit setup
+We use a common devkit for nuScenes and nuImages.
+The devkit is tested for Python 3.6 and Python 3.7.
+To install Python, please check [here](https://github.com/nutonomy/nuscenes-devkit/blob/master/setup/installation.md#install-python).
+
+Our devkit is available and can be installed via [pip](https://pip.pypa.io/en/stable/installing/) :
+```
+pip install nuscenes-devkit
+```
+For an advanced installation, see [installation](https://github.com/nutonomy/nuscenes-devkit/blob/master/setup/installation.md) for detailed instructions.
+
+## nuImages
+
+### nuImages setup
+Note that until the release of nuImages v1.0, the files will not be available for public download.
+For the devkit to work you will need to download *all* archives.
+Please unpack the archives to the `/data/sets/nuimages` folder \*without\* overwriting folders that occur in multiple archives.
+Eventually you should have the following folder structure:
+```
+/data/sets/nuimages
+    imgs	-	Folder with the camera images.
+    v0.1-*	-	JSON tables that include all the meta data and annotations. Each split (train, val, test) is provided in a separate folder.
+```
+If you want to use another folder, specify the `dataroot` parameter of the NuImages class (see tutorial).
+
+### Getting started with nuImages
+Please follow these steps to make yourself familiar with the nuImages dataset:
+- Get the [nuscenes-devkit code](https://github.com/nutonomy/nuscenes-devkit).
+- Run the tutorial using:
+```
+jupyter notebook $HOME/nuscenes-devkit/python-sdk/tutorials/nuimages_basics_tutorial.ipynb
+```
+
+## nuScenes
+
+### nuScenes setup
 To download nuScenes you need to go to the [Download page](https://www.nuscenes.org/download), 
 create an account and agree to the nuScenes [Terms of Use](https://www.nuscenes.org/terms-of-use).
 After logging in you will see multiple archives. 
@@ -39,15 +82,15 @@ Eventually you should have the following folder structure:
 ```
 If you want to use another folder, specify the `dataroot` parameter of the NuScenes class (see tutorial).
 
-## Prediction Challenge
+### Prediction challenge
 In March 2020 we released code for the nuScenes prediction challenge.
 To get started:
 - Download the version 1.2 of the map expansion (see below).
 - Download the trajectory sets for [CoverNet](https://arxiv.org/abs/1911.10298) from [here](https://www.nuscenes.org/public/nuscenes-prediction-challenge-trajectory-sets.zip).
 - Go through the [tutorial](https://github.com/nutonomy/nuscenes-devkit/blob/master/python-sdk/tutorials/prediction_tutorial.ipynb).
 - For information on how submissions will be scored, visit the challenge [website](https://www.nuscenes.org/prediction).
 
-## CAN bus expansion
+### CAN bus expansion
 In February 2020 we published the CAN bus expansion.
 It contains low-level vehicle data about the vehicle route, IMU, pose, steering angle feedback, battery, brakes, gear position, signals, wheel speeds, throttle, torque, solar sensors, odometry and more.
 To install this expansion, please follow these steps:
@@ -57,7 +100,7 @@ To install this expansion, please follow these steps:
 - If you already have a previous version of the devkit, update the pip requirements (see [details](https://github.com/nutonomy/nuscenes-devkit/blob/master/setup/installation.md)): `pip install -r setup/requirements.txt`
 - Get started with the [readme](https://github.com/nutonomy/nuscenes-devkit/blob/master/python-sdk/nuscenes/can_bus/README.md) or [tutorial](https://github.com/nutonomy/nuscenes-devkit/blob/master/python-sdk/tutorials/can_bus_tutorial.ipynb).
 
-## Map expansion
+### Map expansion
 In July 2019 we published a map expansion with 11 semantic layers (crosswalk, sidewalk, traffic lights, stop lines, lanes, etc.).
 To install this expansion, please follow these steps:
 - Download the expansion from the [Download page](https://www.nuscenes.org/download),
@@ -66,25 +109,15 @@ To install this expansion, please follow these steps:
 - If you already have a previous version of the devkit, update the pip requirements (see [details](https://github.com/nutonomy/nuscenes-devkit/blob/master/setup/installation.md)): `pip install -r setup/requirements.txt`
 - Get started with the [tutorial](https://github.com/nutonomy/nuscenes-devkit/blob/master/python-sdk/nuscenes/python-sdk/tutorials/map_expansion_tutorial.ipynb).
 
-## Devkit setup
-The devkit is tested for Python 3.6 and Python 3.7.
-To install Python, please check [here](https://github.com/nutonomy/nuscenes-devkit/blob/master/setup/installation.md#install-python).
-
-Our devkit is available and can be installed via [pip](https://pip.pypa.io/en/stable/installing/) :
-```
-pip install nuscenes-devkit
-```
-For an advanced installation, see [installation](https://github.com/nutonomy/nuscenes-devkit/blob/master/setup/installation.md) for detailed instructions.
-
-## Getting started
+### Getting started with nuScenes
 Please follow these steps to make yourself familiar with the nuScenes dataset:
 - Read the [dataset description](https://www.nuscenes.org/overview).
 - [Explore](https://www.nuscenes.org/explore/scene-0011/0) the lidar viewer and videos.
 - [Download](https://www.nuscenes.org/download) the dataset. 
 - Get the [nuscenes-devkit code](https://github.com/nutonomy/nuscenes-devkit).
 - Read the [online tutorial](https://www.nuscenes.org/tutorial) or run it yourself using:
 ```
-jupyter notebook $HOME/nuscenes-devkit/python-sdk/tutorials/nuscenes_basics.ipynb
+jupyter notebook $HOME/nuscenes-devkit/python-sdk/tutorials/nuscenes_basics_tutorial.ipynb
 ```
 - Read the [nuScenes paper](https://www.nuscenes.org/publications) for a detailed analysis of the dataset.
 - Run the [map expansion tutorial](https://github.com/nutonomy/nuscenes-devkit/blob/master/python-sdk/nuscenes/python-sdk/tutorials/map_expansion_tutorial.ipynb).

python-sdk/nuimages/__init__.py

@@ -0,0 +1,2 @@
+from .nuimages import NuImages
+from .utils import default_color, annotation_name