[Function header] #python #bestpractices

python_function_header.py

def get_accuracy(series, recovered_series):
    """Compare a simulated and recovered series in terms of overall label accuracy.
    
    Input
    -----
        series : list of lists
        recovered_series : list of lists
        
    Output
    ------
        out : dict
        
    Example
    -------
        >>> performance = get_accuracy(series, recovered_series)
        >>> performance
        {'acc': 0.9708, 'baseline': 0.8539}
    """
    
    x = [...]