You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.rst
+15-18Lines changed: 15 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,8 +50,10 @@ Command line interface (CLI)
50
50
51
51
Label Maker is most easily used as a command line tool. There are five commands documented below. You should run them in order as each operation builds on the previous one and commands accept two flags:
52
52
53
-
1. ``-d`` or ``--dest``: string specifying directory for storing output files. Default: ``'./data'``
54
-
2. ``-c`` or ``--config``: string specifying location of ``config.json`` file. Default: ``'./config.json'``
53
+
``-d`` or ``--dest``: string
54
+
Directory for storing output files. Defaults to ``'./data'``
55
+
``-c`` or ``--config``: string
56
+
Location of ``config.json`` file. Defaults to ``'./config.json'``
55
57
56
58
CLI Step 1: download
57
59
^^^^^^^^^^^^^^^^^^^^
@@ -65,11 +67,12 @@ Download and unzip OSM QA tiles containing feature information.
65
67
66
68
CLI Step 2: labels
67
69
^^^^^^^^^^^^^^^^^^
68
-
Retiles the OSM data to the desired zoom level, creates label data (``labels.npz``), calculates class statistics, creates visual label files (either GeoJSON or PNG files depending upon ``ml_type``). Requires the mbtiles file from the `label-maker download` step.
70
+
Retiles the OSM data to the desired zoom level, creates label data (``labels.npz``), calculates class statistics, creates visual label files (either GeoJSON or PNG files depending upon ``ml_type``). Requires the mbtiles file from the ``label-maker download`` step.
69
71
70
72
Accepts one additional flag:
71
73
72
-
- ``-s`` or ``--sparse``: *boolean* specifying if class of interest are sparse. If ``True``, only save labels for up to ``n`` background tiles, where ``n`` is equal to ``background_ratio`` times the number of tiles with a class label. Defaults to ``False``.
74
+
``-s`` or ``--sparse``: boolean
75
+
Specifies if features in the class of interest are sparse. If ``True``, only save labels for up to ``n`` background tiles, where ``n`` is equal to ``background_ratio`` times the number of tiles with a class label. Defaults to ``False``.
73
76
74
77
.. code-block:: bash
75
78
@@ -83,11 +86,12 @@ Accepts one additional flag:
83
86
CLI Step 3: preview (optional)
84
87
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
85
88
86
-
Downloads example overhead images for each class. Requires the ``labels.npz`` file from the previous step.
89
+
Downloads example overhead images for each class. Requires the ``labels.npz`` file from the ``label-maker labels`` step.
87
90
88
91
Accepts one additional flag:
89
92
90
-
- ``-n`` or ``--number``: *integer* specifying number of examples images to create per class. Defaults to ``5``.
93
+
``-n`` or ``--number``: int
94
+
Specifies the number of examples images to create per class. Defaults to ``5``.
91
95
92
96
.. code-block:: bash
93
97
@@ -98,7 +102,7 @@ Accepts one additional flag:
98
102
CLI Step 4: images
99
103
^^^^^^^^^^^^^^^^^^
100
104
101
-
Downloads all imagery tiles needed to create the training data. Requires the ``labels.npz`` file from the ``labels`` step.
105
+
Downloads all imagery tiles needed to create the training data. Requires the ``labels.npz`` file from the ``label-maker labels`` step.
102
106
103
107
.. code-block:: bash
104
108
@@ -136,7 +140,7 @@ Once you have a create ``data.npz`` file using the above commands, you can use `
For more detailed walkthroughs, see the `examples page <https://github.com/developmentseed/label-maker/blob/master/examples>`_.
143
+
For more detailed walkthroughs, see the `examples page <examples.html>`_.
140
144
141
145
Acknowledgements
142
146
================
@@ -146,18 +150,11 @@ This library builds on the concepts of `skynet-data <https://github.com/developm
146
150
* OSM QA tile data `copyright OpenStreetMap contributors <http://www.openstreetmap.org/copyright>`_ and licensed under `ODbL <http://opendatacommons.org/licenses/odbl/>`_.
147
151
* Mapbox Satellite data can be `traced for noncommercial purposes <https://www.mapbox.com/tos/#%5BYmtMIywt%5D>`_.
0 commit comments