update doc

diva_evaluation_cli/bin/commands/actev_clear_logs.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.actev_clear_logs import \
     entry_point

diva_evaluation_cli/bin/commands/actev_command.py

@@ -8,7 +8,6 @@ source code.
 """
 
 import abc
-import logging
 import sys
 import os
 

diva_evaluation_cli/bin/commands/actev_exec.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.actev_exec import \
     entry_point

diva_evaluation_cli/bin/commands/actev_experiment_cleanup.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.src.entry_points.actev_experiment_cleanup import \
     entry_point

diva_evaluation_cli/bin/commands/actev_experiment_init.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.actev_experiment_init \
     import before_entry_point

diva_evaluation_cli/bin/commands/actev_get_system.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.actev_get_system import \
     entry_point

diva_evaluation_cli/bin/commands/actev_post_process_chunk.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.src.entry_points.actev_post_process_chunk import \
     entry_point
@@ -41,7 +39,7 @@ class ActevPostProcessChunk(ActevCommand):
 
         required_named.add_argument("-i", "--chunk-id", help="chunk id",
                                     required=True, type=str)
-        arg_parser.add_argument("-s", "--system-cache-dir",
-                                help="path to system cache directory")
+        required_named.add_argument("-s", "--system-cache-dir", required=True,
+                                    help="path to system cache directory")
         arg_parser.set_defaults(
             func=ActevPostProcessChunk.command, object=self)

diva_evaluation_cli/bin/commands/actev_pre_process_chunk.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.src.entry_points.actev_pre_process_chunk import \
     entry_point
@@ -41,6 +39,6 @@ class ActevPreProcessChunk(ActevCommand):
 
         required_named.add_argument(
             "-i", "--chunk-id", help="chunk id", required=True, type=str)
-        arg_parser.add_argument(
-            "-s", "--system-cache-dir", help="path to system cache directory")
+        required_named.add_argument("-s", "--system-cache-dir", required=True,
+                                    help="path to system cache directory")
         arg_parser.set_defaults(func=ActevPreProcessChunk.command, object=self)

diva_evaluation_cli/bin/commands/actev_process_chunk.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.src.entry_points.actev_process_chunk import \
     entry_point
@@ -40,6 +38,6 @@ class ActevProcessChunk(ActevCommand):
 
         required_named.add_argument(
             "-i", "--chunk-id", help="chunk id", required=True, type=str)
-        arg_parser.add_argument(
-            "-s", "--system-cache-dir", help="path to system cache directory")
+        required_named.add_argument("-s", "--system-cache-dir", required=True,
+                                    help="path to system cache directory")
         arg_parser.set_defaults(func=ActevProcessChunk.command, object=self)

diva_evaluation_cli/bin/commands/actev_reset_chunk.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.src.entry_points.actev_reset_chunk import entry_point
 
@@ -38,6 +36,6 @@ class ActevResetChunk(ActevCommand):
 
         required_named.add_argument(
             "-i", "--chunk-id", help="chunk id", required=True, type=str)
-        arg_parser.add_argument(
-            "-s", "--system-cache-dir", help="path to system cache directory")
+        required_named.add_argument("-s", "--system-cache-dir", required=True,
+                                    help="path to system cache directory")
         arg_parser.set_defaults(func=ActevResetChunk.command, object=self)

diva_evaluation_cli/bin/commands/actev_status.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.actev_status import \
     entry_point

diva_evaluation_cli/bin/commands/actev_system_setup.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.src.entry_points.actev_system_setup import entry_point
 
@@ -36,5 +34,5 @@ class ActevSystemSetup(ActevCommand):
 
         arg_parser.add_argument('-d', '--dev', action='store_true',
                                 help='Turn on dev mode (no monitoring/logs)',
-                                default=False, required=False,)
+                                default=False, required=False)
         arg_parser.set_defaults(func=ActevSystemSetup.command, object=self)

diva_evaluation_cli/bin/commands/actev_validate_execution.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.\
     actev_validate_execution import entry_point
@@ -64,9 +62,9 @@ class ActevValidateExecution(ActevCommand):
         required_named.add_argument("-s", "--score",
                                     help="sets flag to score system",
                                     required=False, action='store_true')
-        required_named.add_argument("-l", "--localization",
-                                    help="path to the localization file if it \
-                                    exists", default=None)
+        arg_parser.add_argument("-l", "--localization",
+                                help="path to the localization file if it \
+                                exists", default=None)
 
         arg_parser.set_defaults(
             func=ActevValidateExecution.command, object=self)

diva_evaluation_cli/bin/commands/actev_validate_system.py

@@ -7,8 +7,6 @@ Warning: this file should not be modified: see src/entry_points to add your
 source code.
 """
 
