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

update doc

parent 18630d5d
No related branches found
No related tags found
No related merge requests found
Pipeline #5137 canceled
Stage: test
Show whitespace changes
Inline Side-by-side
Showing
with 5 additions and 5 deletions
python/README.rst
+ 5
− 5
View file @ 16ca1186
...@@ -2,9 +2,9 @@ tffpy ...@@ -2,9 +2,9 @@ tffpy
===== =====
A Python package for time-frequency fading using Gabor multipliers based on A Python package for time-frequency fading using Gabor multipliers based on
the work in paper Time-frequency fading algorithms based on Gabor the work in paper *Time-frequency fading algorithms based on Gabor
multipliers by A. Marina Krémé, Valentin Emiya, Caroline Chaux and Bruno multipliers* by A. Marina Krémé, Valentin Emiya, Caroline
Torré́sani, 2020. Chaux and Bruno Torré́sani, 2020.
Install Install
------- -------
...@@ -16,10 +16,10 @@ Install the current release with ``pip``:: ...@@ -16,10 +16,10 @@ Install the current release with ``pip``::
Download the data from `this link <https://gitlab.lis-lab Download the data from `this link <https://gitlab.lis-lab
.fr/skmad-suite/tff2020/-/tree/master/data>`. .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. a configuration file and modify it to specify the path to your data folder.
The location of the configuration file is given by function 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. For additional details, see doc/install.rst.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment