Update some documentation

action_recognition/analysis/chunk_visualiser.py

@@ -54,7 +54,7 @@ def visualise_averages(self, nodes, forever=False):
             Key is name of group of chunks, Value is a list with indicies
             of the chunks corresponding to the group.
         forever : boolean, optional, default=False
-            Specifies if the averages should be drawn for a long time or not.
+            Specifies if the averages should be displayed for a long time or not.
 
         """
         visualiser = TrackVisualiser()

action_recognition/augmentors/rotate.py

@@ -4,9 +4,6 @@
 class Rotate:
     """Rotates point clouds for data augmentation.
 
-    Use with care, as you will also need to add corresponding labels to the
-    added points.
-
     Parameters
     ----------
     number_of_added_points : int, optional

action_recognition/tracker/tracker.py

@@ -113,7 +113,6 @@ def video_generator(self, file, draw_frames):
             visualisation_time = time() - visualisation_start_time
 
             if current_frame > 10:
-                # Only yield the recently updated tracks.
                 yield self.tracks, image_with_keypoints, current_frame
 
             if draw_frames:

combine_datasets.py

@@ -52,7 +52,7 @@ def shuffle(chunks, frames, labels, videos):
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(description='Dataset combination.')
     parser.add_argument('--datasets', type=str, nargs='+', help='The datasets to combine.')
-    parser.add_argument('--out-file', type=str, help='Name of the new dataset')
+    parser.add_argument('--out-file', type=str, help='Name of the new dataset.')
 
     args = parser.parse_args()
 

create_dataset.py

@@ -148,7 +148,7 @@ def process_tracks(tracks_file, video, target_frames_per_chunk, overlap_percenta
     parser.add_argument('--tracks-files', type=str, nargs='+',
                         help='The files/folders with the saved tracks.')
     parser.add_argument('--out-file', type=str, default='dataset/dataset.npz',
-                        help='The path to the file where the data will be saved')
+                        help='The path to the file where the data will be saved.')
     parser.add_argument('--append', action='store_true',
                         help=('Specify if the data should be added to the out-file '
                               '(if it exists) or overwritten.'))

doc/modules.rst

@@ -2,6 +2,6 @@ action_recognition
 ==================
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    action_recognition

generate_tracks.py

@@ -38,7 +38,7 @@ def parse_path(video, out_directory, allowed_video_formats):
     parser = argparse.ArgumentParser(
         description=('Generate tracks of people using OpenPose. '
                      'Each track is a [n_frames, n_keypoints, 3] numpy.ndarray which is predicted '
-                     'as being a single person through several frames.'))
+                     'as being a single person through several frames, saved to a .npz file.'))
     parser.add_argument('--video', type=str, default='media/video.avi',
                         help=('The video/folder to run tracking on. If folder, maintains the '
                               'hierarchy within that folder in the output.'))

record_videos.py

@@ -18,6 +18,7 @@ def main(args):
             out_file_video = "{}-{}.mp4".format(args.video_name, i)
             out_file_timestamps = "{}-{}-timestamps.json".format(args.video_name, i)
             ff, start_time = start_recording(out_file_video, args.video_path, args.video_size)
+
             # Sleep in order to allow the program some time to start the recording.
             sleep(2)