-import logging
-
 from diva_evaluation_cli.bin.commands.actev_command import ActevCommand
 from diva_evaluation_cli.bin.private_src.entry_points.\
     actev_validate_system import entry_point

doc/cli_commands/actev_design_chunks.md

@@ -13,18 +13,18 @@ The command contains the following subcommands:
 | file-index           | f | True        | path to file index json file      |
 | activity-index       | a | True        | path to activity index json file  |
 | output               | o | True        | path to save chunks file          |
-| nb-videos-per-chunk  | n | False       | number of videos in the chunk     |
+| nb-videos-per-chunk  | n | True        | number of videos in the chunk     |
 
 ## Usage
 
 Generic command:
 
-```
+```bash
 actev design-chunks -f <path to file.json> -a <path to activity.json> -o <path to output result> -n <number of video per chunks> 
 ```
 
 Example:
 
-```
+```bash
 actev design-chunks -f ~/file.json -a ~/activity.json -o ~/chunks.json -n 96
 ```

doc/cli_commands/actev_exec.md

@@ -4,13 +4,13 @@
 
 Calls in sequence the following CLI commands:
 
-	* experiment_init
-	* for each chunk,
-        * pre_process_chunk
-        * process_chunk
-        * post_process_chunk
-    * merge_chunks
-	* experiment_cleanup
+* experiment_init
+* for each chunk,
+  * pre_process_chunk
+  * process_chunk
+  * post_process_chunk
+  * merge_chunks
+* experiment_cleanup
 
 This command requires the following parameters:
 
@@ -21,25 +21,23 @@ This command requires the following parameters:
 | file-index         | f | True    | path to file index json file       |
 | activity-index     | a | True    | path to activity index json file   |
 | chunks             | c | True    | path to chunks json file           |
-| nb-video-per-chunk | n | False   | number of videos in the chunk      |
+| nb-videos-per-chunk | n | True   | number of videos in the chunk      |
 | video-location     | v | True    | path to directory containing video files |
 | system-cache-dir   | s | True    | path to system cache directory     |
 | config-file        | C | False   | path to config file                |
 | output-file        | o | True    | path to merge chunks command result|
 | chunk_result       | r | True    | path to chunks json file after merge chunks execution |
 
-
 ## Usage
 
 Generic command:
 
-```
+```bash
 actev exec -f <path to file.json> -a <path to activity.json> -c <path to chunks.json > -n <number of videos per chunk> -v <path to videos directory> -s <path to system cache directory> -C <path to config file.json> -o <path to output.json> -r <path to chunks result>
 ```
 
 Example:
 
-```
+```bash
 actev exec -f ~/file.json -a ~/activity.json -c ~/chunks.json -n 4 -v ~/videos/ -s ~/system_cache_dir/ -o ~/output.json -r ~/chunks_result.json
 ```
-

doc/cli_commands/actev_experiment_cleanup.md

@@ -10,10 +10,10 @@ This command requires the following parameters:
 
 | Name      | Id         | Required | Definition                 |
 |-----------|------------|----------|----------------------------|
-| system-cache-dir       | s | False    | path to system cache directory       |
+| system-cache-dir       | s | True    | path to system cache directory       |
 
 ## Usage
 
