forked from iml-wg/HEPML-LivingReview
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmake_md.py
398 lines (352 loc) · 18.1 KB
/
make_md.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
import os
from dataclasses import dataclass
from datetime import date, datetime
import requests
update_journal = False
update_recent = False
update_plot = False
myfile = open("HEPML.tex", encoding="utf8")
myfile_readme = open("README.md","w", encoding="utf8")
myfile_out = open("docs/index.md","w", encoding="utf8")
myfile_about = open("docs/about.md", "w",encoding="utf8")
for file in myfile_about,myfile_out:
file.write("---\nhide:\n - navigation\n---\n\n")
with open("script.js") as script:
myfile_out.write('<script>\n')
for line in script:
myfile_out.write(line)
myfile_out.write('\n</script>\n\n')
for file in myfile_readme,myfile_out:
file.write("# **A Living Review of Machine Learning for Particle Physics**\n\n")
file.write("*Modern machine learning techniques, including deep learning, is rapidly being applied, adapted, and developed for high energy physics. The goal of this document is to provide a nearly comprehensive list of citations for those developing and applying these approaches to experimental, phenomenological, or theoretical analyses. As a living document, it will be updated as often as possible to incorporate the latest developments. A list of proper (unchanging) reviews can be found within. Papers are grouped into a small set of topics to be as useful as possible. Suggestions are most welcome.*\n\n")
file.write("[](https://iml-wg.github.io/HEPML-LivingReview/assets/hepml_review.pdf)\n[](https://github.com/iml-wg/HEPML-LivingReview)\n\n")
# neccessary in testing since readme and out file are at different locations.
# once merged to master, link can point to file on master branch for both
myfile_readme.write('<p align="center"><img src="docs/assets/per_year.png" width="75%", alt="Publications per Year"></p>\n\n')
myfile_out.write('<p align="center"><img src="assets/per_year.png#only-light" width="75%", alt="Publications per Year"></p>\n')
myfile_out.write('<p align="center"><img src="assets/dark_per_year.png#only-dark" width="75%", alt="Publications per Year"></p>\n\n')
for file in myfile_readme,myfile_about:
file.write(r"The purpose of this note is to collect references for modern machine learning as applied to particle physics. A minimal number of categories is chosen in order to be as useful as possible. Note that papers may be referenced in more than one category. The fact that a paper is listed in this document does not endorse or validate its content - that is for the community (and for peer-review) to decide. Furthermore, the classification here is a best attempt and may have flaws - please let us know if (a) we have missed a paper you think should be included, (b) a paper has been misclassified, or (c) a citation for a paper is not correct or if the journal information is now available. In order to be as useful as possible, this document will continue to evolve so please check back before you write your next paper. If you find this review helpful, please consider citing it using ```\cite{hepmllivingreview}``` in `HEPML.bib`.")
file.write("\n\nThis review was built with the help of the HEP-ML community, the [INSPIRE REST API](https://github.com/inspirehep/rest-api-doc), and the moderators Benjamin Nachman, Matthew Feickert, Claudius Krause, and Ramon Winterhalder.\n\n")
###Add buttons
myfile_out.write("""\n<a class="md-button" onClick="expandElements(true)">Expand all sections</a>\n<a class="md-button" onClick="expandElements(false)">Collapse all sections</a>\n""")
###This bit is slightly modified from Kyle Cranmer https://github.com/cranmer/inspire_play
def summarize_record(recid):
url = 'https://labs.inspirehep.net/api/arxiv/'+str(recid)
max_authors = 5
r = requests.get(url)
mini_dict = {'recid':recid}
if 'metadata' in r.json():
data = r.json()['metadata']
mini_dict.update({'title':data['titles'][0]['title']})
if 'authors' in data:
if len(data['authors'])>max_authors:
#mini_dict.update({'authors':[a['full_name'] for a in data['authors'][:max_authors]]+['et. al.']})
mini_dict.update({'authors':"; ".join([a['full_name'] for a in data['authors'][:max_authors]]+['et. al.'])})
else:
mini_dict.update({'authors':[a['full_name'] for a in data['authors']]})
else:
mini_dict.update({'authors':'PLEASE CHECK'})
print(f"please check entry for {data['arxiv_eprints'][0]['value']}")
if 'collaborations' in data:
mini_dict.update({'collaboration': data['collaborations'][0]['value']})
mini_dict.update({'arxiv_eprint': data['arxiv_eprints'][0]['value']})
mini_dict.update({'url': 'https://arxiv.org/abs/'+data['arxiv_eprints'][0]['value']})
if 'legacy_creation_date' in data:
mini_dict.update({'creation_date': data['legacy_creation_date']})
if 'publication_info' in data:
pub_data = data['publication_info'][0]
if 'journal_title' in pub_data:
mini_dict.update({'journal_title':data['publication_info'][0]['journal_title']})
if 'journal_volume' in pub_data:
mini_dict.update({'journal_volume':data['publication_info'][0]['journal_volume']})
if 'page_start' in pub_data:
mini_dict.update({'page_start':data['publication_info'][0]['page_start']})
elif 'artid' in pub_data:
# some journals (like PRD) have just an ID that is usually in spires record as page
mini_dict.update({'page_start':data['publication_info'][0]['artid']})
if 'journal_year' in pub_data:
mini_dict.update({'journal_year':data['publication_info'][0]['year']})
if 'dois' in data:
mini_dict.update({'doi': data['dois'][0]['value']})
return mini_dict
def convert_from_bib(myline):
#Not the most elegant way, but quick and dirty. Files are not big, so this doesn't take long.
myline = myline.replace(" ","").replace("\n","")
myfile_bib = open("HEPML.bib", encoding="utf8")
mylines = []
for line in myfile_bib:
mylines+=[line]
pass
myentry = []
for i in range(len(mylines)):
if myline in mylines[i]:
j = i+1
myentry+=[mylines[i]]
while "@" not in mylines[j]:
myentry+=[mylines[j]]
j+=1
pass
pass
pass
myentry_dict = {}
for entry in myentry:
entry_cleaned = entry.replace("\"{","").replace("}\",","").replace("},","")
entry_cleaned = entry_cleaned.replace(" =","=")
entry_cleaned = entry_cleaned.replace("= ","=")
first_entry = entry_cleaned.split("=")[0]
if "title" in first_entry and not "booktitle" in first_entry:
myentry_dict["title"] = entry_cleaned.split("title")[1].split("=")[1].split("\n")[0]
pass
elif "eprint" in first_entry:
myentry_dict["eprint"] = entry_cleaned.split("eprint")[1].split("=")[1].split("\n")[0].replace("\"","").replace(",","").replace("\'","").replace(" ","")
if "{" in myentry_dict["eprint"]:
myentry_dict["eprint"] = myentry_dict["eprint"][1:]
pass
elif "year" in first_entry:
myentry_dict["year"] = entry_cleaned.split("year")[1].split("=")[1].split("\n")[0].replace("\"","").replace("{","").replace("}","").replace(",","")
pass
elif "doi" in first_entry:
myentry_dict["doi"] = entry_cleaned.split("doi")[1].split("=")[1].split("\n")[0].replace("\"","").replace(",","").replace("\'","").replace(" ","")
elif "url" in first_entry:
if "@" in first_entry:
continue
myentry_dict["url"] = entry_cleaned.split("url")[1].split("=")[1].split("\n")[0].replace("\"","").replace(",","").replace("\'","").replace(" ","")
else:
#print(entry_cleaned)
pass
pass
if "eprint" in myentry_dict and 'doi' not in myentry_dict and update_journal:
#check inspire
inspire_dict = summarize_record(myentry_dict['eprint'])
if 'doi' in inspire_dict:
print("Updating journal ref for ",myline)
myentry_dict['doi'] = inspire_dict['doi']
#print(inspire_dict)
myfile_bib_copy = open("HEPML_copy.bib","w", encoding="utf8")
myfile_bib = open("HEPML.bib", encoding="utf8")
for line in myfile_bib:
myfile_bib_copy.write(line)
if myentry_dict['eprint'] in line and "eprint" in line:
if "journal_title" in inspire_dict:
myfile_bib_copy.write(" journal=\""+inspire_dict['journal_title']+"\",\n")
if "journal_volume" in inspire_dict:
myfile_bib_copy.write(" volume=\""+inspire_dict['journal_volume']+"\",\n")
if "page_start" in inspire_dict:
myfile_bib_copy.write(" pages=\""+inspire_dict['page_start']+"\",\n")
if "doi" in inspire_dict:
myfile_bib_copy.write(" doi=\""+inspire_dict['doi']+"\",\n")
pass
pass
pass
os.system("mv HEPML_copy.bib HEPML.bib")
#exit(1)
if "title" not in myentry_dict:
print(myline)
print(myentry)
print("We are in trouble ! ")
if "eprint" in myentry_dict:
paper=""
year_extract = myentry_dict["eprint"].split(".")[0][:2]
year = f" (20{year_extract})"
if "doi" in myentry_dict:
paper=f" [[DOI](https://doi.org/{myentry_dict['doi']})]"
elif "url" in myentry_dict:
paper=f" [[url]({myentry_dict['url']})]"
YEARS_FOR_PLOT.append(year)
return "["+myentry_dict["title"]+"](https://arxiv.org/abs/"+myentry_dict["eprint"]+")"+paper+year
elif "doi" in myentry_dict:
year=""
if "year" in myentry_dict:
year = f" ({myentry_dict['year']})"
YEARS_FOR_PLOT.append(year)
return "["+myentry_dict["title"]+"](https://doi.org/"+myentry_dict["doi"]+")"+year
elif "url" in myentry_dict:
year=""
if "year" in myentry_dict:
year = f" ({myentry_dict['year']})"
YEARS_FOR_PLOT.append(year)
return "["+myentry_dict["title"]+"]("+myentry_dict["url"]+")"+year
else:
year=""
if "year" in myentry_dict:
year = f" ({myentry_dict['year']})"
YEARS_FOR_PLOT.append(year)
return myentry_dict["title"]+year
return myline
def write_to_files(*args,readme=myfile_readme,webpage=myfile_out,add_header=False):
for line in args:
readme.write(line)
split = line.split("###")
if line.find('####') == -1:
if len(split) > 1:
webpage.write("\n??? example "+"\""+split[-1].strip()+"\"")
webpage.write("\n <div class=\"meta_for_parser tablespecs\"\n style=\"font-size: 1pt;visibility:hidden\" markdown>")
webpage.write("\n "+line.strip('\n\r')+"\n </div>\n\n")
elif line[0] == '*':
webpage.write(" "+line)
else: webpage.write(line)
else:
webpage.write(" "+line)
if add_header:
split = line.split("##")
webpage.write("\n??? example "+"\""+split[-1].strip()+"\"\n\n")
itemize_counter = 0
YEARS_FOR_PLOT = []
for line in myfile:
if "author" in line:
continue
if "\\item \\textbf{" in line:
line = line.replace("\\textbf{","")
i = line.find("}")
j = line.find("{")
while j != -1 and j < i:
i = line.find("}", i+1)
j = line.find("{", i+1)
line = line[:i] + line[i+1:-1]
if "textit{" in line:
continue
if "item" in line:
if "begin{itemize}" in line:
itemize_counter+=1
elif "end{itemize}" in line:
itemize_counter-=1
else:
#print(itemize_counter,line)
if (itemize_counter==1):
hascites = len(line.split("cite"))
if (hascites==1):
if "Experimental" not in line:
write_to_files("## "+line.replace(r"\item","")+"\n")
else:
write_to_files("## Experimental results.\n *This section is incomplete as there are many results that directly and indirectly (e.g. via flavor tagging) use modern machine learning techniques. We will try to highlight experimental results that use deep learning in a critical way for the final analysis sensitivity.*\n\n")
else:
write_to_files("## "+line.replace(r"\item","").split(r"~\cite")[0]+".\n\n",add_header=True)
mycites = line.split(r"~\cite{")[1].split("}")[0].split(",")
for cite in mycites:
write_to_files("* "+convert_from_bib(cite)+"\n")
pass
write_to_files("\n")
pass
pass
else:
mybuffer = ""
header = '##'
for j in range(itemize_counter-1):
# mybuffer+=" "
header+='#'
pass
if (":~" in line):
write_to_files(header+line.split(r"~\cite{")[0].split(r"\item")[1]+"\n\n")
mycites = line.split(r"~\cite{")[1].replace("}","").split(",")
for cite in mycites:
write_to_files(mybuffer+"* "+convert_from_bib(cite)+"\n")
pass
write_to_files("\n")
elif "cite" in line:
write_to_files(header+" "+line.split(r"~\cite{")[0].split(r"\item")[1]+"\n\n")
mycites = line.split(r"~\cite{")[1].split("}")[0].split(",")
for cite in mycites:
write_to_files(mybuffer+"* "+convert_from_bib(cite)+"\n")
pass
write_to_files("\n")
pass
else:
write_to_files(header+line.split(r"\item")[1]+"\n\n")
pass
if update_plot:
import matplotlib.pyplot as plt
import numpy as np
names =["per_year.png", "dark_per_year.png"]
for name in names:
if name == "dark_per_year.png":
plt.style.use('dark_background')
#plt.rcParams.update({"text.usetex": True,
# "font.family": "Helvetica"})
min_year = 2000
clean_list = []
for entry in YEARS_FOR_PLOT:
clean_list.append(int(entry.replace(" (", "").replace(")", "")))
years, counts = np.unique(clean_list, return_counts=True)
plt.figure(figsize=(6,4))
plt.bar(years, counts, zorder=5)
plt.title(r"Number of HEP-ML Papers by Year", fontsize=16)
plt.xlabel(r"Year", fontsize=12)
plt.ylabel(r"Number of Papers", fontsize=12)
plt.xlim(min_year, years.max()+1)
plt.grid(axis='y', zorder=0)
labels = np.arange(min_year, years.max()+1)
plt.gca().set_xticks(labels, [str(lbl) for lbl in labels], rotation=90, ha='center')
plt.xticks(rotation=90)
plt.tight_layout()
plt.gca().text(0.02, 0.98, f'As of {date.today().strftime("%d.%m.%Y")}',
verticalalignment='top', horizontalalignment='left',
transform=plt.gca().transAxes)
plt.savefig(f'docs/assets/{name}', transparent=True)
def get_year_month(period_months=3):
month_up = datetime.now().month
year = datetime.now().year
month_low = month_up - period_months
dates = []
if month_low < 1:
month_n = 13 + month_low
dates += [(year-1,m) for m in range(month_n,13)]
month_low = 0 if month_low < 1 else month_low
dates += [(year,m+1) for m in range(month_low,month_up)]
return dates
@dataclass
class Cite:
name: str
month: int
year: int
refs = []
prev_months = 4
dates = get_year_month(prev_months)
month_dict = {
1: "January",
2: "February",
3: "March",
4: "April",
5: "May",
6: "June",
7: "July",
8: "August",
9: "September",
10: "October",
11: "November",
12: "December"
}
if update_recent:
print("Compiling new references in dates:",dates)
with open('HEPML.bib') as bibfile:
id = None
month = None
year = None
for line in bibfile:
if len(line.split('@')) > 1:
id = line.split('{')[-1]
elif 'month' in line:
month = int(''.join(filter(str.isdigit,line.split('=')[1])))
elif 'year =' in line:
year = int(''.join(filter(str.isdigit,line.split('=')[1])))
if id and month and year:
# print((month,year))
# print((month,year) in dates)
if (year,month) in dates:
refs.append(Cite(id,month,year))
else:
break
id,month,year = None,None,None
myfile_out = open("docs/recent.md", "w",encoding="utf8")
myfile_out.write("---\nhide:\n - navigation\nsearch:\n exclude: true\n---\n\n")
myfile_out.write(f"# Recent Publications\n\nThis is an automatically compiled list of papers which have been added to the living review that were made public within the previous {prev_months} months at the time of updating. This is not an exhaustive list of released papers, and is only able to find those which have both year and month data provided in the bib reference.\n")
current_year = refs[0].year
current_month = refs[0].month
myfile_out.write(f'\n## {month_dict[current_month]} {current_year}\n')
for cite in refs:
if (cite.year != current_year) | (cite.month != current_month):
current_year = cite.year
current_month = cite.month
myfile_out.write(f'\n## {month_dict[current_month]} {current_year}\n')
myfile_out.write("* "+convert_from_bib(cite.name)+"\n")
myfile_out.write('\n')