Commit b9319783 authored by Baptiste CHOCOT's avatar Baptiste CHOCOT
Browse files

update doc

parent 45b3f93a
Pipeline #162353 passed with stage
in 58 seconds
...@@ -23,9 +23,10 @@ def entry_point(url, system_type, location=None, user=None, password=None, ...@@ -23,9 +23,10 @@ def entry_point(url, system_type, location=None, user=None, password=None,
user (str, optional): Username to access the url user (str, optional): Username to access the url
password (str, optional): Password to access the url password (str, optional): Password to access the url
token (str, optional): Token to access the url token (str, optional): Token to access the url
install_cli (bool, optional): Information to know wether CLI has to be install_cli (bool, optional): Information to know whether CLI has to be
installed installed
sha (str, optional): commit SHA or tag to checkout after cloning sha (str, optional): commit SHA or tag to checkout after cloning
name (str, optional): Directory in which the system will be saved
""" """
try: try:
command = system_types[system_type]() command = system_types[system_type]()
......
...@@ -22,7 +22,7 @@ This command requires the following parameters: ...@@ -22,7 +22,7 @@ This command requires the following parameters:
| activity-index | a | True | path to activity index json file | | activity-index | a | True | path to activity index json file |
| chunks | c | True | path to chunks json file | | chunks | c | True | path to chunks json file |
| nb-video-per-chunk | n | False | number of videos in the chunk | | nb-video-per-chunk | n | False | number of videos in the chunk |
| video-location | v | True | path to videos content | | video-location | v | True | path to directory containing video files |
| system-cache-dir | s | True | path to system cache directory | | system-cache-dir | s | True | path to system cache directory |
| config-file | C | False | path to config file | | config-file | C | False | path to config file |
| output-file | o | True | path to merge chunks command result| | output-file | o | True | path to merge chunks command result|
......
...@@ -16,7 +16,7 @@ This command requires the following parameters: ...@@ -16,7 +16,7 @@ This command requires the following parameters:
| file-index | f | True | path to file index json file | | file-index | f | True | path to file index json file |
| activity-index | a | True | path to activity index json file | | activity-index | a | True | path to activity index json file |
| result | R | False | path to result of the ActEV scorer | | result | R | False | path to result of the ActEV scorer |
| score | s | False | sets flag to score system | | score | s | False | sets flag to score the system output against a reference |
## Usage ## Usage
......
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