Skip to content

Commit 74693d6

Browse files
committed
Fixed awkward looking directory trees
1 parent 9b28f03 commit 74693d6

File tree

4 files changed

+150
-148
lines changed

4 files changed

+150
-148
lines changed

docs/build/html/_sources/install.rst.txt

+21-20
Original file line numberDiff line numberDiff line change
@@ -298,15 +298,15 @@ Downloading the TensorFlow Models
298298
- To download the models you can either use `Git <https://git-scm.com/downloads>`_ to clone the `TensorFlow Models repo <https://github.com/tensorflow/models>`_ inside the ``TensorFlow`` folder, or you can simply download it as a `ZIP <https://github.com/tensorflow/models/archive/master.zip>`_ and extract it's contents inside the ``TensorFlow`` folder. To keep things consistent, in the latter case you will have to rename the extracted folder ``models-master`` to ``models``. [#]_
299299
- You should now have a single folder named ``models`` under your ``TensorFlow`` folder, which contains another 4 folders as such:
300300

301-
| TensorFlow
302-
| └─ models
303-
| ├── official
304-
| ├── research
305-
| ├── samples
306-
| ── tutorials
307-
|
308-
|
309-
301+
.. code-block:: bash
302+
303+
TensorFlow
304+
└─ models
305+
├── official
306+
── research
307+
├── samples
308+
└── tutorials
309+
310310
.. [#] The latest repo commit when writing this tutorial is `da903e0 <https://github.com/tensorflow/models/commit/da903e07aea0887d59ebf612557243351ddfb4e6>`_.
311311
312312
Protobuf Installation/Compilation
@@ -484,14 +484,14 @@ To deal with the fact that ``labelImg`` (on Windows) requires the use of ``pyqt4
484484
* Open a new `Anaconda/Command Prompt` window
485485
* Type the following command:
486486

487-
.. code-block:: posh
487+
.. code-block:: bash
488488
489489
conda create -n labelImg pyqt=4
490490
491491
* The above will create a new virtual environment with name ``labelImg``
492492
* Now lets activate the newly created virtual environment by running the following in the `Anaconda Promt` window:
493493

494-
.. code-block:: posh
494+
.. code-block:: bash
495495
496496
activate labelImg
497497
@@ -508,15 +508,16 @@ Downloading labelImg
508508
- To download the package you can either use `Git <https://git-scm.com/downloads>`_ to clone the `labelImg repo <https://github.com/tzutalin/labelImg>`_ inside the ``TensorFlow\addons`` folder, or you can simply download it as a `ZIP <https://github.com/tzutalin/labelImg/archive/master.zip>`_ and extract it's contents inside the ``TensorFlow\addons`` folder. To keep things consistent, in the latter case you will have to rename the extracted folder ``labelImg-master`` to ``labelImg``. [#]_
509509
- You should now have a single folder named ``addons\labelImg`` under your ``TensorFlow`` folder, which contains another 4 folders as such:
510510

511-
| TensorFlow
512-
| ├─ addons
513-
| │ └── labelImg
514-
| └─ models
515-
| ├── official
516-
| ├── research
517-
| ├── samples
518-
| └── tutorials
519-
|
511+
.. code-block:: bash
512+
513+
TensorFlow
514+
├─ addons
515+
│ └── labelImg
516+
└─ models
517+
├── official
518+
├── research
519+
├── samples
520+
└── tutorials
520521
521522
.. [#] The latest repo commit when writing this tutorial is `8d1bd68 <https://github.com/tzutalin/labelImg/commit/8d1bd68ab66e8c311f2f45154729bba301a81f0b>`_.
522523

docs/build/html/_sources/training.rst.txt

+54-54
Original file line numberDiff line numberDiff line change
@@ -19,46 +19,46 @@ Now that we have done all the above, we can start doing some cool stuff. Here we
1919
Preparing workspace
2020
~~~~~~~~~~~~~~~~~~~
2121

22-
If you have followed the tutorial, you should by now have a folder ``Tensorflow``, placed under ``<PATH_TO_TF>`` (e.g. ``C:\Users\sglvladi\Documents``), with the following directory tree:
23-
24-
| TensorFlow
25-
| ├─ addons
26-
| └── labelImg
27-
| └─ models
28-
| ── official
29-
| ├── research
30-
| ├── samples
31-
| ── tutorials
32-
|
33-
|
34-
35-
Now create a new folder under ``TensorFlow`` and call it ``workspace``. It is within the ``workspace`` that we will store all our training set-ups. Now let's go under workspace and create another folder named ``training_demo``. Now our directory structure should be as so:
36-
37-
| TensorFlow
38-
| ├─ addons
39-
| └─ labelImg
40-
| ├─ models
41-
| ├─ official
42-
| ├─ research
43-
| │ ├─ samples
44-
| └─ tutorials
45-
| └─ workspace
46-
| └─ training_demo
47-
|
48-
|
49-
50-
The ``training_demo`` folder shall be our `training folder`, which will contain all files related to our model training. It is advisable to create a separate training folder each time we wish to train a different model. The typical structure for training folders is shown below.
51-
52-
| training_demo
53-
| ├─ annotations
54-
| ├─ images
55-
| ├─ test
56-
| └─ train
57-
| ├─ pre-trained-model
58-
| ├─ training
59-
| └─ README.md
60-
|
61-
|
22+
1. If you have followed the tutorial, you should by now have a folder ``Tensorflow``, placed under ``<PATH_TO_TF>`` (e.g. ``C:\Users\sglvladi\Documents``), with the following directory tree:
23+
24+
.. code-block:: bash
25+
26+
TensorFlow
27+
├─ addons
28+
│ └── labelImg
29+
└─ models
30+
├── official
31+
── research
32+
├── samples
33+
└── tutorials
34+
35+
2. Now create a new folder under ``TensorFlow`` and call it ``workspace``. It is within the ``workspace`` that we will store all our training set-ups. Now let's go under workspace and create another folder named ``training_demo``. Now our directory structure should be as so:
36+
37+
.. code-block:: bash
38+
39+
TensorFlow
40+
├─ addons
41+
└─ labelImg
42+
├─ models
43+
│ ├─ official
44+
├─ research
45+
│ ├─ samples
46+
└─ tutorials
47+
└─ workspace
48+
└─ training_demo
49+
50+
3. The ``training_demo`` folder shall be our `training folder`, which will contain all files related to our model training. It is advisable to create a separate training folder each time we wish to train a different model. The typical structure for training folders is shown below.
51+
52+
.. code-block:: bash
53+
54+
training_demo
55+
├─ annotations
56+
├─ images
57+
├─ test
58+
│ └─ train
59+
├─ pre-trained-model
60+
├─ training
61+
└─ README.md
6262
6363
Here's an explanation for each of the folders/filer shown in the above tree:
6464

@@ -142,20 +142,20 @@ There are two steps in doing so:
142142

143143
Before we proceed to describe the above steps, let's create a directory where we can store some scripts. Under the ``TensorFlow`` folder, create a new folder ``TensorFlow\scripts``, which we can use to store some useful scripts. To make things even tidier, let's create a new folder ``TensorFlow\scripts\preprocessing``, where we shall store scripts that we can use to preprocess our training inputs. Below is out ``TensorFlow`` directory tree structure, up to now:
144144

145-
| TensorFlow
146-
| ├─ addons
147-
| └─ labelImg
148-
| ├─ models
149-
| ├─ official
150-
| ├─ research
151-
| │ ├─ samples
152-
| └─ tutorials
153-
| ├─ scripts
154-
| │ └─ preprocessing
155-
| └─ workspace
156-
| └─ training_demo
157-
|
158-
|
145+
.. code-block:: bash
146+
147+
TensorFlow
148+
├─ addons
149+
└─ labelImg
150+
├─ models
151+
│ ├─ official
152+
├─ research
153+
├─ samples
154+
│ └─ tutorials
155+
├─ scripts
156+
└─ preprocessing
157+
└─ workspace
158+
└─ training_demo
159159
160160
Converting ``*.xml`` to ``*.csv``
161161
---------------------------------

docs/source/install.rst

+21-20
Original file line numberDiff line numberDiff line change
@@ -298,15 +298,15 @@ Downloading the TensorFlow Models
298298
- To download the models you can either use `Git <https://git-scm.com/downloads>`_ to clone the `TensorFlow Models repo <https://github.com/tensorflow/models>`_ inside the ``TensorFlow`` folder, or you can simply download it as a `ZIP <https://github.com/tensorflow/models/archive/master.zip>`_ and extract it's contents inside the ``TensorFlow`` folder. To keep things consistent, in the latter case you will have to rename the extracted folder ``models-master`` to ``models``. [#]_
299299
- You should now have a single folder named ``models`` under your ``TensorFlow`` folder, which contains another 4 folders as such:
300300

301-
| TensorFlow
302-
| └─ models
303-
| ├── official
304-
| ├── research
305-
| ├── samples
306-
| ── tutorials
307-
|
308-
|
309-
301+
.. code-block:: bash
302+
303+
TensorFlow
304+
└─ models
305+
├── official
306+
── research
307+
├── samples
308+
└── tutorials
309+
310310
.. [#] The latest repo commit when writing this tutorial is `da903e0 <https://github.com/tensorflow/models/commit/da903e07aea0887d59ebf612557243351ddfb4e6>`_.
311311
312312
Protobuf Installation/Compilation
@@ -484,14 +484,14 @@ To deal with the fact that ``labelImg`` (on Windows) requires the use of ``pyqt4
484484
* Open a new `Anaconda/Command Prompt` window
485485
* Type the following command:
486486

487-
.. code-block:: posh
487+
.. code-block:: bash
488488
489489
conda create -n labelImg pyqt=4
490490
491491
* The above will create a new virtual environment with name ``labelImg``
492492
* Now lets activate the newly created virtual environment by running the following in the `Anaconda Promt` window:
493493

494-
.. code-block:: posh
494+
.. code-block:: bash
495495
496496
activate labelImg
497497
@@ -508,15 +508,16 @@ Downloading labelImg
508508
- To download the package you can either use `Git <https://git-scm.com/downloads>`_ to clone the `labelImg repo <https://github.com/tzutalin/labelImg>`_ inside the ``TensorFlow\addons`` folder, or you can simply download it as a `ZIP <https://github.com/tzutalin/labelImg/archive/master.zip>`_ and extract it's contents inside the ``TensorFlow\addons`` folder. To keep things consistent, in the latter case you will have to rename the extracted folder ``labelImg-master`` to ``labelImg``. [#]_
509509
- You should now have a single folder named ``addons\labelImg`` under your ``TensorFlow`` folder, which contains another 4 folders as such:
510510

511-
| TensorFlow
512-
| ├─ addons
513-
| │ └── labelImg
514-
| └─ models
515-
| ├── official
516-
| ├── research
517-
| ├── samples
518-
| └── tutorials
519-
|
511+
.. code-block:: bash
512+
513+
TensorFlow
514+
├─ addons
515+
│ └── labelImg
516+
└─ models
517+
├── official
518+
├── research
519+
├── samples
520+
└── tutorials
520521
521522
.. [#] The latest repo commit when writing this tutorial is `8d1bd68 <https://github.com/tzutalin/labelImg/commit/8d1bd68ab66e8c311f2f45154729bba301a81f0b>`_.
522523

docs/source/training.rst

+54-54
Original file line numberDiff line numberDiff line change
@@ -19,46 +19,46 @@ Now that we have done all the above, we can start doing some cool stuff. Here we
1919
Preparing workspace
2020
~~~~~~~~~~~~~~~~~~~
2121

22-
If you have followed the tutorial, you should by now have a folder ``Tensorflow``, placed under ``<PATH_TO_TF>`` (e.g. ``C:\Users\sglvladi\Documents``), with the following directory tree:
23-
24-
| TensorFlow
25-
| ├─ addons
26-
| └── labelImg
27-
| └─ models
28-
| ── official
29-
| ├── research
30-
| ├── samples
31-
| ── tutorials
32-
|
33-
|
34-
35-
Now create a new folder under ``TensorFlow`` and call it ``workspace``. It is within the ``workspace`` that we will store all our training set-ups. Now let's go under workspace and create another folder named ``training_demo``. Now our directory structure should be as so:
36-
37-
| TensorFlow
38-
| ├─ addons
39-
| └─ labelImg
40-
| ├─ models
41-
| ├─ official
42-
| ├─ research
43-
| │ ├─ samples
44-
| └─ tutorials
45-
| └─ workspace
46-
| └─ training_demo
47-
|
48-
|
49-
50-
The ``training_demo`` folder shall be our `training folder`, which will contain all files related to our model training. It is advisable to create a separate training folder each time we wish to train a different model. The typical structure for training folders is shown below.
51-
52-
| training_demo
53-
| ├─ annotations
54-
| ├─ images
55-
| ├─ test
56-
| └─ train
57-
| ├─ pre-trained-model
58-
| ├─ training
59-
| └─ README.md
60-
|
61-
|
22+
1. If you have followed the tutorial, you should by now have a folder ``Tensorflow``, placed under ``<PATH_TO_TF>`` (e.g. ``C:\Users\sglvladi\Documents``), with the following directory tree:
23+
24+
.. code-block:: bash
25+
26+
TensorFlow
27+
├─ addons
28+
│ └── labelImg
29+
└─ models
30+
├── official
31+
── research
32+
├── samples
33+
└── tutorials
34+
35+
2. Now create a new folder under ``TensorFlow`` and call it ``workspace``. It is within the ``workspace`` that we will store all our training set-ups. Now let's go under workspace and create another folder named ``training_demo``. Now our directory structure should be as so:
36+
37+
.. code-block:: bash
38+
39+
TensorFlow
40+
├─ addons
41+
└─ labelImg
42+
├─ models
43+
│ ├─ official
44+
├─ research
45+
│ ├─ samples
46+
└─ tutorials
47+
└─ workspace
48+
└─ training_demo
49+
50+
3. The ``training_demo`` folder shall be our `training folder`, which will contain all files related to our model training. It is advisable to create a separate training folder each time we wish to train a different model. The typical structure for training folders is shown below.
51+
52+
.. code-block:: bash
53+
54+
training_demo
55+
├─ annotations
56+
├─ images
57+
├─ test
58+
│ └─ train
59+
├─ pre-trained-model
60+
├─ training
61+
└─ README.md
6262
6363
Here's an explanation for each of the folders/filer shown in the above tree:
6464

@@ -142,20 +142,20 @@ There are two steps in doing so:
142142

143143
Before we proceed to describe the above steps, let's create a directory where we can store some scripts. Under the ``TensorFlow`` folder, create a new folder ``TensorFlow\scripts``, which we can use to store some useful scripts. To make things even tidier, let's create a new folder ``TensorFlow\scripts\preprocessing``, where we shall store scripts that we can use to preprocess our training inputs. Below is out ``TensorFlow`` directory tree structure, up to now:
144144

145-
| TensorFlow
146-
| ├─ addons
147-
| └─ labelImg
148-
| ├─ models
149-
| ├─ official
150-
| ├─ research
151-
| │ ├─ samples
152-
| └─ tutorials
153-
| ├─ scripts
154-
| │ └─ preprocessing
155-
| └─ workspace
156-
| └─ training_demo
157-
|
158-
|
145+
.. code-block:: bash
146+
147+
TensorFlow
148+
├─ addons
149+
└─ labelImg
150+
├─ models
151+
│ ├─ official
152+
├─ research
153+
├─ samples
154+
│ └─ tutorials
155+
├─ scripts
156+
└─ preprocessing
157+
└─ workspace
158+
└─ training_demo
159159
160160
Converting ``*.xml`` to ``*.csv``
161161
---------------------------------

0 commit comments

Comments
 (0)