annotate README.txt @ 4:a1f6a08f624c tip

Completed version 0.0.2
author Francisco Rodriguez Algarra <f.rodriguezalgarra@qmul.ac.uk>
date Tue, 03 Nov 2015 21:24:41 +0000
parents b1cd83874633
children
rev   line source
f@0 1 Re-Evaluation of the Scattering Transform
f@2 2 Version 0.0.2
f@0 3 October 2015
f@0 4
f@1 5 Contact: Francisco Rodríguez-Algarra (f.rodriguezalgarra@qmul.ac.uk)
f@0 6
f@0 7 * LICENSING AND ATTRIBUTION INFORMATION
f@0 8
f@0 9 Copyright (c) 2013 Stéphane Mallat, Laurent Sifre, Joakim Andén, Michel Kapoko, Edouard Oyallon, and Vincent Lostanlen.
f@0 10 Copyright (c) 2015 Francisco Rodríguez-Algarra, and Bob L. Sturm.
f@0 11
f@0 12 For licensing information see the file named LICENSE.
f@0 13
f@0 14 This code is mainly based on the code provided with the following paper:
f@0 15 J. Andén, and S. Mallat, "Deep Scattering Spectrum", IEEE Transactions on Signal Processing, vol. 62, pp. 4114-4128, 2014.
f@0 16
f@0 17 If you use this code, please cite the following paper:
f@0 18 F. Rodríguez-Algarra and B. L. Sturm, "Re-Evaluating the Scattering Transform", in Proc. 16th International Society of Music Information Retrieval Conference (ISMIR'15), Málaga, Spain, Oct. 2015.
f@0 19
f@0 20 * USAGE
f@0 21
f@0 22 This code requires the following libraries:
f@0 23 - ScatNet v0.2
f@0 24 - Compact LIBSVM v0.1
f@0 25 Both libraries can be obtained in: http://www.di.ens.fr/data/software/
f@0 26
f@0 27 It also requires the GTZAN music dataset, available at: http://opihi.cs.uvic.ca/sound/genres.tar.gz
f@0 28
f@4 29 In order to run the experiments, you first need to edit the file "load_files.m", modifying the values of the variables "scatnet_path", "libsvm_compact_path", and "gtzan_path" to point at the locations of the libraries and the dataset in your own system.
f@0 30
f@0 31 You can also modify the location where the results of the experiments will be stored changing the value of the "results_dir" variable.
f@0 32
f@2 33 Once the variables have been properly modified, to run the experiments simply execute the script "scatter_reeval.m" in Matlab, or call the shell script "scatter_reeval.sh" from a Unix terminal.
f@0 34
f@0 35