-```
+```bash
 actev experiment-cleanup -s $SYSTEM_CACHE_DIR
 ```

doc/cli_commands/actev_experiment_init.md

@@ -13,7 +13,7 @@ This command requires the following parameters:
 | file-index              | f | True    | path to file index json file       |
 | activity-index          | a | True    | path to activity index json file   |
 | chunks                  | c | True    | path to chunks json file           |
-| nb-video-per-chunk      | n | False   | number of videos in the chunk      |
+| nb-videos-per-chunk      | n | True   | number of videos in the chunk      |
 | video-location          | v | True    | path to videos content             |
 | system-cache-dir        | s | True    | path to system cache directory     |
 | config-file             | C | False   | path to config file                |

doc/cli_commands/actev_get_system.md

@@ -7,6 +7,7 @@ Downloads a credentialed, web-accessible content into `/src`.
 The command contains the following subcommands:
 
 ## get-system git
+
 ### Description
 
 Clones a git repository
@@ -27,31 +28,31 @@ Clones a git repository
 
 Generic command:
 
-```
+```bash
 actev get-system git -u <git repository>
 ```
 
-With username and password: 
+With username and password:
 
-```
+```bash
 actev get-system git -u <git repository url> -U <username> -p <password>
 ```
 
-With a token: 
+With a token:
 
-```
+```bash
 actev get-system git -u <git repository url> -t <token>
 ```
 
 Store the system in a specific directory:
 
-```
+```bash
 actev get-system git -u <git repository url> ... -l <location>
 ```
 
 Store the system in a specific directory:
 
-```
+```bash
 actev get-system git -u <git repository url> ... -l <location> -n <directory name>
 ```
 
@@ -59,16 +60,15 @@ actev get-system git -u <git repository url> ... -l <location> -n <directory nam
 
 :warning: if your password or token starts with *-* as in this example: `-9r45ijFo0`, you should write `--password=-9r45ijFo0` instead of `-p -9r45ijFo0`. Otherwise, the value will be interpreted as an argument to parse.
 
-
 Example:
 
-```
+```bash
 actev get-system git -u https://gitlab.kitware.com/actev/diva_evaluation_cli.git -l /tmp
 ```
 
 Switching on a specific commit after cloning:
 
-```
+```bash
 actev get-system git -u <url> -s <commit SHA or tag>
 ```
 
@@ -94,25 +94,25 @@ Downloads a web resources as a zip/tar file
 
 Generic command:
 
-```
+```bash
 actev get-system archive -u <web resource url>
 ```
 
-With username and password: 
+With username and password:
 
-```
+```bash
 actev get-system archive -u <web resource url> -U <username> -p <password>
 ```
 
-With a token: 
+With a token:
 
-```
+```bash
 actev get-system archive -u <web resource url> -t <token>
 ```
 
 Store the system in a specific directory:
 
-```
+```bash
 actev get-system archive -u <web resource url> ... -l <location>
 ```
 
@@ -120,9 +120,8 @@ actev get-system archive -u <web resource url> ... -l <location>
 
 :warning: if your password or token starts with *-* as in this example: `-9r45ijFo0`, you should write `--password=-9r45ijFo0` instead of `-p -9r45ijFo0`. Otherwise, the value will be interpreted as an argument to parse.
 
-
 Example:
 
-```
+```bash
 actev get-system archive -u https://path/to/file.tgz -l /tmp
 ```

doc/cli_commands/actev_post_process_chunk.md

@@ -11,19 +11,18 @@ This command requires the following parameters:
 | Name      | Id         | Required | Definition                 |
 |-----------|------------|---------|----------------------------|
 | chunk-id            | i | True    | chunk id                         |
-| system-cache-dir    | s | False    | path to system cache directory   |
-
+| system-cache-dir    | s | True    | path to system cache directory   |
 
 ## Usage
 
 Generic command:
 
-```
+```bash
 actev post-process-chunk -i <id of a chunk> -s <path to system cache directory>
 ```
 
 Example:
 
-```
+```bash
 actev post-process-chunk -i Chunk1 -s ~/system_cache_dir
-```
\ No newline at end of file
+```