├── model.png ├── README.md ├── squeezenet_demo.py ├── model.py └── LICENSE.md /model.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DT42/squeezenet_demo/HEAD/model.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SqueezeNet Keras Implementation 2 | This is the Keras implementation of SqueezeNet using functional API (arXiv [1602.07360](https://arxiv.org/pdf/1602.07360.pdf)). 3 | SqueezeNet is a small model of AlexNet-level accuracy with 50x fewer parameters and <0.5MB model size. 4 | The original model was implemented in [caffe](https://github.com/DeepScale/SqueezeNet). 5 | 6 | ## Reference 7 | [pysqueezenet by yhenon](https://github.com/yhenon/pysqueezenet) 8 | 9 | Differences: 10 | * Switch from Graph model to Keras 1.0 functional API 11 | * Fix the bug of pooling layer 12 | * Many thanks to [StefOe](https://github.com/StefOe), the source can now support Keras 2.0 API. 13 | 14 | ## Result 15 | This repository contains only the Keras implementation of the model, for other parameters used, please see the demo script, [squeezenet_demo.py](https://github.com/tammyyang/simdat/blob/devel/examples/keras/squeezenet_demo.py) in the simdat package. 16 | 17 | The training process uses a total of 2,600 images with 1,300 images per class (so, total two classes only). 18 | There are a total 130 images used for validation. After 20 epochs, the model achieves the following: 19 | ``` 20 | loss: 0.6563 - acc: 0.7065 - val_loss: 0.6247 - val_acc: 0.8750 21 | ``` 22 | 23 | ## Model Visualization 24 | ![](model.png) 25 | -------------------------------------------------------------------------------- /squeezenet_demo.py: -------------------------------------------------------------------------------- 1 | """ 2 | Usage: 3 | 1. training 4 | python squeezenet_demo.py --action='train'\ 5 | -p /home/db/train -v /home/db/validation 6 | 2. prediction 7 | python squeezenet_demo.py --action='predice'\ 8 | -p /db/Roasted-Broccoli-Pasta-Recipe-5-683x1024.jpg 9 | """ 10 | import time 11 | import json 12 | import argparse 13 | import model as km 14 | from simdat.core import dp_tools 15 | from keras.optimizers import Adam 16 | from keras.optimizers import SGD 17 | 18 | dp = dp_tools.DP() 19 | 20 | 21 | def parse_json(fname): 22 | """Parse the input profile 23 | 24 | @param fname: input profile path 25 | 26 | @return data: a dictionary with user-defined data for training 27 | 28 | """ 29 | with open(fname) as data_file: 30 | data = json.load(data_file) 31 | return data 32 | 33 | 34 | def write_json(data, fname='./output.json'): 35 | """Write data to json 36 | 37 | @param data: object to be written 38 | 39 | Keyword arguments: 40 | fname -- output filename (default './output.json') 41 | 42 | """ 43 | with open(fname, 'w') as fp: 44 | json.dump(data, fp, cls=NumpyAwareJSONEncoder) 45 | 46 | 47 | def print_time(t0, s): 48 | """Print how much time has been spent 49 | 50 | @param t0: previous timestamp 51 | @param s: description of this step 52 | 53 | """ 54 | 55 | print("%.5f seconds to %s" % ((time.time() - t0), s)) 56 | return time.time() 57 | 58 | 59 | def main(): 60 | parser = argparse.ArgumentParser( 61 | description="SqueezeNet example." 62 | ) 63 | parser.add_argument( 64 | "--batch-size", type=int, default=32, dest='batchsize', 65 | help="Size of the mini batch. Default: 32." 66 | ) 67 | parser.add_argument( 68 | "--action", type=str, default='train', 69 | help="Action to be performed, train/predict" 70 | ) 71 | parser.add_argument( 72 | "--epochs", type=int, default=20, 73 | help="Number of epochs, default 20." 74 | ) 75 | parser.add_argument( 76 | "--lr", type=float, default=0.001, 77 | help="Learning rate of SGD, default 0.001." 78 | ) 79 | parser.add_argument( 80 | "--epsilon", type=float, default=1e-8, 81 | help="Epsilon of Adam epsilon, default 1e-8." 82 | ) 83 | parser.add_argument( 84 | "-p", "--path", type=str, default='.', required=True, 85 | help="Path where the images are. Default: $PWD." 86 | ) 87 | parser.add_argument( 88 | "-v", "--val-path", type=str, default='.', 89 | dest='valpath', help="Path where the val images are. Default: $PWD." 90 | ) 91 | parser.add_argument( 92 | "--img-width", type=int, default=224, dest='width', 93 | help="Rows of the images, default: 224." 94 | ) 95 | parser.add_argument( 96 | "--img-height", type=int, default=224, dest='height', 97 | help="Columns of the images, default: 224." 98 | ) 99 | parser.add_argument( 100 | "--channels", type=int, default=3, 101 | help="Channels of the images, default: 3." 102 | ) 103 | 104 | args = parser.parse_args() 105 | sgd = SGD(lr=args.lr, decay=0.0002, momentum=0.9) 106 | 107 | t0 = time.time() 108 | if args.action == 'train': 109 | train_generator = dp.train_data_generator( 110 | args.path, args.width, args.height) 111 | validation_generator = dp.val_data_generator( 112 | args.valpath, args.width, args.height) 113 | 114 | classes = train_generator.class_indices 115 | nb_train_samples = train_generator.samples 116 | nb_val_samples = validation_generator.samples 117 | print("[squeezenet_demo] N training samples: %i " % nb_train_samples) 118 | print("[squeezenet_demo] N validation samples: %i " % nb_val_samples) 119 | nb_class = train_generator.num_class 120 | print('[squeezenet_demo] Total classes are %i' % nb_class) 121 | 122 | t0 = print_time(t0, 'initialize data') 123 | model = km.SqueezeNet( 124 | nb_class, inputs=(args.channels, args.height, args.width)) 125 | # dp.visualize_model(model) 126 | t0 = print_time(t0, 'build the model') 127 | 128 | model.compile( 129 | optimizer=sgd, loss='categorical_crossentropy', 130 | metrics=['accuracy']) 131 | t0 = print_time(t0, 'compile model') 132 | 133 | model.fit_generator( 134 | train_generator, 135 | samples_per_epoch=nb_train_samples, 136 | nb_epoch=args.epochs, 137 | validation_data=validation_generator, 138 | nb_val_samples=nb_val_samples) 139 | t0 = print_time(t0, 'train model') 140 | 141 | model.save_weights('./weights.h5', overwrite=True) 142 | model_parms = {'nb_class': nb_class, 143 | 'nb_train_samples': nb_train_samples, 144 | 'nb_val_samples': nb_val_samples, 145 | 'classes': classes, 146 | 'channels': args.channels, 147 | 'height': args.height, 148 | 'width': args.width} 149 | write_json(model_parms, fname='./model_parms.json') 150 | t0 = print_time(t0, 'save model') 151 | 152 | elif args.action == 'predict': 153 | _parms = parse_json('./model_parms.json') 154 | model = km.SqueezeNet( 155 | _parms['nb_class'], 156 | inputs=(_parms['channels'], _parms['height'], _parms['width']), 157 | weights_path='./weights.h5') 158 | dp.visualize_model(model) 159 | model.compile( 160 | optimizer=sgd, loss='categorical_crossentropy', 161 | metrics=['accuracy']) 162 | 163 | X_test, Y_test, classes, F = dp.prepare_data_test( 164 | args.path, args.width, args.height) 165 | t0 = print_time(t0, 'prepare data') 166 | 167 | outputs = [] 168 | results = model.predict( 169 | X_test, batch_size=args.batchsize, verbose=1) 170 | classes = _parms['classes'] 171 | for i in range(0, len(F)): 172 | _cls = results[i].argmax() 173 | max_prob = results[i][_cls] 174 | outputs.append({'input': F[i], 'max_probability': max_prob}) 175 | cls = [key for key in classes if classes[key] == _cls][0] 176 | outputs[-1]['class'] = cls 177 | print('[squeezenet_demo] %s: %s (%.2f)' % (F[i], cls, max_prob)) 178 | t0 = print_time(t0, 'predict') 179 | 180 | if __name__ == '__main__': 181 | main() 182 | -------------------------------------------------------------------------------- /model.py: -------------------------------------------------------------------------------- 1 | import h5py 2 | from keras.models import Model 3 | from keras.layers import Input, Activation, Concatenate 4 | from keras.layers import Flatten, Dropout 5 | from keras.layers import Convolution2D, MaxPooling2D 6 | from keras.layers import GlobalAveragePooling2D 7 | 8 | 9 | def SqueezeNet(nb_classes, inputs=(3, 224, 224)): 10 | """ Keras Implementation of SqueezeNet(arXiv 1602.07360) 11 | 12 | @param nb_classes: total number of final categories 13 | 14 | Arguments: 15 | inputs -- shape of the input images (channel, cols, rows) 16 | 17 | """ 18 | 19 | input_img = Input(shape=inputs) 20 | conv1 = Convolution2D( 21 | 96, (7, 7), activation='relu', kernel_initializer='glorot_uniform', 22 | strides=(2, 2), padding='same', name='conv1', 23 | data_format="channels_first")(input_img) 24 | maxpool1 = MaxPooling2D( 25 | pool_size=(3, 3), strides=(2, 2), name='maxpool1', 26 | data_format="channels_first")(conv1) 27 | fire2_squeeze = Convolution2D( 28 | 16, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 29 | padding='same', name='fire2_squeeze', 30 | data_format="channels_first")(maxpool1) 31 | fire2_expand1 = Convolution2D( 32 | 64, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 33 | padding='same', name='fire2_expand1', 34 | data_format="channels_first")(fire2_squeeze) 35 | fire2_expand2 = Convolution2D( 36 | 64, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 37 | padding='same', name='fire2_expand2', 38 | data_format="channels_first")(fire2_squeeze) 39 | merge2 = Concatenate(axis=1)([fire2_expand1, fire2_expand2]) 40 | 41 | fire3_squeeze = Convolution2D( 42 | 16, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 43 | padding='same', name='fire3_squeeze', 44 | data_format="channels_first")(merge2) 45 | fire3_expand1 = Convolution2D( 46 | 64, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 47 | padding='same', name='fire3_expand1', 48 | data_format="channels_first")(fire3_squeeze) 49 | fire3_expand2 = Convolution2D( 50 | 64, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 51 | padding='same', name='fire3_expand2', 52 | data_format="channels_first")(fire3_squeeze) 53 | merge3 = Concatenate(axis=1)([fire3_expand1, fire3_expand2]) 54 | 55 | fire4_squeeze = Convolution2D( 56 | 32, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 57 | padding='same', name='fire4_squeeze', 58 | data_format="channels_first")(merge3) 59 | fire4_expand1 = Convolution2D( 60 | 128, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 61 | padding='same', name='fire4_expand1', 62 | data_format="channels_first")(fire4_squeeze) 63 | fire4_expand2 = Convolution2D( 64 | 128, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 65 | padding='same', name='fire4_expand2', 66 | data_format="channels_first")(fire4_squeeze) 67 | merge4 = Concatenate(axis=1)([fire4_expand1, fire4_expand2]) 68 | maxpool4 = MaxPooling2D( 69 | pool_size=(3, 3), strides=(2, 2), name='maxpool4', 70 | data_format="channels_first")(merge4) 71 | 72 | fire5_squeeze = Convolution2D( 73 | 32, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 74 | padding='same', name='fire5_squeeze', 75 | data_format="channels_first")(maxpool4) 76 | fire5_expand1 = Convolution2D( 77 | 128, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 78 | padding='same', name='fire5_expand1', 79 | data_format="channels_first")(fire5_squeeze) 80 | fire5_expand2 = Convolution2D( 81 | 128, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 82 | padding='same', name='fire5_expand2', 83 | data_format="channels_first")(fire5_squeeze) 84 | merge5 = Concatenate(axis=1)([fire5_expand1, fire5_expand2]) 85 | 86 | fire6_squeeze = Convolution2D( 87 | 48, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 88 | padding='same', name='fire6_squeeze', 89 | data_format="channels_first")(merge5) 90 | fire6_expand1 = Convolution2D( 91 | 192, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 92 | padding='same', name='fire6_expand1', 93 | data_format="channels_first")(fire6_squeeze) 94 | fire6_expand2 = Convolution2D( 95 | 192, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 96 | padding='same', name='fire6_expand2', 97 | data_format="channels_first")(fire6_squeeze) 98 | merge6 = Concatenate(axis=1)([fire6_expand1, fire6_expand2]) 99 | 100 | fire7_squeeze = Convolution2D( 101 | 48, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 102 | padding='same', name='fire7_squeeze', 103 | data_format="channels_first")(merge6) 104 | fire7_expand1 = Convolution2D( 105 | 192, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 106 | padding='same', name='fire7_expand1', 107 | data_format="channels_first")(fire7_squeeze) 108 | fire7_expand2 = Convolution2D( 109 | 192, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 110 | padding='same', name='fire7_expand2', 111 | data_format="channels_first")(fire7_squeeze) 112 | merge7 = Concatenate(axis=1)([fire7_expand1, fire7_expand2]) 113 | 114 | fire8_squeeze = Convolution2D( 115 | 64, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 116 | padding='same', name='fire8_squeeze', 117 | data_format="channels_first")(merge7) 118 | fire8_expand1 = Convolution2D( 119 | 256, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 120 | padding='same', name='fire8_expand1', 121 | data_format="channels_first")(fire8_squeeze) 122 | fire8_expand2 = Convolution2D( 123 | 256, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 124 | padding='same', name='fire8_expand2', 125 | data_format="channels_first")(fire8_squeeze) 126 | merge8 = Concatenate(axis=1)([fire8_expand1, fire8_expand2]) 127 | 128 | maxpool8 = MaxPooling2D( 129 | pool_size=(3, 3), strides=(2, 2), name='maxpool8', 130 | data_format="channels_first")(merge8) 131 | fire9_squeeze = Convolution2D( 132 | 64, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 133 | padding='same', name='fire9_squeeze', 134 | data_format="channels_first")(maxpool8) 135 | fire9_expand1 = Convolution2D( 136 | 256, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 137 | padding='same', name='fire9_expand1', 138 | data_format="channels_first")(fire9_squeeze) 139 | fire9_expand2 = Convolution2D( 140 | 256, (3, 3), activation='relu', kernel_initializer='glorot_uniform', 141 | padding='same', name='fire9_expand2', 142 | data_format="channels_first")(fire9_squeeze) 143 | merge9 = Concatenate(axis=1)([fire9_expand1, fire9_expand2]) 144 | 145 | fire9_dropout = Dropout(0.5, name='fire9_dropout')(merge9) 146 | conv10 = Convolution2D( 147 | nb_classes, (1, 1), activation='relu', kernel_initializer='glorot_uniform', 148 | padding='valid', name='conv10', 149 | data_format="channels_first")(fire9_dropout) 150 | 151 | global_avgpool10 = GlobalAveragePooling2D(data_format='channels_first')(conv10) 152 | softmax = Activation("softmax", name='softmax')(global_avgpool10) 153 | 154 | return Model(inputs=input_img, outputs=softmax) 155 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 [Free Software Foundation, Inc.](http://fsf.org/) 5 | 6 | Everyone is permitted to copy and distribute verbatim copies of this license 7 | document, but changing it is not allowed. 8 | 9 | ## Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for software and 12 | other kinds of works. 13 | 14 | The licenses for most software and other practical works are designed to take 15 | away your freedom to share and change the works. By contrast, the GNU General 16 | Public License is intended to guarantee your freedom to share and change all 17 | versions of a program--to make sure it remains free software for all its users. 18 | We, the Free Software Foundation, use the GNU General Public License for most 19 | of our software; it applies also to any other work released this way by its 20 | authors. You can apply it to your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not price. Our 23 | General Public Licenses are designed to make sure that you have the freedom to 24 | distribute copies of free software (and charge for them if you wish), that you 25 | receive source code or can get it if you want it, that you can change the 26 | software or use pieces of it in new free programs, and that you know you can do 27 | these things. 28 | 29 | To protect your rights, we need to prevent others from denying you these rights 30 | or asking you to surrender the rights. Therefore, you have certain 31 | responsibilities if you distribute copies of the software, or if you modify it: 32 | responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether gratis or for 35 | a fee, you must pass on to the recipients the same freedoms that you received. 36 | You must make sure that they, too, receive or can get the source code. And you 37 | must show them these terms so they know their rights. 38 | 39 | Developers that use the GNU GPL protect your rights with two steps: 40 | 41 | 1. assert copyright on the software, and 42 | 2. offer you this License giving you legal permission to copy, distribute 43 | and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains that 46 | there is no warranty for this free software. For both users' and authors' sake, 47 | the GPL requires that modified versions be marked as changed, so that their 48 | problems will not be attributed erroneously to authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run modified 51 | versions of the software inside them, although the manufacturer can do so. This 52 | is fundamentally incompatible with the aim of protecting users' freedom to 53 | change the software. The systematic pattern of such abuse occurs in the area of 54 | products for individuals to use, which is precisely where it is most 55 | unacceptable. Therefore, we have designed this version of the GPL to prohibit 56 | the practice for those products. If such problems arise substantially in other 57 | domains, we stand ready to extend this provision to those domains in future 58 | versions of the GPL, as needed to protect the freedom of users. 59 | 60 | Finally, every program is threatened constantly by software patents. States 61 | should not allow patents to restrict development and use of software on 62 | general-purpose computers, but in those that do, we wish to avoid the special 63 | danger that patents applied to a free program could make it effectively 64 | proprietary. To prevent this, the GPL assures that patents cannot be used to 65 | render the program non-free. 66 | 67 | The precise terms and conditions for copying, distribution and modification 68 | follow. 69 | 70 | ## TERMS AND CONDITIONS 71 | 72 | ### 0. Definitions. 73 | 74 | *This License* refers to version 3 of the GNU General Public License. 75 | 76 | *Copyright* also means copyright-like laws that apply to other kinds of works, 77 | such as semiconductor masks. 78 | 79 | *The Program* refers to any copyrightable work licensed under this License. 80 | Each licensee is addressed as *you*. *Licensees* and *recipients* may be 81 | individuals or organizations. 82 | 83 | To *modify* a work means to copy from or adapt all or part of the work in a 84 | fashion requiring copyright permission, other than the making of an exact copy. 85 | The resulting work is called a *modified version* of the earlier work or a work 86 | *based on* the earlier work. 87 | 88 | A *covered work* means either the unmodified Program or a work based on the 89 | Program. 90 | 91 | To *propagate* a work means to do anything with it that, without permission, 92 | would make you directly or secondarily liable for infringement under applicable 93 | copyright law, except executing it on a computer or modifying a private copy. 94 | Propagation includes copying, distribution (with or without modification), 95 | making available to the public, and in some countries other activities as well. 96 | 97 | To *convey* a work means any kind of propagation that enables other parties to 98 | make or receive copies. Mere interaction with a user through a computer 99 | network, with no transfer of a copy, is not conveying. 100 | 101 | An interactive user interface displays *Appropriate Legal Notices* to the 102 | extent that it includes a convenient and prominently visible feature that 103 | 104 | 1. displays an appropriate copyright notice, and 105 | 2. tells the user that there is no warranty for the work (except to the 106 | extent that warranties are provided), that licensees may convey the work 107 | under this License, and how to view a copy of this License. 108 | 109 | If the interface presents a list of user commands or options, such as a menu, a 110 | prominent item in the list meets this criterion. 111 | 112 | ### 1. Source Code. 113 | 114 | The *source code* for a work means the preferred form of the work for making 115 | modifications to it. *Object code* means any non-source form of a work. 116 | 117 | A *Standard Interface* means an interface that either is an official standard 118 | defined by a recognized standards body, or, in the case of interfaces specified 119 | for a particular programming language, one that is widely used among developers 120 | working in that language. 121 | 122 | The *System Libraries* of an executable work include anything, other than the 123 | work as a whole, that (a) is included in the normal form of packaging a Major 124 | Component, but which is not part of that Major Component, and (b) serves only 125 | to enable use of the work with that Major Component, or to implement a Standard 126 | Interface for which an implementation is available to the public in source code 127 | form. A *Major Component*, in this context, means a major essential component 128 | (kernel, window system, and so on) of the specific operating system (if any) on 129 | which the executable work runs, or a compiler used to produce the work, or an 130 | object code interpreter used to run it. 131 | 132 | The *Corresponding Source* for a work in object code form means all the source 133 | code needed to generate, install, and (for an executable work) run the object 134 | code and to modify the work, including scripts to control those activities. 135 | However, it does not include the work's System Libraries, or general-purpose 136 | tools or generally available free programs which are used unmodified in 137 | performing those activities but which are not part of the work. For example, 138 | Corresponding Source includes interface definition files associated with source 139 | files for the work, and the source code for shared libraries and dynamically 140 | linked subprograms that the work is specifically designed to require, such as 141 | by intimate data communication or control flow between those subprograms and 142 | other parts of the work. 143 | 144 | The Corresponding Source need not include anything that users can regenerate 145 | automatically from other parts of the Corresponding Source. 146 | 147 | The Corresponding Source for a work in source code form is that same work. 148 | 149 | ### 2. Basic Permissions. 150 | 151 | All rights granted under this License are granted for the term of copyright on 152 | the Program, and are irrevocable provided the stated conditions are met. This 153 | License explicitly affirms your unlimited permission to run the unmodified 154 | Program. The output from running a covered work is covered by this License only 155 | if the output, given its content, constitutes a covered work. This License 156 | acknowledges your rights of fair use or other equivalent, as provided by 157 | copyright law. 158 | 159 | You may make, run and propagate covered works that you do not convey, without 160 | conditions so long as your license otherwise remains in force. You may convey 161 | covered works to others for the sole purpose of having them make modifications 162 | exclusively for you, or provide you with facilities for running those works, 163 | provided that you comply with the terms of this License in conveying all 164 | material for which you do not control copyright. Those thus making or running 165 | the covered works for you must do so exclusively on your behalf, under your 166 | direction and control, on terms that prohibit them from making any copies of 167 | your copyrighted material outside their relationship with you. 168 | 169 | Conveying under any other circumstances is permitted solely under the 170 | conditions stated below. Sublicensing is not allowed; section 10 makes it 171 | unnecessary. 172 | 173 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 174 | 175 | No covered work shall be deemed part of an effective technological measure 176 | under any applicable law fulfilling obligations under article 11 of the WIPO 177 | copyright treaty adopted on 20 December 1996, or similar laws prohibiting or 178 | restricting circumvention of such measures. 179 | 180 | When you convey a covered work, you waive any legal power to forbid 181 | circumvention of technological measures to the extent such circumvention is 182 | effected by exercising rights under this License with respect to the covered 183 | work, and you disclaim any intention to limit operation or modification of the 184 | work as a means of enforcing, against the work's users, your or third parties' 185 | legal rights to forbid circumvention of technological measures. 186 | 187 | ### 4. Conveying Verbatim Copies. 188 | 189 | You may convey verbatim copies of the Program's source code as you receive it, 190 | in any medium, provided that you conspicuously and appropriately publish on 191 | each copy an appropriate copyright notice; keep intact all notices stating that 192 | this License and any non-permissive terms added in accord with section 7 apply 193 | to the code; keep intact all notices of the absence of any warranty; and give 194 | all recipients a copy of this License along with the Program. 195 | 196 | You may charge any price or no price for each copy that you convey, and you may 197 | offer support or warranty protection for a fee. 198 | 199 | ### 5. Conveying Modified Source Versions. 200 | 201 | You may convey a work based on the Program, or the modifications to produce it 202 | from the Program, in the form of source code under the terms of section 4, 203 | provided that you also meet all of these conditions: 204 | 205 | - a) The work must carry prominent notices stating that you modified it, and 206 | giving a relevant date. 207 | - b) The work must carry prominent notices stating that it is released under 208 | this License and any conditions added under section 7. This requirement 209 | modifies the requirement in section 4 to *keep intact all notices*. 210 | - c) You must license the entire work, as a whole, under this License to 211 | anyone who comes into possession of a copy. This License will therefore 212 | apply, along with any applicable section 7 additional terms, to the whole 213 | of the work, and all its parts, regardless of how they are packaged. This 214 | License gives no permission to license the work in any other way, but it 215 | does not invalidate such permission if you have separately received it. 216 | - d) If the work has interactive user interfaces, each must display 217 | Appropriate Legal Notices; however, if the Program has interactive 218 | interfaces that do not display Appropriate Legal Notices, your work need 219 | not make them do so. 220 | 221 | A compilation of a covered work with other separate and independent works, 222 | which are not by their nature extensions of the covered work, and which are not 223 | combined with it such as to form a larger program, in or on a volume of a 224 | storage or distribution medium, is called an *aggregate* if the compilation and 225 | its resulting copyright are not used to limit the access or legal rights of the 226 | compilation's users beyond what the individual works permit. Inclusion of a 227 | covered work in an aggregate does not cause this License to apply to the other 228 | parts of the aggregate. 229 | 230 | ### 6. Conveying Non-Source Forms. 231 | 232 | You may convey a covered work in object code form under the terms of sections 4 233 | and 5, provided that you also convey the machine-readable Corresponding Source 234 | under the terms of this License, in one of these ways: 235 | 236 | - a) Convey the object code in, or embodied in, a physical product (including 237 | a physical distribution medium), accompanied by the Corresponding Source 238 | fixed on a durable physical medium customarily used for software 239 | interchange. 240 | - b) Convey the object code in, or embodied in, a physical product (including 241 | a physical distribution medium), accompanied by a written offer, valid for 242 | at least three years and valid for as long as you offer spare parts or 243 | customer support for that product model, to give anyone who possesses the 244 | object code either 245 | 1. a copy of the Corresponding Source for all the software in the product 246 | that is covered by this License, on a durable physical medium 247 | customarily used for software interchange, for a price no more than your 248 | reasonable cost of physically performing this conveying of source, or 249 | 2. access to copy the Corresponding Source from a network server at no 250 | charge. 251 | - c) Convey individual copies of the object code with a copy of the written 252 | offer to provide the Corresponding Source. This alternative is allowed only 253 | occasionally and noncommercially, and only if you received the object code 254 | with such an offer, in accord with subsection 6b. 255 | - d) Convey the object code by offering access from a designated place 256 | (gratis or for a charge), and offer equivalent access to the Corresponding 257 | Source in the same way through the same place at no further charge. You 258 | need not require recipients to copy the Corresponding Source along with the 259 | object code. If the place to copy the object code is a network server, the 260 | Corresponding Source may be on a different server operated by you or a 261 | third party) that supports equivalent copying facilities, provided you 262 | maintain clear directions next to the object code saying where to find the 263 | Corresponding Source. Regardless of what server hosts the Corresponding 264 | Source, you remain obligated to ensure that it is available for as long as 265 | needed to satisfy these requirements. 266 | - e) Convey the object code using peer-to-peer transmission, provided you 267 | inform other peers where the object code and Corresponding Source of the 268 | work are being offered to the general public at no charge under subsection 269 | 6d. 270 | 271 | A separable portion of the object code, whose source code is excluded from the 272 | Corresponding Source as a System Library, need not be included in conveying the 273 | object code work. 274 | 275 | A *User Product* is either 276 | 277 | 1. a *consumer product*, which means any tangible personal property which is 278 | normally used for personal, family, or household purposes, or 279 | 2. anything designed or sold for incorporation into a dwelling. 280 | 281 | In determining whether a product is a consumer product, doubtful cases shall be 282 | resolved in favor of coverage. For a particular product received by a 283 | particular user, *normally used* refers to a typical or common use of that 284 | class of product, regardless of the status of the particular user or of the way 285 | in which the particular user actually uses, or expects or is expected to use, 286 | the product. A product is a consumer product regardless of whether the product 287 | has substantial commercial, industrial or non-consumer uses, unless such uses 288 | represent the only significant mode of use of the product. 289 | 290 | *Installation Information* for a User Product means any methods, procedures, 291 | authorization keys, or other information required to install and execute 292 | modified versions of a covered work in that User Product from a modified 293 | version of its Corresponding Source. The information must suffice to ensure 294 | that the continued functioning of the modified object code is in no case 295 | prevented or interfered with solely because modification has been made. 296 | 297 | If you convey an object code work under this section in, or with, or 298 | specifically for use in, a User Product, and the conveying occurs as part of a 299 | transaction in which the right of possession and use of the User Product is 300 | transferred to the recipient in perpetuity or for a fixed term (regardless of 301 | how the transaction is characterized), the Corresponding Source conveyed under 302 | this section must be accompanied by the Installation Information. But this 303 | requirement does not apply if neither you nor any third party retains the 304 | ability to install modified object code on the User Product (for example, the 305 | work has been installed in ROM). 306 | 307 | The requirement to provide Installation Information does not include a 308 | requirement to continue to provide support service, warranty, or updates for a 309 | work that has been modified or installed by the recipient, or for the User 310 | Product in which it has been modified or installed. Access to a network may be 311 | denied when the modification itself materially and adversely affects the 312 | operation of the network or violates the rules and protocols for communication 313 | across the network. 314 | 315 | Corresponding Source conveyed, and Installation Information provided, in accord 316 | with this section must be in a format that is publicly documented (and with an 317 | implementation available to the public in source code form), and must require 318 | no special password or key for unpacking, reading or copying. 319 | 320 | ### 7. Additional Terms. 321 | 322 | *Additional permissions* are terms that supplement the terms of this License by 323 | making exceptions from one or more of its conditions. Additional permissions 324 | that are applicable to the entire Program shall be treated as though they were 325 | included in this License, to the extent that they are valid under applicable 326 | law. If additional permissions apply only to part of the Program, that part may 327 | be used separately under those permissions, but the entire Program remains 328 | governed by this License without regard to the additional permissions. 329 | 330 | When you convey a copy of a covered work, you may at your option remove any 331 | additional permissions from that copy, or from any part of it. (Additional 332 | permissions may be written to require their own removal in certain cases when 333 | you modify the work.) You may place additional permissions on material, added 334 | by you to a covered work, for which you have or can give appropriate copyright 335 | permission. 336 | 337 | Notwithstanding any other provision of this License, for material you add to a 338 | covered work, you may (if authorized by the copyright holders of that material) 339 | supplement the terms of this License with terms: 340 | 341 | - a) Disclaiming warranty or limiting liability differently from the terms of 342 | sections 15 and 16 of this License; or 343 | - b) Requiring preservation of specified reasonable legal notices or author 344 | attributions in that material or in the Appropriate Legal Notices displayed 345 | by works containing it; or 346 | - c) Prohibiting misrepresentation of the origin of that material, or 347 | requiring that modified versions of such material be marked in reasonable 348 | ways as different from the original version; or 349 | - d) Limiting the use for publicity purposes of names of licensors or authors 350 | of the material; or 351 | - e) Declining to grant rights under trademark law for use of some trade 352 | names, trademarks, or service marks; or 353 | - f) Requiring indemnification of licensors and authors of that material by 354 | anyone who conveys the material (or modified versions of it) with 355 | contractual assumptions of liability to the recipient, for any liability 356 | that these contractual assumptions directly impose on those licensors and 357 | authors. 358 | 359 | All other non-permissive additional terms are considered *further restrictions* 360 | within the meaning of section 10. If the Program as you received it, or any 361 | part of it, contains a notice stating that it is governed by this License along 362 | with a term that is a further restriction, you may remove that term. If a 363 | license document contains a further restriction but permits relicensing or 364 | conveying under this License, you may add to a covered work material governed 365 | by the terms of that license document, provided that the further restriction 366 | does not survive such relicensing or conveying. 367 | 368 | If you add terms to a covered work in accord with this section, you must place, 369 | in the relevant source files, a statement of the additional terms that apply to 370 | those files, or a notice indicating where to find the applicable terms. 371 | 372 | Additional terms, permissive or non-permissive, may be stated in the form of a 373 | separately written license, or stated as exceptions; the above requirements 374 | apply either way. 375 | 376 | ### 8. Termination. 377 | 378 | You may not propagate or modify a covered work except as expressly provided 379 | under this License. Any attempt otherwise to propagate or modify it is void, 380 | and will automatically terminate your rights under this License (including any 381 | patent licenses granted under the third paragraph of section 11). 382 | 383 | However, if you cease all violation of this License, then your license from a 384 | particular copyright holder is reinstated 385 | 386 | - a) provisionally, unless and until the copyright holder explicitly and 387 | finally terminates your license, and 388 | - b) permanently, if the copyright holder fails to notify you of the 389 | violation by some reasonable means prior to 60 days after the cessation. 390 | 391 | Moreover, your license from a particular copyright holder is reinstated 392 | permanently if the copyright holder notifies you of the violation by some 393 | reasonable means, this is the first time you have received notice of violation 394 | of this License (for any work) from that copyright holder, and you cure the 395 | violation prior to 30 days after your receipt of the notice. 396 | 397 | Termination of your rights under this section does not terminate the licenses 398 | of parties who have received copies or rights from you under this License. If 399 | your rights have been terminated and not permanently reinstated, you do not 400 | qualify to receive new licenses for the same material under section 10. 401 | 402 | ### 9. Acceptance Not Required for Having Copies. 403 | 404 | You are not required to accept this License in order to receive or run a copy 405 | of the Program. Ancillary propagation of a covered work occurring solely as a 406 | consequence of using peer-to-peer transmission to receive a copy likewise does 407 | not require acceptance. However, nothing other than this License grants you 408 | permission to propagate or modify any covered work. These actions infringe 409 | copyright if you do not accept this License. Therefore, by modifying or 410 | propagating a covered work, you indicate your acceptance of this License to do 411 | so. 412 | 413 | ### 10. Automatic Licensing of Downstream Recipients. 414 | 415 | Each time you convey a covered work, the recipient automatically receives a 416 | license from the original licensors, to run, modify and propagate that work, 417 | subject to this License. You are not responsible for enforcing compliance by 418 | third parties with this License. 419 | 420 | An *entity transaction* is a transaction transferring control of an 421 | organization, or substantially all assets of one, or subdividing an 422 | organization, or merging organizations. If propagation of a covered work 423 | results from an entity transaction, each party to that transaction who receives 424 | a copy of the work also receives whatever licenses to the work the party's 425 | predecessor in interest had or could give under the previous paragraph, plus a 426 | right to possession of the Corresponding Source of the work from the 427 | predecessor in interest, if the predecessor has it or can get it with 428 | reasonable efforts. 429 | 430 | You may not impose any further restrictions on the exercise of the rights 431 | granted or affirmed under this License. For example, you may not impose a 432 | license fee, royalty, or other charge for exercise of rights granted under this 433 | License, and you may not initiate litigation (including a cross-claim or 434 | counterclaim in a lawsuit) alleging that any patent claim is infringed by 435 | making, using, selling, offering for sale, or importing the Program or any 436 | portion of it. 437 | 438 | ### 11. Patents. 439 | 440 | A *contributor* is a copyright holder who authorizes use under this License of 441 | the Program or a work on which the Program is based. The work thus licensed is 442 | called the contributor's *contributor version*. 443 | 444 | A contributor's *essential patent claims* are all patent claims owned or 445 | controlled by the contributor, whether already acquired or hereafter acquired, 446 | that would be infringed by some manner, permitted by this License, of making, 447 | using, or selling its contributor version, but do not include claims that would 448 | be infringed only as a consequence of further modification of the contributor 449 | version. For purposes of this definition, *control* includes the right to grant 450 | patent sublicenses in a manner consistent with the requirements of this 451 | License. 452 | 453 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent 454 | license under the contributor's essential patent claims, to make, use, sell, 455 | offer for sale, import and otherwise run, modify and propagate the contents of 456 | its contributor version. 457 | 458 | In the following three paragraphs, a *patent license* is any express agreement 459 | or commitment, however denominated, not to enforce a patent (such as an express 460 | permission to practice a patent or covenant not to sue for patent 461 | infringement). To *grant* such a patent license to a party means to make such 462 | an agreement or commitment not to enforce a patent against the party. 463 | 464 | If you convey a covered work, knowingly relying on a patent license, and the 465 | Corresponding Source of the work is not available for anyone to copy, free of 466 | charge and under the terms of this License, through a publicly available 467 | network server or other readily accessible means, then you must either 468 | 469 | 1. cause the Corresponding Source to be so available, or 470 | 2. arrange to deprive yourself of the benefit of the patent license for this 471 | particular work, or 472 | 3. arrange, in a manner consistent with the requirements of this License, to 473 | extend the patent license to downstream recipients. 474 | 475 | *Knowingly relying* means you have actual knowledge that, but for the patent 476 | license, your conveying the covered work in a country, or your recipient's use 477 | of the covered work in a country, would infringe one or more identifiable 478 | patents in that country that you have reason to believe are valid. 479 | 480 | If, pursuant to or in connection with a single transaction or arrangement, you 481 | convey, or propagate by procuring conveyance of, a covered work, and grant a 482 | patent license to some of the parties receiving the covered work authorizing 483 | them to use, propagate, modify or convey a specific copy of the covered work, 484 | then the patent license you grant is automatically extended to all recipients 485 | of the covered work and works based on it. 486 | 487 | A patent license is *discriminatory* if it does not include within the scope of 488 | its coverage, prohibits the exercise of, or is conditioned on the non-exercise 489 | of one or more of the rights that are specifically granted under this License. 490 | You may not convey a covered work if you are a party to an arrangement with a 491 | third party that is in the business of distributing software, under which you 492 | make payment to the third party based on the extent of your activity of 493 | conveying the work, and under which the third party grants, to any of the 494 | parties who would receive the covered work from you, a discriminatory patent 495 | license 496 | 497 | - a) in connection with copies of the covered work conveyed by you (or copies 498 | made from those copies), or 499 | - b) primarily for and in connection with specific products or compilations 500 | that contain the covered work, unless you entered into that arrangement, or 501 | that patent license was granted, prior to 28 March 2007. 502 | 503 | Nothing in this License shall be construed as excluding or limiting any implied 504 | license or other defenses to infringement that may otherwise be available to 505 | you under applicable patent law. 506 | 507 | ### 12. No Surrender of Others' Freedom. 508 | 509 | If conditions are imposed on you (whether by court order, agreement or 510 | otherwise) that contradict the conditions of this License, they do not excuse 511 | you from the conditions of this License. If you cannot convey a covered work so 512 | as to satisfy simultaneously your obligations under this License and any other 513 | pertinent obligations, then as a consequence you may not convey it at all. For 514 | example, if you agree to terms that obligate you to collect a royalty for 515 | further conveying from those to whom you convey the Program, the only way you 516 | could satisfy both those terms and this License would be to refrain entirely 517 | from conveying the Program. 518 | 519 | ### 13. Use with the GNU Affero General Public License. 520 | 521 | Notwithstanding any other provision of this License, you have permission to 522 | link or combine any covered work with a work licensed under version 3 of the 523 | GNU Affero General Public License into a single combined work, and to convey 524 | the resulting work. The terms of this License will continue to apply to the 525 | part which is the covered work, but the special requirements of the GNU Affero 526 | General Public License, section 13, concerning interaction through a network 527 | will apply to the combination as such. 528 | 529 | ### 14. Revised Versions of this License. 530 | 531 | The Free Software Foundation may publish revised and/or new versions of the GNU 532 | General Public License from time to time. Such new versions will be similar in 533 | spirit to the present version, but may differ in detail to address new problems 534 | or concerns. 535 | 536 | Each version is given a distinguishing version number. If the Program specifies 537 | that a certain numbered version of the GNU General Public License *or any later 538 | version* applies to it, you have the option of following the terms and 539 | conditions either of that numbered version or of any later version published by 540 | the Free Software Foundation. If the Program does not specify a version number 541 | of the GNU General Public License, you may choose any version ever published by 542 | the Free Software Foundation. 543 | 544 | If the Program specifies that a proxy can decide which future versions of the 545 | GNU General Public License can be used, that proxy's public statement of 546 | acceptance of a version permanently authorizes you to choose that version for 547 | the Program. 548 | 549 | Later license versions may give you additional or different permissions. 550 | However, no additional obligations are imposed on any author or copyright 551 | holder as a result of your choosing to follow a later version. 552 | 553 | ### 15. Disclaimer of Warranty. 554 | 555 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE 556 | LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER 557 | PARTIES PROVIDE THE PROGRAM *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER 558 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 559 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 560 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 561 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 562 | CORRECTION. 563 | 564 | ### 16. Limitation of Liability. 565 | 566 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 567 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 568 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 569 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE 570 | THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED 571 | INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE 572 | PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY 573 | HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 574 | 575 | ### 17. Interpretation of Sections 15 and 16. 576 | 577 | If the disclaimer of warranty and limitation of liability provided above cannot 578 | be given local legal effect according to their terms, reviewing courts shall 579 | apply local law that most closely approximates an absolute waiver of all civil 580 | liability in connection with the Program, unless a warranty or assumption of 581 | liability accompanies a copy of the Program in return for a fee. 582 | 583 | ## END OF TERMS AND CONDITIONS ### 584 | 585 | ### How to Apply These Terms to Your New Programs 586 | 587 | If you develop a new program, and you want it to be of the greatest possible 588 | use to the public, the best way to achieve this is to make it free software 589 | which everyone can redistribute and change under these terms. 590 | 591 | To do so, attach the following notices to the program. It is safest to attach 592 | them to the start of each source file to most effectively state the exclusion 593 | of warranty; and each file should have at least the *copyright* line and a 594 | pointer to where the full notice is found. 595 | 596 | 597 | Copyright (C) 598 | 599 | This program is free software: you can redistribute it and/or modify 600 | it under the terms of the GNU General Public License as published by 601 | the Free Software Foundation, either version 3 of the License, or 602 | (at your option) any later version. 603 | 604 | This program is distributed in the hope that it will be useful, 605 | but WITHOUT ANY WARRANTY; without even the implied warranty of 606 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 607 | GNU General Public License for more details. 608 | 609 | You should have received a copy of the GNU General Public License 610 | along with this program. If not, see . 611 | 612 | Also add information on how to contact you by electronic and paper mail. 613 | 614 | If the program does terminal interaction, make it output a short notice like 615 | this when it starts in an interactive mode: 616 | 617 | Copyright (C) 618 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 619 | This is free software, and you are welcome to redistribute it 620 | under certain conditions; type `show c' for details. 621 | 622 | The hypothetical commands `show w` and `show c` should show the appropriate 623 | parts of the General Public License. Of course, your program's commands might 624 | be different; for a GUI interface, you would use an *about box*. 625 | 626 | You should also get your employer (if you work as a programmer) or school, if 627 | any, to sign a *copyright disclaimer* for the program, if necessary. For more 628 | information on this, and how to apply and follow the GNU GPL, see 629 | [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/). 630 | 631 | The GNU General Public License does not permit incorporating your program into 632 | proprietary programs. If your program is a subroutine library, you may consider 633 | it more useful to permit linking proprietary applications with the library. If 634 | this is what you want to do, use the GNU Lesser General Public License instead 635 | of this License. But first, please read 636 | [http://www.gnu.org/philosophy/why-not-lgpl.html](http://www.gnu.org/philosophy/why-not-lgpl.html). 637 | --------------------------------------------------------------------------------