From 3393b909ab48e792a2aeddc1f62c1b9197030dff Mon Sep 17 00:00:00 2001 From: "valentin.emiya" <valentin.emiya@lif.univ-mrs.fr> Date: Thu, 4 Jun 2020 16:29:42 +0200 Subject: [PATCH] update doc --- python/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/python/README.rst b/python/README.rst index 7d8ce3c..5ffe9f7 100755 --- a/python/README.rst +++ b/python/README.rst @@ -1,7 +1,7 @@ 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():. -- GitLab