Skip to content

Commit

Permalink
clarified the license implication of pickled models/processors
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Böck committed Feb 26, 2015
1 parent ccd7694 commit dd51883
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
6 changes: 4 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Data/model files:
-----------------

Data and model files usually have .npy, .npz, .h5, .hdf5, .mat file extensions.
Data and model files usually have .npy, .npz, .h5, .hdf5, .pkl or .mat file
extensions.

All model and data files are distributed under the following license:

Expand All @@ -66,4 +67,5 @@ http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode

If you want to include any of these files (or a variation or modification
thereof) or technology which utilises them in a commercial product, please
contact Gerhard Widmer at [email protected].
contact Gerhard Widmer at [email protected]. Please note that pickled
Processors (i.e. saved models) fall into this category.
3 changes: 3 additions & 0 deletions madmom/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ def dump(self, outfile):
"""
import cPickle
import warnings
warnings.warn('The resulting file is considered a model file, please '
'see the LICENSE file for details!')
# close the open file if needed and use its name
if not isinstance(outfile, basestring):
outfile.close()
Expand Down
5 changes: 4 additions & 1 deletion madmom/utils/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,10 @@ def io_arguments(parser):
parser.add_argument('-v', dest='verbose', action='count',
help='increase verbosity level')
parser.add_argument('--pickle', type=str, action='store',
help='pickle the processor to the given file')
help='pickle the processor to the given file (please '
'note that the resulting file is considered a '
'model with all the license restrictions, see '
'the LICENSE file for details.')


class OverrideDefaultListAction(argparse.Action):
Expand Down

0 comments on commit dd51883

Please sign in to comment.