Skip to content
Snippets Groups Projects
Commit 3393b909 authored by valentin.emiya's avatar valentin.emiya
Browse files

update doc

parent cee4176d
No related branches found
No related tags found
No related merge requests found
Pipeline #5135 passed with warnings
tffpy
=====
:py:mod:tffpy: is a Python package for time-frequency fading using Gabor
:py:mod:`tffpy` is a Python package for time-frequency fading using Gabor
multipliers based on the work in paper *Time-frequency fading algorithms
based on Gabor multipliers* by A. Marina Krémé, Valentin Emiya, Caroline
Chaux and Bruno Torré́sani, 2020.
......@@ -16,7 +16,7 @@ Install the current release with ``pip``::
Download the data from `this link <https://gitlab.lis-lab
.fr/skmad-suite/tff2020/-/tree/master/data>`.
Then run function :py:fun:tffpy.utils.generate_config(): in order to create
Then run function :py:fun:`tffpy.utils.generate_config`: in order to create
a configuration file and modify it to specify the path to your data folder.
The location of the configuration file is given by function
:py:fun:tffpy.utils.get_config_file():.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment