Merge branch 'master' of github.com:developmentseed/label-maker

Author: drewbo

.circleci/config.yml

@@ -25,22 +25,34 @@ jobs:
           name: Integration Tests
           command: |
             sudo pip install .
-            mkdir integration
-            cp test/fixtures/integration/portugal-z17.mbtiles integration/portugal-z17.mbtiles
-            cp -r test/fixtures/integration/tiles integration/tiles
+
+            ## Classification integration tests
+            mkdir integration-cl
+            cp test/fixtures/integration/portugal-z17.mbtiles integration-cl/portugal-z17.mbtiles
+            cp -r test/fixtures/integration/tiles integration-cl/tiles
 
             # Test `label-maker labels --sparse`; must be run before `label-maker labels` so `verify-package.py` passes
-            label-maker labels --dest integration --config test/fixtures/integration/config.integration_sparse.json --sparse > stdout_sparse
+            label-maker labels --dest integration-cl --config test/fixtures/integration/config.integration_sparse.json --sparse > stdout_sparse
             python test/verify-sparse-labels.py
             # Test `label-maker labels`
-            label-maker labels --dest integration --config test/fixtures/integration/config.integration.json > stdout
-            python test/verify-labels.py
+            label-maker labels --dest integration-cl --config test/fixtures/integration/config.integration.json > stdout
+            python test/verify-labels-cl.py
             # Test `label-maker package`
-            label-maker package --dest integration --config test/fixtures/integration/config.integration.json
-            python test/verify-package.py
+            label-maker package --dest integration-cl --config test/fixtures/integration/config.integration.json
+            python test/verify-package-cl.py
+
+            # segmentation integration tests
+            mkdir integration-sg
+            cp test/fixtures/integration/portugal-z17.mbtiles integration-sg/portugal-z17.mbtiles
+            cp -r test/fixtures/integration/tiles integration-sg/tiles
+            label-maker labels --dest integration-sg --config test/fixtures/integration/config.integration.segmentation.json
+            python test/verify-labels-sg.py
 
             # Retest that `label-maker labels` works, but from outside the module directory
             cd ~
-            label-maker labels --dest label-maker/integration --config label-maker/test/fixtures/integration/config.integration.json > stdout
-            cd ~/label-maker            
-            python test/verify-labels.py
+            label-maker labels --dest label-maker/integration-cl --config label-maker/test/fixtures/integration/config.integration.json > stdout
+            cd ~/label-maker
+            python test/verify-labels-cl.py
+
+      - store_artifacts:
+          path: ~/label-maker/integration-sg/labels/

.gitignore

@@ -10,3 +10,5 @@ MANIFEST
 .cache
 data
 config.json
+stdout*
+/integration*

README.md

