-
Notifications
You must be signed in to change notification settings - Fork 0
outputType functions
Output class of pyUDLF. Responsible for handling the result of a UDLF run. This output can be
- log, which contains values such as MAP, P4, P5,...:
- matrix or ranked list, their formats are in the UDLF FORMATS link.
You can get both types of output, they are not mutually exclusive, you just have to request them through the functions mentioned below and if the result of the operation has been requested in the functions you find on the run_calls page.
Description:
This function reads the matrix that is saved in the path defined in the configuration file and returns a variable with it.
Prototype:
- get_matrix()
Parameters:
This function has no parameter.
Return value:
valor de retorno
Example:
TO DO
Description:
This function reads the ranked list that is saved in the path defined in the configuration file and returns a variable with it.
Prototype:
- get_rks(top_k=1000)
Parameters:
top_k -> TO DO
Return value:
valor de retorno
Example:
TO DO
Description:
This function reads the output log of the UDLF run and returns a dictionary with the values.
Prototype:
- get_log()
Parameters:
This function has no parameter.
Return value:
Returns a variable of type dictionary.
Example:
TO DO
Description:
Displays the output log of the UDLF run in a more organized and cleaner way.
Prototype:
- print_log()
Parameters:
This function has no parameter.
Return value:
This function has no return.
Example:
TO DO