From 29c276280d9b6da3a5b62a545b6c9d6794e94bfa Mon Sep 17 00:00:00 2001
From: "valentin.emiya" <valentin.emiya@lif.univ-mrs.fr>
Date: Thu, 28 May 2020 16:22:36 +0200
Subject: [PATCH] doc
---
README.md | 10 +++++++++
python/README.rst | 5 +++--
python/doc/index.rst | 26 ++++++++++++++--------
python/doc/references.rst | 46 ++++++++++++++++++++++++++++++++++++---
4 files changed, 73 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 681f11e..5ffe8d3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,11 @@
# TFF2020 - Time-Frequency Fading
+
+Code and data to reproduce experiments from paper
+ *Time-frequency fading algorithms based on Gabor multipliers*
+ by A. Marina Krémé, Valentin Emiya, Caroline Chaux and Bruno Torré́sani, 2020.
+
+The sound material is available in folder 'data'.
+
+The code is available in folders 'matlab' and 'python'. The main experiments
+ are available in both programming languages. Some code is only available in
+ one language.
\ No newline at end of file
diff --git a/python/README.rst b/python/README.rst
index 278b644..e82e6ca 100755
--- a/python/README.rst
+++ b/python/README.rst
@@ -3,8 +3,9 @@ tffpy
tffpy: a Python package for time-frequency fading using Gabor multipliers
-TODO: insert a general description here
-
+See paper
+ *Time-frequency fading algorithms based on Gabor multipliers*
+ by A. Marina Krémé, Valentin Emiya, Caroline Chaux and Bruno Torré́sani, 2020.
Install
-------
diff --git a/python/doc/index.rst b/python/doc/index.rst
index c862481..d5e4f4c 100755
--- a/python/doc/index.rst
+++ b/python/doc/index.rst
@@ -4,15 +4,23 @@
Overview
========
-:mod:`tffpy`: time-frequency fading problem and solvers using Gabor
-multipliers, based on works by M. Kreme, V. Emiya, C. Chaux and B. Torrésani
-in 2020.
-
-The package :mod:`tffpy` includes:
-
-* TO
-* BE
-* COMPLETED
+:py:mod:`tffpy`: time-frequency fading problem and solvers using Gabor
+multipliers, based paper
+*Time-frequency fading algorithms based on Gabor multipliers*
+by M. Kreme, V. Emiya, C. Chaux and B. Torrésani in 2020.
+
+The package :py:mod:`tffpy` includes in particular:
+
+* class :py:class:`tffpy.tf_fading.GabMulTff` that implements the proposed
+ solver for reconstructing a source from a mixture and a time-frequency
+ binary mask.
+
+* class :py:class:`tffpy.experiments.exp_solve_tff.SolveTffExperiment` to
+ conduct the main experiment on mixtures of real sounds, with time-frequency
+ masks generated automatically, using the proposed solutions and baseline
+ solvers. Script `tffpy.scripts.script_exp_solve_tff` provide example of
+ code to handle the experiment (configuring, running on a computer grid or a
+ single computer, display results).
Similar and complementary code is available in Matlab.
diff --git a/python/doc/references.rst b/python/doc/references.rst
index 63e19a5..da688d7 100755
--- a/python/doc/references.rst
+++ b/python/doc/references.rst
@@ -4,10 +4,42 @@ References
:Release: |release|
:Date: |today|
-tffpy\.base module
-------------------
+tffpy\.create_subregions module
+-------------------------------
-.. automodule:: tffpy.base
+.. automodule:: tffpy.create_subregions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+tffpy\.datasets module
+----------------------
+
+.. automodule:: tffpy.datasets
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+tffpy\.interpolation_solver module
+----------------------------------
+
+.. automodule:: tffpy.interpolation_solver
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+tffpy\.tf_fading module
+-----------------------
+
+.. automodule:: tffpy.tf_fading
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+tffpy\.tf_tools module
+----------------------
+
+.. automodule:: tffpy.tf_tools
:members:
:undoc-members:
:show-inheritance:
@@ -19,3 +51,11 @@ tffpy\.utils module
:members:
:undoc-members:
:show-inheritance:
+
+tffpy\.experiments\.exp_solve_tff module
+----------------------------------------
+
+.. automodule:: tffpy.experiments.exp_solve_tff
+ :members:
+ :undoc-members:
+ :show-inheritance:
--
GitLab