nussl/core/efz_utils.py
def print_available_benchmark_files():
    """
    Prints a message to the console that shows all of the available benchmark files that are on the
    nussl External File Zoo (EFZ) server (http://nussl.ci.northwestern.edu/).

    Example:
        >>> import nussl
        >>> nussl.efz_utils.print_available_benchmark_files()
        File Name                                For Class            Size       Description
        mix3_matlab_repet_foreground.mat         TestRepet            6.4MiB     Foreground matrix for Repet class benchmark test.
        benchmark_atn_bins.npy                   DuetUnitTests        488.0B     Attenuation bins numpy array for DUET benchmark test.
        benchmark_sym_atn.npy                    DuetUnitTests        3.4MiB     Symmetric attenuation histogram for the DUET benchmark test.
        benchmark_wmat.npy                       DuetUnitTests        3.4MiB     Frequency matrix for the DUET benchmark test.

    To download one of these files insert the file name as the first parameter to nussl.download_benchmark_file, like so:

    >>> nussl.efz_utils.download_benchmark_file('example.npy')

    Notes:
        Most of the entries in the printed list are self-explanatory, but note the ``for_class``
        entry. The ``for_class`` entry specifies which `nussl` benchmark class will load the
        corresponding benchmark file. Make sure these match exactly when writing tests!

    See Also:
        * :func:`get_available_benchmark_files`, prints a list of the benchmark files to the
            console.
        * :func:`download_benchmark_file` to download an benchmark file from the EFZ.

    """
    file_metadata = get_available_benchmark_files()

    print(f'{"File Name":40} {"For Class":15} {"Size":10} {"Description":50}')
    for info in file_metadata:
        print(
            f'{info["file_name"]:40} {info["for_class"]:15} {info["file_size"]:10}'
            f' {info["file_description"]:50}'
        )
    print('To download one of these files insert the file name '
          'as the first parameter to nussl.download_benchmark_file, like so: \n'
          ' >>> nussl.efz_utils.download_benchmark_file(\'example.npy\')')

    Prints a message to the console that shows all of the available benchmark files that are on the
    nussl External File Zoo (EFZ) server (http://nussl.ci.northwestern.edu/).

    Example:
        >>> import nussl
        >>> nussl.efz_utils.print_available_benchmark_files()
        File Name                                For Class            Size       Description
        mix3_matlab_repet_foreground.mat         TestRepet            6.4MiB     Foreground matrix for Repet class benchmark test.
        benchmark_atn_bins.npy                   DuetUnitTests        488.0B     Attenuation bins numpy array for DUET benchmark test.
        benchmark_sym_atn.npy                    DuetUnitTests        3.4MiB     Symmetric attenuation histogram for the DUET benchmark test.
        benchmark_wmat.npy                       DuetUnitTests        3.4MiB     Frequency matrix for the DUET benchmark test.

    To download one of these files insert the file name as the first parameter to nussl.download_benchmark_file, like so:

    >>> nussl.efz_utils.download_benchmark_file('example.npy')

    Notes:
        Most of the entries in the printed list are self-explanatory, but note the ``for_class``
        entry. The ``for_class`` entry specifies which `nussl` benchmark class will load the
        corresponding benchmark file. Make sure these match exactly when writing tests!

    See Also:
        * :func:`get_available_benchmark_files`, prints a list of the benchmark files to the
            console.
        * :func:`download_benchmark_file` to download an benchmark file from the EFZ.

    
Prints a message to the console that shows all of the available benchmark files that are on the
nussl External File Zoo (EFZ) server .
Prints a message to the console that shows all of the available benchmark files that are on the nussl External File Zoo ( EFZ ) server .
def print_available_benchmark_files():
    file_metadata = get_available_benchmark_files()
    print(f'{"File Name":40} {"For Class":15} {"Size":10} {"Description":50}')
    for info in file_metadata:
        print(
            f'{info["file_name"]:40} {info["for_class"]:15} {info["file_size"]:10}'
            f' {info["file_description"]:50}'
        )
    print('To download one of these files insert the file name '
          'as the first parameter to nussl.download_benchmark_file, like so: \n'
          ' >>> nussl.efz_utils.download_benchmark_file(\'example.npy\')')
def print_available_benchmark_files ( ) : file_metadata = get_available_benchmark_files ( ) print ( f'{"File Name":40} {"For Class":15} {"Size":10} {"Description":50}' ) for info in file_metadata : print ( f'{info["file_name"]:40} {info["for_class"]:15} {info["file_size"]:10}' f' {info["file_description"]:50}' ) print ( 'To download one of these files insert the file name ' 'as the first parameter to nussl.download_benchmark_file, like so: \n' ' >>> nussl.efz_utils.download_benchmark_file(\'example.npy\')' )
Prints a message to the console that shows all of the available benchmark files that are on the
nussl External File Zoo (EFZ) server (http://nussl.ci.northwestern.edu/).
Prints a message to the console that shows all of the available benchmark files that are on the nussl External File Zoo ( EFZ ) server ( http : // nussl . ci . northwestern . edu / ) .
"""
    Prints a message to the console that shows all of the available benchmark files that are on the
    nussl External File Zoo (EFZ) server (http://nussl.ci.northwestern.edu/).

    Example:
        >>> import nussl
        >>> nussl.efz_utils.print_available_benchmark_files()
        File Name                                For Class            Size       Description
        mix3_matlab_repet_foreground.mat         TestRepet            6.4MiB     Foreground matrix for Repet class benchmark test.
        benchmark_atn_bins.npy                   DuetUnitTests        488.0B     Attenuation bins numpy array for DUET benchmark test.
        benchmark_sym_atn.npy                    DuetUnitTests        3.4MiB     Symmetric attenuation histogram for the DUET benchmark test.
        benchmark_wmat.npy                       DuetUnitTests        3.4MiB     Frequency matrix for the DUET benchmark test.

    To download one of these files insert the file name as the first parameter to nussl.download_benchmark_file, like so:

    >>> nussl.efz_utils.download_benchmark_file('example.npy')

    Notes:
        Most of the entries in the printed list are self-explanatory, but note the ``for_class``
        entry. The ``for_class`` entry specifies which `nussl` benchmark class will load the
        corresponding benchmark file. Make sure these match exactly when writing tests!

    See Also:
        * :func:`get_available_benchmark_files`, prints a list of the benchmark files to the
            console.
        * :func:`download_benchmark_file` to download an benchmark file from the EFZ.

    """
examples
>>> import nussl
>>> nussl.efz_utils.print_available_benchmark_files()
File Name                                For Class            Size       Description
mix3_matlab_repet_foreground.mat         TestRepet            6.4MiB     Foreground matrix for Repet class benchmark test.
benchmark_atn_bins.npy                   DuetUnitTests        488.0B     Attenuation bins numpy array for DUET benchmark test.
benchmark_sym_atn.npy                    DuetUnitTests        3.4MiB     Symmetric attenuation histogram for the DUET benchmark test.
benchmark_wmat.npy                       DuetUnitTests        3.4MiB     Frequency matrix for the DUET benchmark test.
>>> import nussl >>> nussl . efz_utils . print_available_benchmark_files () File Name For Class Size Description mix3_matlab_repet_foreground . mat TestRepet 6 . 4MiB Foreground matrix for Repet class benchmark test . benchmark_atn_bins . npy DuetUnitTests 488 . 0B Attenuation bins numpy array for DUET benchmark test . benchmark_sym_atn . npy DuetUnitTests 3 . 4MiB Symmetric attenuation histogram for the DUET benchmark test . benchmark_wmat . npy DuetUnitTests 3 . 4MiB Frequency matrix for the DUET benchmark test .