Skip to content

Commit 1c204a3

Browse files
committed
Typos and hide toctree
1 parent fd66b46 commit 1c204a3

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

docs/index.rst

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ Command line interface (CLI)
5050

5151
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:
5252

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'``
5557

5658
CLI Step 1: download
5759
^^^^^^^^^^^^^^^^^^^^
@@ -65,11 +67,12 @@ Download and unzip OSM QA tiles containing feature information.
6567
6668
CLI Step 2: labels
6769
^^^^^^^^^^^^^^^^^^
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.
6971

7072
Accepts one additional flag:
7173

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``.
7376

7477
.. code-block:: bash
7578
@@ -83,11 +86,12 @@ Accepts one additional flag:
8386
CLI Step 3: preview (optional)
8487
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8588

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.
8790

8891
Accepts one additional flag:
8992

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``.
9195

9296
.. code-block:: bash
9397
@@ -98,7 +102,7 @@ Accepts one additional flag:
98102
CLI Step 4: images
99103
^^^^^^^^^^^^^^^^^^
100104

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.
102106

103107
.. code-block:: bash
104108
@@ -136,7 +140,7 @@ Once you have a create ``data.npz`` file using the above commands, you can use `
136140
model.fit(x_train, y_train, batch_size=16, epochs=50)
137141
model.evaluate(x_test, y_test, batch_size=16)
138142
139-
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>`_.
140144

141145
Acknowledgements
142146
================
@@ -146,18 +150,11 @@ This library builds on the concepts of `skynet-data <https://github.com/developm
146150
* OSM QA tile data `copyright OpenStreetMap contributors <http://www.openstreetmap.org/copyright>`_ and licensed under `ODbL <http://opendatacommons.org/licenses/odbl/>`_.
147151
* Mapbox Satellite data can be `traced for noncommercial purposes <https://www.mapbox.com/tos/#%5BYmtMIywt%5D>`_.
148152

149-
Table of Contents
150-
=================
153+
151154
.. toctree::
155+
:hidden:
152156
:maxdepth: 2
153157

154158
parameters
155159
examples
156-
contributing
157-
158-
Indices and tables
159-
==================
160-
161-
* :ref:`genindex`
162-
* :ref:`modindex`
163-
* :ref:`search`
160+
contributing

0 commit comments

Comments
 (0)