@@ -41,8 +41,9 @@ Before running any commands, it is necessary to create a `config.json` file to s
 - `bounding_box`: The bounding box to create images from. This should be given in the form: `[xmin, ymin, xmax, ymax]` as longitude and latitude values between `[-180, 180]` and `[-90, 90]` respectively. Values should use the WGS84 datum, with longitude and latitude units of decimal degrees.
 - `zoom`: The [zoom level](http://wiki.openstreetmap.org/wiki/Zoom_levels) to create images as. This functions as a rough proxy for resolution. Values should be given as integers.
 - `classes`: An array of classes for machine learning training. Each class is defined as an object with two required properties:
-  - `name`: class name
+  - `name`: The class name
   - `filter`: A [Mapbox GL Filter](https://www.mapbox.com/mapbox-gl-js/style-spec#other-filter) to define any vector features matching this class. Filters are applied with the standalone [featureFilter](https://github.com/mapbox/mapbox-gl-js/tree/master/src/style-spec/feature_filter) from Mapbox GL JS.
+  - `buffer`: The number of pixels to buffer the geometry by. This is an optional parameter to buffer the label for `object-detection` and `segmentation` tasks. Accepts any number (positive or negative). It uses [Shapely `object.buffer`](https://shapely.readthedocs.io/en/latest/manual.html#object.buffer) to calculate the final geometry. You can verify that your buffer options create the desired labels by inspecting the files created in `data/labels/` after running the `labels` command.
 - `imagery`: A template string for a tiled imagery service. Note that you will generally need an API key to obtain images and there may be associated costs. The above example requires a [Mapbox access token](https://www.mapbox.com/help/how-access-tokens-work/)
 - `background_ratio`: For single-class classification problems, we need to download images with no matching class. We will download `background_ratio` times the number of images matching the one class.
 - `ml_type`: One of `"classification"`, `"object-detection"`, or `"segmentation"`. For the final label numpy arrays (`y_train` and `y_test`), we will produce a different label depending upon the `type`.

label_maker/label.py

@@ -1,4 +1,4 @@
-# pylint: disable=unused-argument
+# pylint: disable=unused-argument,too-many-nested-blocks
 """Create label data from OSM QA tiles for specified classes"""
 
 from os import makedirs, path as op
@@ -196,7 +196,9 @@ def _mapper(x, y, z, data, args):
                 for i, cl in enumerate(classes):
                     ff = create_filter(cl.get('filter'))
                     if ff(feat):
-                        geo = shape(feat['geometry']).buffer(cl.get('buffer', 0))
+                        geo = shape(feat['geometry'])
+                        if cl.get('buffer'):
+                            geo = geo.buffer(cl.get('buffer'), 4)
                         bb = _pixel_bbox(geo.bounds) + [i + 1]
                         bboxes = np.append(bboxes, np.array([bb]), axis=0)
             return ('{!s}-{!s}-{!s}'.format(x, y, z), bboxes)
@@ -207,7 +209,9 @@ def _mapper(x, y, z, data, args):
                     ff = create_filter(cl.get('filter'))
                     if ff(feat):
                         feat['geometry']['coordinates'] = _convert_coordinates(feat['geometry']['coordinates'])
-                        geo = shape(feat['geometry']).buffer(cl.get('buffer', 0))
+                        geo = shape(feat['geometry'])
+                        if cl.get('buffer'):
+                            geo = geo.buffer(cl.get('buffer'), 4)
                         geos.append((mapping(geo), i + 1))
             result = rasterize(geos, out_shape=(256, 256))
             return ('{!s}-{!s}-{!s}'.format(x, y, z), result)
@@ -277,6 +281,10 @@ def _tile_results_summary(ml_type, classes):
         class_tile_counts = list(np.sum(labels, axis=0))
         for i, cl in enumerate(classes):
             print('{}: {} tiles'.format(cl.get('name'), int(class_tile_counts[i + 1])))
+    elif ml_type == 'segmentation':
+        for i, cl in enumerate(classes):
+            count = len([l for l in labels if class_match(ml_type, l, i + 1)])
+            print('{}: {} tiles'.format(cl.get('name'), count))
 
     print('Total tiles: {}'.format(len(all_tiles)))
 

label_maker/validate.py

@@ -14,7 +14,7 @@
     'type': 'dict',
     'schema': {'name': {'type': 'string', 'required': True},
                'filter': {'type': 'list', 'required': True},
-               'buffer': {'type': 'integer'}}
+               'buffer': {'type': 'float'}}
 }
 
 lat_schema = {'type': 'float', 'min': -90, 'max': 90}

test/fixtures/integration/config.integration.segmentation.json

@@ -0,0 +1,22 @@
+{
+  "country": "portugal",
+  "bounding_box": [
+    -9.4575,
+    38.8467,
+    -9.4510,
+    38.8513
+  ],
+  "zoom": 17,
+  "classes": [
+    { "name": "Water Tower", "filter": ["==", "man_made", "water_tower"], "buffer": 5 },
+    { "name": "Building", "filter": ["has", "building"] },
+    { "name": "Farmland", "filter": ["==", "landuse", "farmland"] },
+    { "name": "Ruins", "filter": ["==", "historic", "ruins"] },
+    { "name": "Parking", "filter": ["==", "amenity", "parking"] },
+    { "name": "Roads", "filter": ["has", "highway"], "buffer": 3 }
+  ],
+  "imagery": "https://api.mapbox.com/v4/mapbox.satellite/{z}/{x}/{y}.jpg?access_token=ACCESS_TOKEN",
+  "background_ratio": 1,
+  "ml_type": "segmentation",
+  "seed": 19
+}

test/verify-labels.py renamed to test/verify-labels-cl.py

@@ -15,14 +15,15 @@
     '62093-50163-17': np.array([0, 0, 0, 0, 1, 1, 1])
 }
 
-labels = np.load('integration/labels.npz')
+labels = np.load('integration-cl/labels.npz')
 assert len(labels.files) == len(expected_labels.keys())  # First check number of tiles
+
 for tile in labels.files:
     assert np.array_equal(expected_labels[tile], labels[tile])  # Now, content
 
 # our GeoJSON looks like the fixture
 expected_geojson = json.load(open('test/fixtures/integration/classification.geojson'))
-geojson = json.load(open('integration/classification.geojson'))
+geojson = json.load(open('integration-cl/classification.geojson'))
 
 for feature in geojson['features']:
     assert feature in expected_geojson['features']
@@ -37,7 +38,7 @@
 Parking: 1 tiles
 Roads: 8 tiles
 Total tiles: 9
-Writing out labels to integration/labels.npz
+Writing out labels to integration-cl/labels.npz
 """
 
 with open('stdout', 'r') as output:

test/verify-labels-sg.py

@@ -0,0 +1,22 @@
+"""Validate that the output produced by integration testing on 'label-maker labels'
+matches our expectations, specifically for segmentation tasks"""
+import numpy as np
+
+# our labels should look like this
+expected_sums = {
+    '62092-50162-17': 0,
+    '62092-50163-17': 2760,
+    '62092-50164-17': 13728,
+    '62093-50162-17': 38004,
+    '62093-50164-17': 2688,
+    '62094-50162-17': 21630,
+    '62094-50164-17': 19440,
+    '62094-50163-17': 21895,
+    '62093-50163-17': 32198
+}
+
+labels = np.load('integration-sg/labels.npz')
+assert len(labels.files) == len(expected_sums.keys())  # First check number of tiles
+
+for tile in labels.files:
+    assert expected_sums[tile] == np.sum(labels[tile])

test/verify-package.py renamed to test/verify-package-cl.py

@@ -1,7 +1,7 @@
 """Validate that the output produced by integration testing on 'label-maker  package' matches our expectations"""
 import numpy as np
 
-data = np.load('integration/data.npz')
+data = np.load('integration-cl/data.npz')
 # validate our image data with sums and shapes
 assert np.sum(data['x_train']) == 144752757
 assert np.sum(data['x_test']) == 52758414

test/verify-sparse-labels.py

@@ -14,14 +14,14 @@
     '62093-50163-17': np.array([0, 0, 0, 0, 1, 1, 1])
 }
 
-labels = np.load('integration/labels.npz')
+labels = np.load('integration-cl/labels.npz')
 assert len(labels.files) == len(expected_labels.keys())  # First check number of tiles
 for tile in labels.files:
     assert np.array_equal(expected_labels[tile], labels[tile])  # Now, content
 
 # our GeoJSON looks like the fixture
 expected_geojson = json.load(open('test/fixtures/integration/classification.geojson'))
-geojson = json.load(open('integration/classification.geojson'))
+geojson = json.load(open('integration-cl/classification.geojson'))
 
 for feature in geojson['features']:
     assert feature in expected_geojson['features']
@@ -37,7 +37,7 @@
 Roads: 8 tiles
 Total tiles: 9
 Using sparse mode; subselected 0 background tiles
-Writing out labels to integration/labels.npz
+Writing out labels to integration-cl/labels.npz
 """
 
 with open('stdout_sparse', 'r') as output: