├── frame-generator ├── input │ ├── regex │ │ └── regex.tsv │ ├── docs │ │ ├── sample2.txt │ │ ├── sample1.txt │ │ └── sample3.txt │ └── stop │ │ └── stop.txt ├── output │ └── .gitignore ├── models.py ├── web.py ├── keywords.py ├── frames.py ├── generator.py └── documents.py ├── frogger ├── test.txt ├── start_frog.sh ├── .htaccess └── frog.py ├── CHANGELOG.md ├── requirements.txt ├── .gitignore ├── README.md └── LICENSE /frame-generator/input/regex/regex.tsv: -------------------------------------------------------------------------------- 1 | zoo zo 2 | hooren horen -------------------------------------------------------------------------------- /frogger/test.txt: -------------------------------------------------------------------------------- 1 | Dit is een test tekstje voor Frog. 2 | 3 | -------------------------------------------------------------------------------- /frogger/start_frog.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | frog -S 4096 4 | -------------------------------------------------------------------------------- /frame-generator/output/.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore everything in this directory 2 | * 3 | # Except this file 4 | !.gitignore 5 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). 5 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | appdirs==1.4.3 2 | boto==2.46.1 3 | bottle==0.12.13 4 | bz2file==0.98 5 | gensim==1.0.1 6 | lxml==3.7.3 7 | numpy==1.12.1 8 | packaging==16.8 9 | pyparsing==2.2.0 10 | regex==2017.2.8 11 | requests==2.13.0 12 | scipy==0.19.0 13 | segtok==1.5.4 14 | six==1.10.0 15 | smart-open==1.5.1 16 | unicodecsv==0.14.1 17 | -------------------------------------------------------------------------------- /frogger/.htaccess: -------------------------------------------------------------------------------- 1 | 2 | SetHandler wsgi-script 3 | Options +ExecCGI 4 | 5 | 6 | RewriteEngine on 7 | RewriteBase / 8 | RewriteCond %{REQUEST_URI} !^/robots.txt 9 | RewriteCond %{REQUEST_URI} !^/static 10 | RewriteCond %{REQUEST_URI} !^(/.*)+frog.py 11 | RewriteRule ^(.*)$ /frogger/frog.py/$1 [PT] 12 | 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | 55 | # Sphinx documentation 56 | docs/_build/ 57 | 58 | # PyBuilder 59 | target/ 60 | -------------------------------------------------------------------------------- /frame-generator/input/docs/sample2.txt: -------------------------------------------------------------------------------- 1 | Onderwerp der voordracht. 2 | 3 | 4 | Waarom ik nu in dezen ongewonen opschik heden voor u opgetreden ben, 5 | zult ge spoedig hooren, als gij slechts geen bezwaar maakt ooren te 6 | hebben voor mijn spreken, niet, zooals gij die gewoonlijk hebt voor 7 | den prediker in de kerk, maar zoo als gij die pleegt op te steken voor 8 | marktschreeuwers, paljassen en hansworsten, ooren, zooals onze bekende 9 | Midas [26] ze indertijd voor Pan opzette. Want ik heb lust gekregen 10 | voor een poosje bij u den sophist [27] te spelen, wel niet als een 11 | van dat slag, dat heden ten dage der jeugd eenige hoofdbrekende 12 | beuzelingen instampt en een meer dan vrouwelijke stijfkoppigheid 13 | in het twisten leeraart, maar ik zal die ouden navolgen, die om den 14 | kwalijk klinkenden [28] naam van Sophen (wijzen) te vermijden, liever 15 | Sophisten (wijsmakers) wilden genoemd worden. Hun lust was het den 16 | naam van Goden en helden door lofredenen te verheerlijken. Daarom 17 | zult ge dan ook een lofrede hooren niet op Hercules, noch op Solon 18 | [29], maar op mij zelf, de Zotheid. -------------------------------------------------------------------------------- /frame-generator/input/docs/sample1.txt: -------------------------------------------------------------------------------- 1 | Alleen door haar aanblik heeft de Zotheid de zorgen van haar 2 | toehoorders verjaagd. 3 | 4 | 5 | Hoe de menschen ook gewoonlijk over mij spreken,--en ik weet maar 6 | al te goed, in welk een kwaden naam de Zotheid zelfs bij de zotsten 7 | staat--beweer ik toch, dat ik en ik alleen door mijn goddelijke macht 8 | Goden en menschen vervroolijk. Hiervan is dit zeker een meer dan 9 | voldoend bewijs, dat, zoodra ik voor deze zoo talrijke vergadering was 10 | opgetreden om het woord te voeren, eensklaps uw aller aangezichten 11 | zoo blonken van een ongekende en ongewone vreugde, dat gij zoo 12 | plotseling het voorhoofd ontrimpeldet en mij met zulk een blijden 13 | en beminnelijken lach toejuichtet, dat gij allen, die ik hier uit 14 | alle hoeken der wereld voor mij zie, waarlijk niemand uitgezonderd, 15 | gelijk de Goden bij Homerus, te veel nectar met nepenthes [24] 16 | schijnt gebruikt te hebben, terwijl ge vroeger zoo bedroefd en 17 | bekommerd waart neergezeten, alsof ge nog pas uit Trophonius' hol 18 | [25] waart teruggekomen. Maar 't gaat hiermede als wanneer de zon 19 | het eerst haar schoon en gulden gelaat aan 't aardrijk vertoont of na 20 | een strengen winter de lente opnieuw den zoelen adem der westenwinden 21 | brengt: dan verandert aanstonds het voorkomen van alles, dan krijgt 22 | alles een nieuwe kleur en een geheel nieuwe jeugd en zoo veranderde 23 | ook dadelijk op mijn aanblik uw voorkomen. 24 | 25 | Daarom heb ik dan ook, hetgeen andere groote redekunstenaars 26 | ternauwernood door een lange en langen tijd overpeinsde rede kunnen te 27 | weeg brengen, het verdrijven nl. van lastige muizenissen, al aanstonds 28 | enkel door mijn gezicht weten te bewerken. -------------------------------------------------------------------------------- /frogger/frog.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | 5 | import socket 6 | import urllib 7 | 8 | from flask import Flask, request 9 | 10 | application = Flask(__name__) 11 | application.debug = True 12 | 13 | class Frog(): 14 | def __init__(self, port=4096): 15 | self.BUFSIZE = 4096 16 | self.port = port 17 | 18 | def tag(self, text, html=False): 19 | self.socket = socket.socket(socket.AF_INET,socket.SOCK_STREAM) 20 | self.socket.settimeout(120.0) 21 | self.socket.connect(('ontw', self.port)) 22 | 23 | text = text.strip(' \t\n') 24 | text = text.encode('utf-8') + b'\r\nEOT\r\n' 25 | self.socket.sendall(text) 26 | 27 | res = '' 28 | done = False 29 | while not done: 30 | data = b'' 31 | while not data or data[-1] != b'\n': 32 | more = self.socket.recv(self.BUFSIZE) 33 | if not more: 34 | break 35 | data += more 36 | for line in data.strip(' \t\r\n').split('\n'): 37 | if line.strip() == 'READY': 38 | done = True 39 | elif line: 40 | res += line + "\n" 41 | 42 | self.socket.close() 43 | return res 44 | 45 | @application.route('/') 46 | def index(): 47 | url = request.args.get('url') 48 | text = request.args.get('text') 49 | 50 | frog = Frog() 51 | if url: 52 | data = urllib.urlopen(url).read().decode('utf-8') 53 | data = data.replace('', '').replace('','') 54 | data = data.replace('','').replace('','.') 55 | data = data.replace('

