Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ActEV
diva_evaluation_cli
Commits
43ca261d
Commit
43ca261d
authored
Jun 21, 2019
by
Maxime Hubert
Browse files
Update CLI documentation
parent
240a83b2
Pipeline
#139761
passed with stage
in 31 seconds
Changes
11
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
doc/cli_commands/actev_exec.md
View file @
43ca261d
...
...
@@ -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
...
...
doc/cli_commands/actev_experiment_cleanup.md
View file @
43ca261d
...
...
@@ -2,9 +2,9 @@
## Description
C
lose any servers, terminates cluster (future functionality), etc.
C
ommand that deletes any artifact produced by the previous execution of the system: cache files, output files, instances of containers...
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## Parameters
...
...
doc/cli_commands/actev_experiment_init.md
View file @
43ca261d
...
...
@@ -2,9 +2,9 @@
## Description
Start servers, starts clust
er, etc.
Performs any operation that prepares the execution of the system such as booting contain
er
s
, etc.
..
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## Parameters
...
...
doc/cli_commands/actev_merge_chunks.md
View file @
43ca261d
...
...
@@ -4,7 +4,7 @@
Given a list of chunk ids, merges all the chunks system output present in the list.
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## 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
doc/cli_commands/actev_post_process_chunk.md
View file @
43ca261d
...
...
@@ -4,7 +4,7 @@
Post process a chunk
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## Parameters
...
...
doc/cli_commands/actev_pre_process_chunk.md
View file @
43ca261d
...
...
@@ -4,7 +4,7 @@
Pre process a chunk
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## Parameters
...
...
doc/cli_commands/actev_process_chunk.md
View file @
43ca261d
...
...
@@ -4,7 +4,7 @@
Process a chunk
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## Parameters
...
...
doc/cli_commands/actev_reset_chunk.md
View file @
43ca261d
...
...
@@ -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:
...
...
doc/cli_commands/actev_system_setup.md
View file @
43ca261d
...
...
@@ -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
...
...
doc/cli_commands/actev_validate_execution.md
View file @
43ca261d
...
...
@@ -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/
Th
e
command
contain
s the following
subcommand
s:
Th
is
command
require
s the following
parameter
s:
## Parameters
...
...
doc/cli_commands/actev_validate_system.md
View file @
43ca261d
...
...
@@ -17,6 +17,7 @@ In order to succed:
*
<
dataset_name
>
\_
file.json
*
<
dataset_name
>
\_
output.json
This command requires the following parameters:
## Parameters
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment