Commit 43ca261d authored by Maxime Hubert's avatar Maxime Hubert
Browse files

Update CLI documentation

parent 240a83b2
Pipeline #139761 passed with stage
in 31 seconds
......@@ -2,9 +2,17 @@
## Description
Calls a team-implemented API. Captures time stamps, resource usage, etc.
Calls in sequence the following CLI commands:
The command contains the following subcommands:
* experiment_init
* for each chunk,
* pre_process_chunk
* process_chunk
* post_process_chunk
* merge_chunks
* experiment_cleanup
This command requires the following parameters:
## Parameters
......
......@@ -2,9 +2,9 @@
## Description
Close any servers, terminates cluster (future functionality), etc.
Command that deletes any artifact produced by the previous execution of the system: cache files, output files, instances of containers...
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......
......@@ -2,9 +2,9 @@
## Description
Start servers, starts cluster, etc.
Performs any operation that prepares the execution of the system such as booting containers, etc...
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......
......@@ -4,7 +4,7 @@
Given a list of chunk ids, merges all the chunks system output present in the list.
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......@@ -26,5 +26,5 @@ actev merge-chunks -o <path to merging result file> -c <path to summarizing chun
Example:
```
actev merge-chunks -o ~/output.json -c ~/merging_chunks.json -r ~/system_cache_dir/ -i Chunk1 Chunk2
actev merge-chunks -o ~/output.json -c ~/merging_chunks.json -r ~/chunk_dir/ -i Chunk1 Chunk2
```
\ No newline at end of file
......@@ -4,7 +4,7 @@
Post process a chunk
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......
......@@ -4,7 +4,7 @@
Pre process a chunk
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......
......@@ -4,7 +4,7 @@
Process a chunk
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......
......@@ -2,7 +2,7 @@
## Description
Reset a chunk
Deletes the files generated when processing a chunk. Ideally to be able to process the chunk again.
The command contains the following subcommands:
......
......@@ -2,9 +2,8 @@
## Description
Run any compilation/preparation steps for the system.
The command contains the following subcommands:
This command will install all the components and dependencies of your system.
All the operations involving a download from the web should be performed in this step.
## Usage
......
......@@ -2,9 +2,10 @@
## Description
Test the execution of the system on each validation data set provided in container_output directory.
Test the execution using the ActEV scorer on each validation data set provided in container_output directory.
More information about the ActEV scorer at: https://github.com/usnistgov/ActEV_Scorer/
The command contains the following subcommands:
This command requires the following parameters:
## Parameters
......
......@@ -17,6 +17,7 @@ In order to succed:
* < dataset_name >\_file.json
* < dataset_name >\_output.json
This command requires the following parameters:
## Parameters
......
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