','').replace('

','') 56 | return frog.tag(data) 57 | 58 | if text: 59 | return frog.tag(text) 60 | 61 | return ('No input recieved, either use ?url= or ?text=') 62 | 63 | if __name__ == "__main__": 64 | 65 | a=""" 66 | flavour 27% 26% bell hoell 25 '/2 25'A int harv 8% 8'A bemis comp 26'A comp 67 | 26'A — 68 | """ 69 | 70 | b="""inco lim 11% 11 7/8 bausch 25'/2 25 ibm 120 119% beatrice f 28 3 A 28% 71 | int""" 72 | 73 | f = Frog() 74 | print f.tag(a.decode('utf-8')) 75 | 76 | -------------------------------------------------------------------------------- /frame-generator/input/docs/sample3.txt: -------------------------------------------------------------------------------- 1 | Waarom de Zotheid zichzelf prijst. 2 | 3 | 4 | Al aanstonds dit: ik stoor mij volstrekt niet aan die wijzen, die, zoo 5 | iemand zichzelf ophemelt, hem een grooten zotskap en een onbeschaamden 6 | rekel noemen. Het moge, volgens hen, zoo zot mogelijk zijn--zij moeten 7 | toegeven, dat het betamelijk is. Want wat is gepaster dan dat de 8 | Zotheid zelf de loftrompet over zichzelf steekt? Niemand kan immers een 9 | sprekender beeld van mij geven dan ik zelf--of ik moest soms aan een 10 | ander beter bekend zijn dan aan mij zelf. Toch acht ik dit overigens 11 | zelfs niet weinig zediger dan hetgeen het gros der aanzienlijken en 12 | wijzen pleegt te doen, die uit een soort van valsche schaamte of een 13 | vleienden redekunstenaar of een zot klappenden dichter in 't geheim 14 | daartoe plegen aan te sporen en hem voor een zeker loon huren om uit 15 | zijn mond hun lof of, wat op hetzelfde neerkomt, klinkklare leugens te 16 | hooren. Die beschroomde man zet evenwel als een pauw zijn staart op en 17 | draagt den kam hoog, wanneer die onbeschaamde vleier een nieteling, als 18 | hij is, aan de Goden gelijk stelt; wanneer hij hem voor een volmaakt 19 | toonbeeld van alle deugden doet doorgaan, alhoewel de geprezene weet, 20 | dat hij er hemelsbreed van verschilt; wanneer hij een kraai bekleedt 21 | met vreemde veeren; wanneer hij den moriaan schoon wascht, kortom 22 | als hij van een mug een olifant maakt. Ten slotte houd ik mij aan 23 | het oude volksgezegde, dat hij, die door geen ander geprezen wordt, 24 | gelijk heeft, als hij zich zelf prijst. Intusschen kan ik in dezen 25 | niet nalaten mij te verwonderen--moet ik het aan de ondankbaarheid 26 | of aan de traagheid der menschen toeschrijven?--dat, alhoewel allen 27 | zonder onderscheid veel werk van mij maken en gaarne mijn gaven 28 | genieten, er in den loop van zooveel eeuwen niemand is opgestaan, 29 | die in woorden vol dankbaarheid den lof der Zotheid verkondigde, 30 | ofschoon het niet ontbroken heeft aan hen, die in zorgvuldig, met 31 | opoffering van veel olie en slaap bewerkte verhandelingen mannen 32 | als Busiris en Phalaris [30], of de derdendaagsche koorts, vliegen, 33 | kaalhoofdigheid en zulke ellendige dingen meer verheerlijkten. Van 34 | mij zult gij een rede hooren, die wel voor de vuist gehouden wordt en 35 | waaraan hierom niet veel tijd is besteed, maar die in des te grooter 36 | mate de deugd der waarheid bezit. -------------------------------------------------------------------------------- /frame-generator/input/stop/stop.txt: -------------------------------------------------------------------------------- 1 | aan 2 | aangaande 3 | aangezien 4 | achter 5 | achterna 6 | afgelopen 7 | al 8 | aldaar 9 | aldus 10 | alhoewel 11 | alias 12 | alle 13 | allebei 14 | alleen 15 | alsnog 16 | altijd 17 | altoos 18 | ander 19 | andere 20 | anders 21 | anderszins 22 | behalve 23 | behoudens 24 | beide 25 | beiden 26 | ben 27 | beneden 28 | bent 29 | bepaald 30 | betreffende 31 | bij 32 | binnen 33 | binnenin 34 | boven 35 | bovenal 36 | bovendien 37 | bovengenoemd 38 | bovenstaand 39 | bovenvermeld 40 | buiten 41 | daar 42 | daarheen 43 | daarin 44 | daarna 45 | daarnet 46 | daarom 47 | daarop 48 | daarvanlangs 49 | dan 50 | dat 51 | de 52 | die 53 | dikwijls 54 | dit 55 | door 56 | doorgaand 57 | dus 58 | echter 59 | eer 60 | eerdat 61 | eerder 62 | eerlang 63 | eerst 64 | elk 65 | elke 66 | en 67 | enig 68 | enigszins 69 | enkel 70 | er 71 | erdoor 72 | even 73 | eveneens 74 | evenwel 75 | gauw 76 | gedurende 77 | geen 78 | gehad 79 | gekund 80 | geleden 81 | gelijk 82 | gemoeten 83 | gemogen 84 | geweest 85 | gewoon 86 | gewoonweg 87 | haar 88 | had 89 | hadden 90 | hare 91 | heb 92 | hebben 93 | hebt 94 | heeft 95 | hem 96 | hen 97 | het 98 | hierbeneden 99 | hierboven 100 | hij 101 | hoe 102 | hoewel 103 | hun 104 | hunne 105 | ik 106 | ikzelf 107 | in 108 | inmiddels 109 | inzake 110 | is 111 | jezelf 112 | jij 113 | jijzelf 114 | jou 115 | jouw 116 | jouwe 117 | juist 118 | jullie 119 | kan 120 | klaar 121 | kon 122 | konden 123 | krachtens 124 | kunnen 125 | kunt 126 | later 127 | liever 128 | maar 129 | mag 130 | meer 131 | met 132 | mezelf 133 | mij 134 | mijn 135 | mijnent 136 | mijner 137 | mijzelf 138 | misschien 139 | mocht 140 | mochten 141 | moest 142 | moesten 143 | moet 144 | moeten 145 | mogen 146 | na 147 | naar 148 | nadat 149 | net 150 | niet 151 | noch 152 | nog 153 | nogal 154 | nu 155 | of 156 | ofschoon 157 | om 158 | omdat 159 | omhoog 160 | omlaag 161 | omstreeks 162 | omtrent 163 | omver 164 | onder 165 | ondertussen 166 | ongeveer 167 | ons 168 | onszelf 169 | onze 170 | ook 171 | op 172 | opnieuw 173 | opzij 174 | over 175 | overeind 176 | overigens 177 | pas 178 | precies 179 | reeds 180 | rond 181 | rondom 182 | sedert 183 | sinds 184 | sindsdien 185 | slechts 186 | sommige 187 | spoedig 188 | steeds 189 | tamelijk 190 | tenzij 191 | terwijl 192 | thans 193 | tijdens 194 | toch 195 | toen 196 | toenmaals 197 | toenmalig 198 | tot 199 | totdat 200 | tussen 201 | uit 202 | uitgezonderd 203 | vaak 204 | van 205 | vandaan 206 | vanuit 207 | vanwege 208 | veeleer 209 | verder 210 | vervolgens 211 | vol 212 | volgens 213 | voor 214 | vooraf 215 | vooral 216 | vooralsnog 217 | voorbij 218 | voordat 219 | voordezen 220 | voordien 221 | voorheen 222 | voorop 223 | vooruit 224 | vrij 225 | vroeg 226 | waar 227 | waarom 228 | wanneer 229 | want 230 | waren 231 | was 232 | wat 233 | weer 234 | weg 235 | wegens 236 | wel 237 | weldra 238 | welk 239 | welke 240 | wie 241 | wiens 242 | wier 243 | wij 244 | wijzelf 245 | zal 246 | ze 247 | zelfs 248 | zichzelf 249 | zij 250 | zijn 251 | zijne 252 | zo 253 | zodra 254 | zonder 255 | zou 256 | zouden 257 | zowat 258 | zulke 259 | zullen 260 | zult -------------------------------------------------------------------------------- /frame-generator/models.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Frame Generator 5 | # 6 | # Copyright (C) 2016 Juliette Lonij, Koninklijke Bibliotheek - 7 | # National Library of the Netherlands 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import gensim 23 | import os 24 | import unicodecsv as csv 25 | 26 | 27 | class TopicList(object): 28 | ''' 29 | List of generated topics. 30 | ''' 31 | 32 | def __init__(self, doc_reader, num_topics=10, num_words=10, 33 | mallet_path=None): 34 | ''' 35 | Set TopicList attributes. 36 | ''' 37 | self.doc_reader = doc_reader 38 | self.num_topics = num_topics 39 | self.num_words = num_words 40 | self.mallet_path = mallet_path 41 | 42 | if mallet_path: 43 | print('Generating Mallet LDA model ...') 44 | lda = gensim.models.wrappers.LdaMallet(mallet_path, 45 | num_topics=num_topics, corpus=self.doc_reader.corpus, 46 | id2word=self.doc_reader.dictionary, workers=2) 47 | else: 48 | print('Generating Gensim LDA model ...') 49 | lda = gensim.models.LdaModel(corpus=self.doc_reader.corpus, 50 | id2word=self.doc_reader.dictionary, num_topics=num_topics, 51 | alpha='auto', chunksize=1, eval_every=1) 52 | 53 | topics = [t[1] for t in lda.show_topics(num_words=num_words, 54 | num_topics=num_topics, formatted=False)] 55 | self.topics = [[(i[1], i[0]) for i in t] for t in topics] 56 | 57 | def save_topics(self, dir_name): 58 | ''' 59 | Save generated topics to file. 60 | ''' 61 | with open(dir_name + os.sep + 'topics' + '.csv', 'wb') as f: 62 | # Manually encode a BOM, utf-8-sig didn't work with unicodecsv 63 | f.write(u'\ufeff'.encode('utf8')) 64 | csv_writer = csv.writer(f, delimiter='\t', encoding='utf-8') 65 | for topic in self.topics: 66 | csv_writer.writerow([t[1] for t in topic]) 67 | csv_writer.writerow([str(t[0]) for t in topic]) 68 | 69 | def print_topics(self): 70 | ''' 71 | Print generated topics. 72 | ''' 73 | print('Topics generated:') 74 | for i, topic in enumerate(self.topics): 75 | print('[' + str(i + 1) + '] ' + ', '.join([t[1] for t in topic])) 76 | 77 | 78 | class TfIdfList(object): 79 | ''' 80 | List of tf-idf scores. 81 | ''' 82 | 83 | def __init__(self, doc_reader): 84 | ''' 85 | Set TfIdfList attributes. 86 | ''' 87 | self.doc_reader = doc_reader 88 | 89 | print('Generating Gensim TF-IDF model ...') 90 | tfidf = gensim.models.TfidfModel(self.doc_reader.corpus) 91 | self.scores = tfidf[self.doc_reader.corpus] 92 | -------------------------------------------------------------------------------- /frame-generator/web.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Frame Generator 5 | # 6 | # Copyright (C) 2016 Juliette Lonij, Koninklijke Bibliotheek - 7 | # National Library of the Netherlands 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import generator 23 | import json 24 | import os 25 | import shutil 26 | import time 27 | 28 | from bottle import post 29 | from bottle import request 30 | from bottle import route 31 | from bottle import run 32 | 33 | 34 | @post('/') 35 | def index(): 36 | ''' 37 | Generate requested frames and return as json response. 38 | ''' 39 | try: 40 | abs_path = os.path.dirname(os.path.realpath(__file__)) 41 | input_dir = abs_path + os.sep + 'input' + os.sep + str(int(time.time())) 42 | os.makedirs(input_dir) 43 | 44 | doc_dir = input_dir + os.sep + 'docs' 45 | os.makedirs(doc_dir) 46 | doc_files = request.files.getall('doc_files[]') 47 | for f in doc_files: 48 | name, ext = os.path.splitext(f.filename) 49 | if ext in ['.txt', '.json', '.xml']: 50 | f.save(doc_dir) 51 | 52 | stop_dir = input_dir + os.sep + 'stop' 53 | os.makedirs(stop_dir) 54 | stop_files = request.files.getall('stop_files[]') 55 | for f in stop_files: 56 | name, ext = os.path.splitext(f.filename) 57 | if ext == '.txt': 58 | f.save(stop_dir) 59 | 60 | regex_dir = input_dir + os.sep + 'regex' 61 | os.makedirs(regex_dir) 62 | regex_files = request.files.getall('regex_files[]') 63 | for f in regex_files: 64 | name, ext = os.path.splitext(f.filename) 65 | if ext == '.txt': 66 | f.save(regex_dir) 67 | 68 | window_size = int(request.forms.get('window_size')) 69 | window_direction = request.forms.get('window_direction') 70 | 71 | frame_tags = [] 72 | for i in range(1, 13): 73 | if request.forms.get('ftag' + str(i)): 74 | frame_tags.append(request.forms.get('ftag' + str(i))) 75 | 76 | keyword_tags = [] 77 | for i in range(1, 13): 78 | if request.forms.get('ktag' + str(i)): 79 | keyword_tags.append(request.forms.get('ktag' + str(i))) 80 | 81 | _, keyword_list, frame_list = generator.generate(dlen=10, kcount=5, 82 | ktags=keyword_tags, wdir=window_direction, wsize=window_size, 83 | ftags=frame_tags, input_dir=input_dir, output_dir=None, fsize=8) 84 | 85 | max_kscore = max([k[1] for k in keyword_list.keywords]) 86 | max_fscores = [] 87 | for frame in frame_list.frames: 88 | if frame: 89 | max_fscores.append(max([f[1] for f in frame])) 90 | max_fscore = max(max_fscores) 91 | 92 | data = {'frames': []} 93 | for i, k in enumerate(keyword_list.keywords): 94 | d = {} 95 | d['keyword'] = {k[0].encode('utf-8'): k[1] / max_kscore} 96 | d['frame'] = {} 97 | for f in frame_list.frames[i]: 98 | d['frame'][f[0].encode('utf-8')] = f[1] / max_fscore 99 | data['frames'].append(d) 100 | 101 | result = json.dumps(data) 102 | 103 | except Exception as e: 104 | result = json.dumps({'error': repr(e)}) 105 | 106 | finally: 107 | if 'input_dir' in locals(): 108 | if os.path.isdir(input_dir): 109 | shutil.rmtree(input_dir) 110 | 111 | print result 112 | return result 113 | 114 | if __name__ == '__main__': 115 | run(host='localhost', port=8091) 116 | -------------------------------------------------------------------------------- /frame-generator/keywords.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Frame Generator 5 | # 6 | # Copyright (C) 2016 Juliette Lonij, Koninklijke Bibliotheek - 7 | # National Library of the Netherlands 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import gensim 23 | import math 24 | import operator 25 | import os 26 | import unicodecsv as csv 27 | 28 | 29 | class KeywordList(object): 30 | ''' 31 | List of generated keywords. 32 | ''' 33 | 34 | def __init__(self, doc_reader, num_keywords=10, keyword_tags=[], 35 | topic_list=None, tfidf_list=None): 36 | ''' 37 | Set KeywordList attributes. 38 | ''' 39 | self.doc_reader = doc_reader 40 | self.num_keywords = num_keywords 41 | self.keyword_tags = keyword_tags 42 | self.topic_list = topic_list 43 | self.tfidf_list = tfidf_list 44 | 45 | self.keywords = self.generate_keywords() 46 | 47 | def generate_keywords(self): 48 | ''' 49 | Generate keywords. 50 | ''' 51 | print('Generating keywords ...') 52 | keywords = {} 53 | 54 | if self.tfidf_list: 55 | for doc in self.tfidf_list.scores: 56 | for t in doc: 57 | key = self.doc_reader.dictionary.get(t[0]) 58 | score = t[1] 59 | if key in keywords: 60 | keywords[key] += score 61 | else: 62 | keywords[key] = score 63 | 64 | elif self.topic_list: 65 | # Sum of probabilities for token in all topics 66 | for topic in self.topic_list.topics: 67 | for t in topic: 68 | if t[1] in keywords: 69 | keywords[t[1]] += t[0] 70 | else: 71 | keywords[t[1]] = t[0] 72 | 73 | # Probability for each token multiplied by token frequency 74 | matrix = gensim.matutils.corpus2csc(self.doc_reader.corpus) 75 | for token, pr in keywords.items(): 76 | for dict_tuple in self.doc_reader.dictionary.items(): 77 | if dict_tuple[1] == token: 78 | token_index = dict_tuple[0] 79 | break 80 | token_row = matrix.getrow(token_index) 81 | token_freq = token_row.sum(1).item() 82 | keywords[token] = pr * math.log(token_freq) 83 | 84 | # Sort keywords by highest score 85 | sorted_keywords = sorted(keywords.items(), key=operator.itemgetter(1), 86 | reverse=True) 87 | 88 | # Filter wanted keyword tags 89 | if self.keyword_tags: 90 | sorted_keywords = [k for k in sorted_keywords if k[0].split('/')[1] 91 | in self.keyword_tags] 92 | 93 | return sorted_keywords[:self.num_keywords] 94 | 95 | def print_keywords(self): 96 | ''' 97 | Print generated keywords. 98 | ''' 99 | print('Keywords generated:') 100 | for i, k in enumerate(self.keywords): 101 | print('(' + str(i + 1) + ') ' + k[0] + ' [' + str(k[1]) + ']') 102 | 103 | def save_keywords(self, dir_name): 104 | ''' 105 | Save generated keywords to file. 106 | ''' 107 | with open(dir_name + os.sep + 'keywords' + '.csv', 'wb') as f: 108 | # Manually encode a BOM, utf-8-sig didn't work with unicodecsv 109 | f.write(u'\ufeff'.encode('utf8')) 110 | csv_writer = csv.writer(f, delimiter='\t', encoding='utf-8') 111 | for k in self.keywords: 112 | csv_writer.writerow([k[0], str(k[1])]) 113 | -------------------------------------------------------------------------------- /frame-generator/frames.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Frame Generator 5 | # 6 | # Copyright (C) 2016 Juliette Lonij, Koninklijke Bibliotheek - 7 | # National Library of the Netherlands 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import math 23 | import operator 24 | import os 25 | import unicodecsv as csv 26 | 27 | 28 | class FrameList(object): 29 | ''' 30 | List of generated frames. 31 | ''' 32 | 33 | def __init__(self, doc_reader, keyword_list, window_direction=None, 34 | window_size=5, frame_size=10, frame_tags=[]): 35 | ''' 36 | Set FrameList attributes. 37 | ''' 38 | self.doc_reader = doc_reader 39 | self.keyword_list = keyword_list 40 | self.window_direction = window_direction 41 | self.window_size = window_size 42 | self.frame_size = frame_size 43 | self.frame_tags = frame_tags 44 | 45 | self.frames = self.generate_frames(self.keyword_list.keywords, 46 | self.doc_reader.doc_list) 47 | 48 | def generate_frames(self, keywords, docs): 49 | ''' 50 | Generate frames. 51 | ''' 52 | print('Generating frames ...') 53 | 54 | frames = [] 55 | for k in keywords: 56 | frame = {} 57 | for doc in docs: 58 | for i, t in enumerate(doc): 59 | 60 | # Find all occurences of the keyword in the doc bow 61 | if t == k[0]: 62 | # Get the window indeces 63 | if self.window_direction == 'left': 64 | window_indices = range(i - self.window_size, i) 65 | elif self.window_direction == 'right': 66 | window_indices = range(i + 1, 67 | i + self.window_size + 1) 68 | else: 69 | window_indices = (range(i - self.window_size, i) + 70 | range(i + 1, i + self.window_size + 1)) 71 | 72 | # Find the words in the keyword window 73 | for w in [word for word in doc if doc.index(word) 74 | in window_indices]: 75 | 76 | # Check if word meets frame criteria 77 | if (len(w.split('/')[0]) > 2 and w.split('/')[0] not 78 | in self.doc_reader.stop_list): 79 | if (not self.frame_tags or w.split('/')[1] in 80 | self.frame_tags): 81 | 82 | # Calculate score for selected word 83 | distance = abs(i - doc.index(w)) 84 | score = math.exp(distance * -0.25) 85 | 86 | # Add word and score to frame dict 87 | if w in frame: 88 | frame[w] += score 89 | else: 90 | frame[w] = score 91 | 92 | # Sort frame by highest score 93 | sorted_frame = sorted(frame.items(), key=operator.itemgetter(1), 94 | reverse=True)[:self.frame_size] 95 | 96 | frames.append(sorted_frame) 97 | 98 | return frames 99 | 100 | def print_frames(self): 101 | ''' 102 | Print generated frames. 103 | ''' 104 | print('Keywords and frames generated:') 105 | for i, k in enumerate(self.keyword_list.keywords): 106 | print('(' + str(i + 1) + ') ' + k[0] + ' [' + str(k[1]) + ']') 107 | print(', '.join([f[0] + ' (' + str(f[1]) + ')' for f in 108 | self.frames[i]])) 109 | 110 | def save_frames(self, dir_name): 111 | ''' 112 | Save generated frames to file. 113 | ''' 114 | with open(dir_name + os.sep + 'frames' + '.csv', 'wb') as f: 115 | # Manually encode a BOM, utf-8-sig didn't work with unicodecsv 116 | f.write(u'\ufeff'.encode('utf8')) 117 | csv_writer = csv.writer(f, delimiter='\t', encoding='utf-8') 118 | for i, frame in enumerate(self.frames): 119 | csv_writer.writerow([self.keyword_list.keywords[i][0]] + 120 | [f[0] for f in frame]) 121 | csv_writer.writerow([self.keyword_list.keywords[i][1]] + 122 | [str(f[1]) for f in frame]) 123 | -------------------------------------------------------------------------------- /frame-generator/generator.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Frame Generator 5 | # 6 | # Copyright (C) 2016 Juliette Lonij, Koninklijke Bibliotheek - 7 | # National Library of the Netherlands 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import argparse 23 | import documents 24 | import frames 25 | import keywords 26 | import models 27 | import os 28 | import sys 29 | import time 30 | import unicodecsv as csv 31 | 32 | 33 | def save_settings(args, output_dir): 34 | ''' 35 | Save settings to file. 36 | ''' 37 | if args['gtype'] == 'topics': 38 | output_args = ['gtype', 'dlen', 'tcount', 'tsize', 'mallet'] 39 | elif args['gtype'] == 'keywords' or args['gtype'] == 'frames': 40 | output_args = ['gtype', 'dlen', 'kmodel', 'kcount', 'ktags'] 41 | if args['kmodel'] == 'lda': 42 | output_args += ['tcount', 'tsize', 'mallet'] 43 | if args['gtype'] == 'frames': 44 | output_args += ['wdir', 'wsize', 'fsize', 'ftags'] 45 | 46 | with open(output_dir + os.sep + 'settings' + '.csv', 'wb') as f: 47 | # Manually encode a BOM, utf-8-sig didn't work with unicodecsv 48 | f.write(u'\ufeff'.encode('utf8')) 49 | csv_writer = csv.writer(f, delimiter='\t', encoding='utf-8') 50 | for arg in output_args: 51 | csv_writer.writerow([arg, str(args[arg])]) 52 | 53 | def generate(gtype='frames', dlen=0, pos=True, tcount=10, tsize=10, mallet=None, 54 | kmodel='lda', kcount=10, ktags=[], wdir=None, wsize=5, fsize=10, 55 | ftags=[], input_dir='input', output_dir='output'): 56 | ''' 57 | Generate topics, keywords or frames. 58 | ''' 59 | # Create input, output directory 60 | if output_dir == 'output': 61 | output_dir += os.sep + str(int(time.time())) 62 | os.makedirs(output_dir) 63 | 64 | # Save settings 65 | if output_dir: 66 | save_settings(locals(), output_dir) 67 | 68 | # Generate document list, dictionary and corpus 69 | doc_reader = documents.DocumentReader(input_dir, dlen, pos) 70 | if output_dir: 71 | doc_reader.save_docs(output_dir) 72 | 73 | # Generate only topics 74 | if gtype == 'topics': 75 | topic_list = models.TopicList(doc_reader, tcount, tsize, mallet) 76 | if output_dir: 77 | topic_list.save_topics(output_dir) 78 | return topic_list, None, None 79 | 80 | # Generate keywords based on tf-idf scores 81 | if kmodel == 'tf-idf': 82 | tfidf_list = models.TfIdfList(doc_reader) 83 | keyword_list = keywords.KeywordList(doc_reader, kcount, ktags, 84 | tfidf_list=tfidf_list) 85 | if output_dir: 86 | keyword_list.save_keywords(output_dir) 87 | 88 | # Generate keywords based on topics 89 | else: 90 | topic_list = models.TopicList(doc_reader, tcount, tsize, mallet) 91 | if output_dir: 92 | topic_list.save_topics(output_dir) 93 | keyword_list = keywords.KeywordList(doc_reader, kcount, ktags, 94 | topic_list=topic_list) 95 | if output_dir: 96 | keyword_list.save_keywords(output_dir) 97 | 98 | # Generate only keywords 99 | if gtype == 'keywords': 100 | return None, keyword_list, None 101 | 102 | # Generate frames based on generated keywords 103 | else: 104 | frame_list = frames.FrameList(doc_reader, keyword_list, wdir, wsize, 105 | fsize, ftags) 106 | if output_dir: 107 | frame_list.save_frames(output_dir) 108 | return None, keyword_list, frame_list 109 | 110 | if __name__ == '__main__': 111 | if sys.stdout.encoding != 'UTF-8': 112 | sys.stdout = codecs.getwriter('utf-8')(sys.stdout, 'strict') 113 | 114 | parser = argparse.ArgumentParser() 115 | 116 | # Generator arguments 117 | parser.add_argument('--gtype', required=False, type=str, default='frames', 118 | help='type of generator: topics, keywords or frames') 119 | 120 | # Corpus arguments 121 | parser.add_argument('--dlen', required=False, type=int, default=0, 122 | help='number of sentences per document') 123 | parser.add_argument('--nopos', required=False, action='store_false', 124 | help='do not apply pos-tagging') 125 | 126 | # Topics arguments 127 | parser.add_argument('--tcount', required=False, type=int, default=10, 128 | help='number of topics') 129 | parser.add_argument('--tsize', required=False, type=int, default=10, 130 | help='number of words per topic') 131 | parser.add_argument('--mallet', required=False, type=str, 132 | help='path to Mallet executable') 133 | 134 | # Keywords arguments 135 | parser.add_argument('--kmodel', required=False, type=str, default='lda', 136 | help='keyword scoring model: tf-idf or lda') 137 | parser.add_argument('--kcount', required=False, type=int, default=10, 138 | help='number of keywords') 139 | parser.add_argument('--ktags', required=False, type=str, nargs='*', 140 | default=[], help='keyword pos-tags') 141 | 142 | # Frames arguments 143 | parser.add_argument('--wdir', required=False, type=str, 144 | help='window direction: left or right') 145 | parser.add_argument('-wsize', required=False, type=int, default=5, 146 | help='window size') 147 | parser.add_argument('--fsize', required=False, type=int, default=10, 148 | help='number of words per frame') 149 | parser.add_argument('--ftags', required=False, type=str, nargs='*', 150 | default=[], help='frame pos-tags') 151 | 152 | args = parser.parse_args() 153 | 154 | topic_list, keyword_list, frame_list = generate(gtype=vars(args)['gtype'], 155 | dlen=vars(args)['dlen'], pos=vars(args)['nopos'], 156 | tcount=vars(args)['tcount'], tsize=vars(args)['tsize'], 157 | mallet=vars(args)['mallet'], kmodel=vars(args)['kmodel'], 158 | kcount=vars(args)['kcount'], ktags=vars(args)['ktags'], 159 | fsize=vars(args)['fsize'], ftags=vars(args)['ftags'], 160 | wdir=vars(args)['wdir'], wsize=vars(args)['wsize']) 161 | 162 | if frame_list: 163 | frame_list.print_frames() 164 | elif keyword_list: 165 | keyword_list.print_keywords() 166 | elif topic_list: 167 | topic_list.print_topics() 168 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Frame Generator 2 | 3 | Tool for extracting topics, keywords and their co-occurence patterns (forming so-called frames) from a Dutch corpus. 4 | 5 | ## Background 6 | 7 | The Frame Generator was created in collaboration with prof. dr. Joris van Eijnatten (UU) during his KB Digital Humanities Fellowship in 2016. Its aim is to meaningfully reducing a set of texts to word patterns that cut across the distributions generated by topic modelling, thus providing additional insight into the content of the data set. 8 | 9 | ## Features 10 | 11 | - Generate topics with the [Mallet](http://mallet.cs.umass.edu) or [Gensim](https://radimrehurek.com/gensim/) topic modelling library 12 | - Extract a single, ranked list of keywords based on either topics or tf-idf scores 13 | - Find co-occurrence patterns for the keywords in the texts from which they were originally extracted 14 | - Optionally lemmatize and pos-tag the input texts with NLP suite [Frog](https://languagemachines.github.io/frog/) and restrict the keywords and collocates to specific part-of-speech tags 15 | - Optionally correct OCR errors and spelling variations with user-provided lists of regular expressions 16 | - Access and reuse the results of each processing stage as comma-separated values files 17 | - Use from the command line, as a Python library or web application 18 | 19 | ## Requirements 20 | 21 | - Python 2.7 22 | - Mallet 2.0.7 23 | 24 | ## Installation 25 | 26 | Clone or download the GitHub repository: 27 | 28 | ``` 29 | $ git clone https://github.com/jlonij/frame-generator 30 | ``` 31 | 32 | Install the required Python packages: 33 | 34 | ``` 35 | $ cd frame-generator 36 | $ pip install -r requirements.txt 37 | ``` 38 | 39 | ### Optional install Frog + Frog wapper (Frogger) locally. 40 | 41 | Since Frog causes heavy load-spike's on our infrastructure availability cannot be guaranteed. 42 | The endpoint to which frame-generator will try to connect is a demo sever, 43 | which might be down, if you want to analyze a lot of data, change the endpoint 44 | here: 45 | 46 | https://github.com/KBNLresearch/frame-generator/blob/master/frame-generator/documents.py#L35 47 | 48 | Install Frog + Dependencies: 49 | See here: https://github.com/LanguageMachines/frog 50 | 51 | Start frog: 52 | ``` 53 | $ frog -S 4096 54 | ``` 55 | Install Frog-wrapper: 56 | 57 | Place the directory frogger in your Apache2 www-root (/var/www/frogger/), 58 | it will use a .htaccess file to launch the application from Apache. 59 | 60 | Test the wrapper without HTTP: 61 | 62 | ``` 63 | $ mv frogger /var/www/; cd /var/www/frogger; python frog.py 64 | ``` 65 | 66 | This should ouput some test text if all went well, now try the wrapper with HTTP: 67 | ``` 68 | $ curl -s http://localhost/frogger/?text="Dit is een test" 69 | ``` 70 | This sould return some test text. 71 | 72 | ## Usage 73 | 74 | Basic command line execution with the default values for all options: 75 | 76 | ``` 77 | $ cd frame-generator 78 | $ ./generator.py 79 | ``` 80 | 81 | This will generate keywords and frames for the sample documents provided and print the results: 82 | 83 | ``` 84 | Keywords and frames generated: 85 | (1) zotheid/N [0.153417875946] 86 | prijzen/WW (1.81959197914), verkondigen/WW (0.778800783071), kwaden/ADJ (0.472366552741), gepast/ADJ (0.367879441171), staan/WW (0.28650479686), aanstonds/ADJ (0.28650479686) 87 | (2) god/N [0.0681857686941] 88 | goddelijk/ADJ (0.606530659713), stellen/WW (0.606530659713), vervroolijk/ADJ (0.472366552741), uitzonderen/WW (0.367879441171) 89 | (3) mensch/N [0.0271176554179] 90 | vervroolijk/ADJ (0.778800783071), toeschrijven/WW (0.778800783071), gewoonlijk/ADJ (0.606530659713), verjagen/WW (0.367879441171), goddelijk/ADJ (0.367879441171), spreken/WW (0.28650479686) 91 | ... 92 | ``` 93 | 94 | ## Command line interface 95 | 96 | Input files are expected to be either utf-8 or iso-8859-1 encoded and have to be placed in the appropriate `frame-generator/input` subdirectories: 97 | 98 | - `docs` contains plain text files with `.txt` extension of the documents to be processed. 99 | - `stop` contains optional stop word lists to be applied when creating the vocabulary. The stop word lists should be plain text files with `.txt` extension in which each word occupies a single line. 100 | - `regex` contains optional lists of regular expressions to be replaced in the input documents. These lists should have a `.tsv` extension and consist of two tab-separated columns, the first containing the regular expression and the second its intended replacement. 101 | 102 | The Frame Generator command line interface accepts a number of options to control the process: 103 | 104 | - `--gtype`: the type of results to be generated. The user can choose between generating `topics`, `keywords` or `frames`. The default value is `frames`. 105 | - `--dlen`: the number of sentences the subdocuments used as units of analysis are to contain. Default value is `0`, in which case the original, unsplit documents will be used. 106 | - `--nopos`: when this option is entered (no value required) the part-of-speech tagging functionality of the Frame Generator is turned off. This saves a lot of processing time and allows the generator to run offline. 107 | - `--tcount`: the number of topics to be generated. Default value is `10`. 108 | - `--tsize`: the number of words to be contained in each topic. Default value is `10`. 109 | - `--mallet`: full path to the Mallet executable; if not provided, Gensim's LDA implementation will be used to generate topics. 110 | - `--kmodel`: model to be used for scoring keywords, either `lda` or `tf-idf`. By default `lda` is used, meaning keywords are extracted on the basis of a topic model. 111 | - `--kcount`: the number of keywords to be generated. Default value is `10`. 112 | - `--ktags`: the part-of-speech tags to be included in the keyword list separated by spaces, e.g. `ADJ N WW`. 113 | - `--wdir`: the direction, `left` or `right`, of the keyword in which frame words are searched for. When omitted both directions are taken into account. 114 | - `--wsize`: the maximum word distance of a frame word to the keyword. Default value is `5`. 115 | - `--fsize`: the maximum number of frame words to be generated with each keyword. Default value is `10`. 116 | - `--ftags`: the part-of-speech tags to be included in the keyword list, e.g. `ADJ N WW`. 117 | 118 | Values accepted as part-of-speech tags with the `--ktags` and `--ftags` options are the following main tags from the [CGN tag set](http://lands.let.ru.nl/cgn/doc_Dutch/topics/version_1.0/annot/pos_tagging/tg_prot.pdf): 119 | 120 | - `ADJ` Adjective 121 | - `BW` Adverb 122 | - `N` Noun 123 | - `SPEC` Names and unknown 124 | - `TSW` Interjection 125 | - `TW` Numerator 126 | - `VNW` Pronoun 127 | - `WW` Verb 128 | 129 | ## Application programming interface 130 | 131 | The Frame Generator can be used from another Python script or the Python interpreter by calling the `generate()` function in the `generator.py` script: 132 | 133 | ``` 134 | >>> import generator 135 | >>> _, keyword_list, frame_list = generator.generate() 136 | >>> keyword_list.print_keywords() 137 | Keywords generated: 138 | (1) zotheid/N [0.169311243818] 139 | (2) god/N [0.0725594158983] 140 | (3) mensch/N [0.034531287966] 141 | ... 142 | ``` 143 | 144 | The arguments of the function correspond to the command line options listed above, the function signature being: 145 | 146 | ``` 147 | generate(gtype='frames', dlen=0, pos=True, tcount=10, tsize=10, mallet=None, kmodel='lda', kcount=10, 148 | ktags=[], wdir=None, wsize=5, fsize=10, ftags=[], input_dir='input', output_dir='output') 149 | ``` 150 | 151 | ## Web application 152 | 153 | The Frame generator can also be run as a simple Bottle web application accepting post requests: 154 | 155 | ``` 156 | $ ./web.py 157 | ``` 158 | 159 | By default the service is started at `http://localhost:8091/`. 160 | 161 | ## Demo 162 | 163 | An online demo providing a graphical user interface to the Frame Generator’s main functionality and a basic visualization of the results is available at [http://www.kbresearch.nl/frames/](http://www.kbresearch.nl/frames/). The source code of the demo can be found [here](https://github.com/jlonij/frame-generator-gui). 164 | -------------------------------------------------------------------------------- /frame-generator/documents.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Frame Generator 5 | # 6 | # Copyright (C) 2016 Juliette Lonij, Koninklijke Bibliotheek - 7 | # National Library of the Netherlands 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import gensim 23 | import io 24 | import json 25 | import os 26 | import re 27 | import sys 28 | import time 29 | import urllib 30 | 31 | from lxml import etree 32 | from segtok import segmenter 33 | from segtok import tokenizer 34 | 35 | FROG_URL = 'http://www.kbresearch.nl/frogger/?' 36 | 37 | 38 | class DocumentReader(object): 39 | ''' 40 | Process input documents. 41 | ''' 42 | 43 | def __init__(self, input_dir, doc_length=0, pos_tag=True): 44 | ''' 45 | Create regex list, stop word list, document list, dictionary and corpus. 46 | ''' 47 | self.regex_dir = input_dir + os.sep + 'regex' 48 | self.doc_dir = input_dir + os.sep + 'docs' 49 | self.stop_dir = input_dir + os.sep + 'stop' 50 | 51 | self.doc_length = doc_length 52 | self.pos_tag = pos_tag 53 | 54 | self.log = [] 55 | 56 | self.regex_list = self.get_regex(self.regex_dir) 57 | self.stop_list = self.get_stop_words(self.stop_dir) 58 | self.doc_list = self.get_documents(self.doc_dir, doc_length) 59 | 60 | self.dictionary = self.get_dictionary(self.doc_list, self.stop_list) 61 | self.corpus = self.get_corpus() 62 | 63 | def get_regex(self, path): 64 | ''' 65 | Create regex list from input documents. 66 | ''' 67 | print('Processing regular expressions ...') 68 | regex_list = [] 69 | for filename in [f for f in os.listdir(path) if f[-4:] in ['.txt', 70 | '.tsv', '.csv']]: 71 | with open(path + '/' + filename) as f: 72 | print('Processing file: ' + filename) 73 | doc = self.decode(f.read()) 74 | lines = [l for l in doc.splitlines() if l] 75 | regex = [l.split('\t') for l in lines if 76 | len(l.split('\t')) == 2] 77 | regex = [[r[0].strip(), r[1].strip()] for r in regex if 78 | r[0].strip() and r[1].strip()] 79 | regex_list += regex 80 | print('Number of regular expressions: ' + str(len(regex_list))) 81 | return regex_list 82 | 83 | def get_stop_words(self, path): 84 | ''' 85 | Create stop word list from input documents. 86 | ''' 87 | print('Processing stop words ...') 88 | stop_list = [] 89 | for filename in [f for f in os.listdir(path) if f.endswith('.txt')]: 90 | print('Processing file: ' + filename) 91 | with open(path + os.sep + filename) as f: 92 | s = self.decode(f.read()) 93 | stop_list += [sw.lower() for sw in s.split() if sw] 94 | print('Number of stop words: ' + str(len(stop_list))) 95 | return stop_list 96 | 97 | def get_documents(self, path, doc_length): 98 | ''' 99 | Create document list from input documents. 100 | ''' 101 | print('Processing documents ...') 102 | docs = [] 103 | for filename in [f for f in os.listdir(path) if f[-4:] in ['.txt', 104 | '.xml']]: 105 | with open(path + '/' + filename) as f: 106 | print('Processing file: ' + filename) 107 | 108 | # Remove xml tags and decode 109 | if filename.endswith('.xml'): 110 | xml = etree.fromstring(f.read()) 111 | text = etree.tostring(xml, encoding='utf-8', method='text') 112 | doc = text.decode('utf-8') 113 | else: 114 | doc = self.decode(f.read()) 115 | 116 | # Process user provided regular expressions 117 | for regex in self.regex_list: 118 | doc = re.sub(regex[0], regex[1], doc, flags=re.I) 119 | 120 | # Remove unwanted characters and whitespace 121 | unwanted_chars = ['&', '/', '|', '_', ':', '=', '(', 122 | ')', '[', ']'] 123 | for char in unwanted_chars: 124 | doc = doc.replace(char, '') 125 | doc = ' '.join(doc.split()) 126 | 127 | # Sentence chunk with Segtok 128 | sentences = [s for s in segmenter.split_single(doc)] 129 | 130 | # Split large documents into smaller parts 131 | if doc_length > 0: 132 | sub_docs = [sentences[i:i + doc_length] for i in 133 | xrange(0, len(sentences), doc_length)] 134 | else: 135 | sub_docs = [sentences] 136 | 137 | # Tokenize with Segtok or Frog 138 | for sub_doc in sub_docs: 139 | tokens = [] 140 | if self.pos_tag: 141 | tokens += self.frogger(sub_doc, filename) 142 | else: 143 | for sentence in sub_doc: 144 | tokens += [t.lower() for t in 145 | tokenizer.word_tokenizer(sentence)] 146 | if len(tokens): 147 | docs.append(tokens) 148 | 149 | for filename in [f for f in os.listdir(path) if f.endswith('.json')]: 150 | with open(path + '/' + filename) as f: 151 | print('Processing file: ' + filename) 152 | docs += json.load(f)['docs'] 153 | 154 | print('Number of (sub)documents: ' + str(len(docs))) 155 | assert docs, 'No documents found' 156 | 157 | return docs 158 | 159 | def frogger(self, to_frog, filename): 160 | ''' 161 | Process document with Frog web service. 162 | ''' 163 | tokens = [] 164 | while len(to_frog): 165 | batch_size = min(10, len(to_frog)) 166 | batch = ' '.join(to_frog[:batch_size]) 167 | query_string = urllib.urlencode({'text': batch.encode('utf-8')}) 168 | 169 | i = 0 170 | data = None 171 | while not data: 172 | try: 173 | data = urllib.urlopen(FROG_URL + query_string) 174 | data = data.read().decode('utf-8') 175 | except IOError: 176 | if i < 2: 177 | print('Frog data not found, retrying ...') 178 | time.sleep(10) 179 | i += 1 180 | else: 181 | print('Frog data not found, skipping document!') 182 | self.log.append('Frog data not found for (part of): ' + 183 | filename) 184 | return [] 185 | 186 | new_tokens = [line.split('\t') for line in data.split('\n') 187 | if len(line)] 188 | try: 189 | assert len(new_tokens[0]) == 10, 'Frog data invalid' 190 | tokens += [t[2].lower() + '/' + t[4].split('(')[0] for t in 191 | new_tokens if len(t) == 10] 192 | except AssertionError: 193 | print('Frog data invalid, skipping document!') 194 | self.log.append('Frog data invalid for (part of): ' + filename) 195 | return [] 196 | 197 | to_frog = to_frog[batch_size:] 198 | 199 | return tokens 200 | 201 | def get_dictionary(self, doc_list, stop_list): 202 | ''' 203 | Create dictionary from document and stop word lists. 204 | ''' 205 | print('Generating dictionary ...') 206 | dictionary = gensim.corpora.Dictionary(self.iter_docs(doc_list, 207 | stop_list)) 208 | no_below = 1 if len(self.doc_list) <= 10 else 2 209 | no_above = 1 if len(self.doc_list) <= 10 else 0.95 210 | dictionary.filter_extremes(no_below=no_below, no_above=no_above, 211 | keep_n=100000) 212 | num_tokens = len(dictionary.items()) 213 | print('Number of unique tokens in dictionary: ' + str(num_tokens)) 214 | return dictionary 215 | 216 | def get_corpus(self): 217 | ''' 218 | Create corpus. 219 | ''' 220 | print('Generating corpus ...') 221 | corpus = [self.dictionary.doc2bow(text) for text in 222 | self.iter_docs(self.doc_list, self.stop_list)] 223 | return corpus 224 | 225 | def iter_docs(self, doc_list, stop_list): 226 | ''' 227 | Generate tokens from document and stop word lists. 228 | ''' 229 | unwanted_tags = ['LET', 'LID', 'VZ', 'VG'] 230 | for doc in doc_list: 231 | if self.pos_tag: 232 | yield (t for t in doc if t.split('/')[0] not in stop_list and 233 | len(t.split('/')[0]) > 2 and t.split('/')[1] not in 234 | unwanted_tags) 235 | else: 236 | yield (t for t in doc if t not in stop_list and len(t) > 2) 237 | 238 | def decode(self, s): 239 | ''' 240 | Decode utf-8 and iso-8859-1 encoded strings. 241 | ''' 242 | encodings = ['utf-8', 'iso-8859-1'] 243 | decoded = '' 244 | for e in encodings: 245 | try: 246 | decoded = s.decode(e) 247 | break 248 | except UnicodeDecodeError: 249 | continue 250 | return decoded 251 | 252 | def save_docs(self, output_dir): 253 | ''' 254 | Save processed documents to file. 255 | ''' 256 | data = {'docs': self.doc_list} 257 | with io.open(output_dir + os.sep + 'docs.json', 'w', 258 | encoding='utf-8') as f: 259 | f.write(unicode(json.dumps(data, ensure_ascii=False))) 260 | if self.log: 261 | with open(output_dir + os.sep + 'log' + '.txt', 'w') as f: 262 | for line in self.log: 263 | f.write(line + '\n') 264 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a 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 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------