Commit 16ca1186 authored by valentin.emiya's avatar valentin.emiya

update doc

parent 18630d5d
Pipeline #5137 canceled with stage
in 5 minutes and 24 seconds
......@@ -2,9 +2,9 @@ tffpy
=====
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.
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.
Install
-------
......@@ -16,10 +16,10 @@ 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():.
:py:fun:`tffpy.utils.get_config_file`.
For additional details, see doc/install.rst.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment