Commit f806192f authored by Alexandre Boyer's avatar Alexandre Boyer
Browse files

modify docstring entry points in bin

parent 2404fdaa
Pipeline #124106 passed with stage
in 27 seconds
"""
ENTRY POINT
"""Entry point module: exec
This file should not be modified.
"""
import os
def entry_point(file_index, activity_index, chunks, nb_videos_per_chunk,
def entry_point(file_index, activity_index, chunks, nb_videos_per_chunk,
video_location, system_cache_dir, output_file, chunks_result, config_file=None):
""" Private entry points.
"""Private entry point.
Calls a team-implemented API. Captures time stamps, resource usage, etc.
Args:
file_index (str): Path to file index json file for test set
activity_index (str): Path to activity index json file for test set
chunks (str): Path to chunks json file
nb-video-per-chunk (int): Number of videos in the chunk
video-location (str): Path to videos content
system-cache-dir (str): Path to system cache directory
output-file (str): Path to merge chunks command result
chunk_result (str): Path to chunks json file after merge chunks execution
config_file (str, optional): Path to config file
"""
if not nb_videos_per_chunk:
nb_videos_per_chunk = "96"
......
"""
ENTRY POINT
"""Entry point module: experiment-init
This file should not be modified.
"""
......@@ -9,7 +8,18 @@ from diva_evaluation_cli.bin.private_src.implementation.experiment_init.experime
def before_entry_point(file_index, activity_index, chunks,
video_location, system_cache_dir, config_file=None):
""" Private entry points.
"""Private entry point.
Start servers, starts cluster, etc.
Args:
file_index(str): Path to file index json file for test set
activity_index(str): Path to activity index json file for test set
chunks (str): Path to chunks json file
video_location (str): Path to videos content
system_cache_dir (str): Path to system cache directory
config_file (str, optional): Path to config file
"""
experiment_validation(file_index, video_location)
"""
ENTRY POINT
"""Entry point module: get-system
This file should not be modified.
"""
......@@ -7,13 +6,24 @@ import os
from diva_evaluation_cli.bin.private_src.implementation.get_system.system_types_definition import system_types
def entry_point(url, system_type, location=None, user=None, password=None, token=None, install_cli=False):
""" Private entry points.
"""Private entry point.
Downloads a credentialed, web-accessible content into src
Args:
url (str): Url to get the system
location (str, optional): Path to store the system
user (str, optional): Username to access the url
password (str, optional): Password to access the url
token (str, optional): Token to access the url
install_cli (bool, optional): Information to know wether CLI has to be installed
"""
try:
command = system_types[system_type]()
script = command.entry_point
except:
raise Exception("Unknown system type")
raise Exception("Unknown system type")
if not location:
location = "None"
......
"""
ENTRY POINT
"""Entry point module: status
This file should not be modified.
"""
......@@ -8,7 +7,13 @@ import os
from diva_evaluation_cli.bin.private_src.implementation.status.check_status import check_status
def entry_point(query_type, chunk_id=None):
""" Private entry points.
"""Private entry point.
Get the status of a chunk id
Args:
query_type (str): status type desired
chunk_id (str, optional): chunk id
"""
check_status(query_type, chunk_id=chunk_id)
......
"""
ENTRY POINT
"""Entry point module: validate-execution
This file should not be modified.
"""
import os
def entry_point(output, reference, activity_index, file_index, result):
""" Private entry points.
"""Private entry point.
Test the execution of the system on each validation data set provided in container_output directory
Args:
output (str): Path to experiment output json file
reference (str): Path to reference json file
file_index (str): Path to file index json file for test set
activity_index (str): Path to activity index json file for test set
result (str): Path to result of the ActEV scorer
"""
# go into the right directory to execute the script
path = os.path.dirname(__file__)
......
"""
ENTRY POINT
"""Entry point module: validate-system
This file should not be modified.
"""
......@@ -7,7 +6,10 @@ import os
from diva_evaluation_cli.bin.private_src.implementation.validate_system.validate_system import validate_system
def entry_point():
""" Private entry points.
"""Private entry point.
Checks the structure of the directory after ActEV-system-setup is run. Checks for expected API contents, etc.
"""
validate_system()
Markdown is supported
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