Skip to content

Commit f6be90d

Browse files
committed
update README to include configuration
1 parent 6ba6397 commit f6be90d

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@ For GPU-accelerated tensorflow, ensure you do or have done the following:
7373
1. Setup log folder for Ansible (replace `sjentzsch` with your local user to run Ansible from):
7474

7575
```
76-
sudo mkdir -p /var/log/ansible/ && sudo chown -R sjentzsch:adm /var/log/ansible/ && sudo chmod 2750 /var/log/ansible/
76+
sudo mkdir -p /var/log/ansible/
77+
sudo chown -R sjentzsch:adm /var/log/ansible/
78+
sudo chmod 2750 /var/log/ansible/
7779
```
7880

7981
2. Create a new and clean folder called e.g. `ml` somewhere, and inside, clone `setup_common_lib` and this GitHub repository (here with SSH keys):
@@ -85,7 +87,13 @@ For GPU-accelerated tensorflow, ensure you do or have done the following:
8587

8688
Note: Currently, the repository `setup_common_lib` lives inside restricted BSH SDD.
8789

88-
3. Inside `ml/tf_vision/ansible/` setup your machine by running Ansible:
90+
3. Inside `ml/tf_vision/config/` the YAML file `config.local.sample.yml` contains the default configuration on how to provision your machine.
91+
92+
This includes e.g. enabling or disabling TensorFlow GPU acceleration, TensorFlow version to use, OpenCV version to use, Python version to use.
93+
94+
In order to overwrite default values, create a local copy `cp config.local.sample.yml config.local.yml` and modify values inside `config.local.yml` only.
95+
96+
4. Inside `ml/tf_vision/ansible/` setup your machine by running Ansible:
8997

9098
```
9199
ansible-playbook -i hosts -v local.yml -K
@@ -95,11 +103,17 @@ For GPU-accelerated tensorflow, ensure you do or have done the following:
95103

96104
# Run
97105

98-
Inside `ml/tf_vision/` simply run:
106+
1. Inside `ml/tf_vision/config/` the YAML file `config.obj_detect.sample.yml` contains the default configuration to run.
107+
108+
This includes e.g. the model to use for object detection, the source for the video stream to analyze upon, and if certain components (like the visualizer or the speech synthesis) should be enabled.
99109

100-
```
101-
# Python 2.7
102-
python obj_detect.py
103-
# Python 3.5
104-
python3 obj_detect.py
105-
```
110+
In order to overwrite default values, create a local copy `cp config.obj_detect.sample.yml config.obj_detect.yml` and modify values inside `config.obj_detect.yml` only.
111+
112+
2. Inside `ml/tf_vision/` simply run:
113+
114+
```
115+
# Python 2.7
116+
python obj_detect.py
117+
# Python 3.5
118+
python3 obj_detect.py
119+
```

0 commit comments

Comments
 (0)