Commit 1180f553 authored by Maxime Hubert's avatar Maxime Hubert
Browse files

Update merge-chunks documentation

parent 0b53118e
Pipeline #125535 passed with stage
in 30 seconds
......@@ -15,7 +15,7 @@ class ActevMergeChunks(ActevCommand):
Command args:
* result-location or r: path to get the result of the chunks processing
* chunk-file or c: path to directory where intermediate system output is stored
* chunk-file or c: path to generate a chunk file, that summarizes all the processed videos/activities
* output-file or o: path to the output file generated
* chunk-ids or i: list of chunk ids
......
......@@ -14,7 +14,7 @@ def entry_point(result_location, output_file, chunks_file, chunk_ids):
Args:
result_location (str): Path to get the result of the chunks processing
chunk_file (str): Path to directory where intermediate system output is stored
chunk_file (str): Path to generate a chunk file, that summarizes all the processed videos/activities
output_file (str): Path to the output file generated
chunk_ids (:obj:`list`): List of chunk ids
......
......@@ -11,8 +11,8 @@ The command contains the following subcommands:
| Name | Id | Required | Definition |
|-----------|------------|---------|----------------------------|
| result-location | r | True | path to get the result of the chunks processing |
| chunk-file | c | True | path to directory where intermediate system output is stored |
| output-file | o | True | path to the output file generated |
| chunk-file | c | True | path to generate a chunk file, that summarizes all the processed videos/activities |
| output-file | o | True | path to the output file containing merged chunks results |
| chunk-ids | i | False | list of chunk ids |
## Usage
......@@ -20,7 +20,7 @@ The command contains the following subcommands:
Generic command:
```
actev merge-chunks -o <path to merging result> -c <path to chunks file generated during merging> -r ~/<result directory> -i <list of chunk ids>
actev merge-chunks -o <path to merging result file> -c <path to summarizing chunk file > -r ~/<chunks directory> -i <list of chunk ids>
```
Example:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment