Bump up version

CHANGELOG.md

@@ -1,4 +1,34 @@
 
+<a name="4.4.2"></a>
+## 4.4.2 (2021-07-14)
+
+Improvements:
+
+* add gonitobestentry and eng commands
+* detect all .tex sources
+* improve gitignore
+* fix locale when running Autozoil
+* fix re-downloading NeurIPS files
+
+<a name="4.4.1"></a>
+## 4.4.1 (2021-04-30)
+
+Bug fixes
+
+* Minor fix in NeurIPS
+
+<a name="4.4.0"></a>
+## 4.4.0 (2021-04-30)
+
+Enhancements
+
+* Add NeurIPS template
+
+Bug fixes
+
+* Add .ft files to .gitignore
+* Get rid of lorem ipsum in AMU template
+
 <a name="4.3.0"></a>
 ## 4.3.0 (2021-04-15)
 

README.md

@@ -6,8 +6,8 @@ The template itself is in the `{{cookiecutter.paper_id}}-paper`.
 In order to generate a project from the template:
 
 * install cookiecutter
-* find a paper-cutter tag applicable (usually the latest tag listed at <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say VERSION
+* find a paper-cutter tag applicable (usually the latest tag listed at <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say 4.4.2
-* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout VERSION`
+* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 4.4.2`
 
 You will be asked to choose a LaTeX template, at the moment the
 following templates are handled:
@@ -22,8 +22,10 @@ following templates are handled:
 * LLNCS (`llncs`)
 * EMNLP (`emnlp`)
 * EACL (`eacl`)
+* NeurIPS (`neurips`)
 * PolEval (`poleval`)
-* Msc thesis at Adam Mickiewicz University, Faculty of Mathematics and Computer Science (`amu`)
+* Msc thesis at Adam Mickiewicz University, Faculty of Mathematics and Computer Science (`amu`),
+  template prepared by Bartłomiej Przybylski (https://github.com/bprzybylski/amuthesis)
 
 If you are to use another template, prepare an MR to this repo first!
 Do not add directly to your specific paper.
@@ -51,7 +53,7 @@ git remote set-url origin YOUR-GIT-REPO
    password: `git config credential.helper "cache --timeout=10000000"`
 8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip
    is uploaded, also file permissions will be somewhat broken
-9.  … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`)
+9.  … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 4.4.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`)
 10. Re-commit the files (including recovered `.*` files).
 11. Push the repo to Overleaf (fortunately, the `.*` will be treated
    correctly when this is done by git): `git push overleaf master`
@@ -65,10 +67,10 @@ Updating package with updated template
 To keep your codebase in sync with template you need to occasionally reapply the template.
 Here's how:
 
-* find a paper-cutter tag applicable, say VERSION
+* find a paper-cutter tag applicable, say 4.4.2
 * (do *not* refer to master in your projects!)
 * go to project root
-* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
+* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 4.4.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
 * check changes with git
 
 Editing the files
@@ -91,7 +93,7 @@ Switching to another conference or journal template is easy.
    If not, get in touch with Filip Graliński.
 2. Commit or stash any uncommitted changes.
 3. Change the `latex_template` value accordingly in the `.cookiecutter.yml` file. Commit the changes.
-4. Re-run the template (as if updating, see above: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`).
+4. Re-run the template (as if updating, see above: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 4.4.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`).
 5. Compare `metadata.tex` against the right metadata template file
    (`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes
    needed. This is the only thing that needs to be done manually

hooks/post_gen_project.sh

@@ -84,6 +84,12 @@ elif [ "{{ cookiecutter.latex_template }}" = "eacl" ]; then
     if [ "{{ cookiecutter.with_appendix }}" = "yes" ]; then
         cp -r _latex-templates/acl2020-template-appendix.tex the-appendix.tex
     fi
+elif [ "{{ cookiecutter.latex_template }}" == "neurips" ]; then
+    rm -f neurips_2021.sty
+    wget -O neurips_2021.sty https://media.neurips.cc/Conferences/NeurIPS2021/Styles/neurips_2021.sty
+    cp -r _latex-templates/neurips-template.tex {{cookiecutter.paper_id}}.tex
+    cp -r _latex-templates/neurips-template-meta.tex metadata.tex
+    cp -r _latex-templates/neurips-checklist.tex checklist.tex
 elif [ "{{ cookiecutter.latex_template }}" = "poleval" ]; then
     cp -r _latex-templates/poleval-template.tex {{cookiecutter.paper_id}}.tex
     cp -r _latex-templates/poleval-template-meta.tex metadata.tex

test/configs/neurips.yml

@@ -0,0 +1,3 @@
+
+default_context:
+  latex_template: 'neurips'

{{cookiecutter.paper_repo_name}}/.gitignore

@@ -145,6 +145,10 @@ vcs.xml
 *.lot
 *.lof
 *.ft
+*.tdo
+*.bcf
+*.lol
+*.run.xml
 /auto
 {{cookiecutter.paper_id}}.pdf
 {{cookiecutter.paper_id}}.zip

{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml

@@ -6,5 +6,5 @@ variables:
 # THIS IS AN UGLY WORK-AROUND
 include:
   - project: 'research/paper-cutter'
-    ref: '4.3.0'
+    ref: '4.4.2'
     file: 'main.yml'

{{cookiecutter.paper_repo_name}}/Makefile

@@ -1,4 +1,4 @@
-SHELL=/bin/bash
+SHELL=/bin/bash -O globstar
 
 # Do not edit these values, they should be changed by modifying .cookiecutter.yml
 # and re-applying the template
@@ -7,7 +7,7 @@ HAS_APPENDIX={{cookiecutter.with_appendix}}
 LATEX_TEMPLATE={{cookiecutter.latex_template}}
 WITH_ARXIV_PACKAGE={{cookiecutter.with_arxiv_package}}
 
-CONTENT_TEX_SOURCES=$(filter-out $(PAPER_ID).tex config.tex other-extras.tex autozoil-extras.tex extras.tex metadata.tex preamble.tex the-appendix.tex, $(wildcard *.tex))
+CONTENT_TEX_SOURCES=$(filter-out $(PAPER_ID).tex config.tex other-extras.tex autozoil-extras.tex extras.tex metadata.tex preamble.tex the-appendix.tex, $(shell ls **/*.tex))
 
 CURRENT_DIR=$(shell pwd)
 AUTOZOIL_DIR?=/opt/autozoil

{{cookiecutter.paper_repo_name}}/_latex-templates/amu-template.tex

@@ -22,8 +22,6 @@
 % Dodatkowe pakiety wykorzystywane w pracy                 %
 % ======================================================== %
 
-\usepackage{lipsum}
-
 % ----------------------   PREAMBLE PART ------------------------------
 
 \input{config}
@@ -50,7 +48,6 @@
 
 % Blok abstraktu w języku polskim
 \begin{streszczenie}
-\lipsum[1]
 \input{abstract-pl}
 
 \paragraph{Słowa kluczowe:} klasa
@@ -58,7 +55,7 @@
 
 % Blok abstraktu w języku angielskim
 \begin{abstract}
-\lipsum[2]
+\input{abstract}
 \input{abstract}
 
 \paragraph{Keywords:} klasa
@@ -82,7 +79,5 @@ Tu możesz umieścić swoją dedykację.
 \bibliography{bibliography}
 
 
-\lipsum[3]
-
 \end{document}
 {% endraw %}

{{cookiecutter.paper_repo_name}}/_latex-templates/neurips-checklist.tex

@@ -0,0 +1,69 @@
+{% raw %}
+
+% taken from https://media.neurips.cc/Conferences/NeurIPS2021/Styles/neurips_2021.tex
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section*{Checklist}
+
+\begin{enumerate}
+
+\item For all authors...
+\begin{enumerate}
+  \item Do the main claims made in the abstract and introduction accurately reflect the paper's contributions and scope?
+    \answerTODO{}
+  \item Did you describe the limitations of your work?
+    \answerTODO{}
+  \item Did you discuss any potential negative societal impacts of your work?
+    \answerTODO{}
+  \item Have you read the ethics review guidelines and ensured that your paper conforms to them?
+    \answerTODO{}
+\end{enumerate}
+
+\item If you are including theoretical results...
+\begin{enumerate}
+  \item Did you state the full set of assumptions of all theoretical results?
+    \answerTODO{}
+	\item Did you include complete proofs of all theoretical results?
+    \answerTODO{}
+\end{enumerate}
+
+\item If you ran experiments...
+\begin{enumerate}
+  \item Did you include the code, data, and instructions needed to reproduce the main experimental results (either in the supplemental material or as a URL)?
+    \answerTODO{}
+  \item Did you specify all the training details (e.g., data splits, hyperparameters, how they were chosen)?
+    \answerTODO{}
+	\item Did you report error bars (e.g., with respect to the random seed after running experiments multiple times)?
+    \answerTODO{}
+	\item Did you include the total amount of compute and the type of resources used (e.g., type of GPUs, internal cluster, or cloud provider)?
+    \answerTODO{}
+\end{enumerate}
+
+\item If you are using existing assets (e.g., code, data, models) or curating/releasing new assets...
+\begin{enumerate}
+  \item If your work uses existing assets, did you cite the creators?
+    \answerTODO{}
+  \item Did you mention the license of the assets?
+    \answerTODO{}
+  \item Did you include any new assets either in the supplemental material or as a URL?
+    \answerTODO{}
+  \item Did you discuss whether and how consent was obtained from people whose data you're using/curating?
+    \answerTODO{}
+  \item Did you discuss whether the data you are using/curating contains personally identifiable information or offensive content?
+    \answerTODO{}
+\end{enumerate}
+
+\item If you used crowdsourcing or conducted research with human subjects...
+\begin{enumerate}
+  \item Did you include the full text of instructions given to participants and screenshots, if applicable?
+    \answerTODO{}
+  \item Did you describe any potential participant risks, with links to Institutional Review Board (IRB) approvals, if applicable?
+    \answerTODO{}
+  \item Did you include the estimated hourly wage paid to participants and the total amount spent on participant compensation?
+    \answerTODO{}
+\end{enumerate}
+
+\end{enumerate}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+{% endraw %}

{{cookiecutter.paper_repo_name}}/_latex-templates/neurips-template-meta.tex

@@ -0,0 +1,39 @@
+\title{ {{ cookiecutter.paper_title }} }
+
+% The \author macro works with any number of authors. There are two commands
+% used to separate the names and addresses of multiple authors: \And and \AND.
+%
+% Using \And between authors leaves it to LaTeX to determine where to break the
+% lines. Using \AND forces a line break at that point. So, if LaTeX puts 3 of 4
+% authors names on the first line, and the last on the second line, try using
+% \AND instead of \And before the third author name.
+
+\author{ {{cookiecutter.main_contributor_name}}\thanks{Use footnote for providing further information
+    about author (webpage, alternative address)---\emph{not} for acknowledging
+    funding agencies.} \\
+  Department of Computer Science\\
+  Cranberry-Lemon University\\
+  Pittsburgh, PA 15213 \\
+  \texttt{hippo@cs.cranberry-lemon.edu} \\
+  % examples of more authors
+  % \And
+  % Coauthor \\
+  % Affiliation \\
+  % Address \\
+  % \texttt{email} \\
+  % \AND
+  % Coauthor \\
+  % Affiliation \\
+  % Address \\
+  % \texttt{email} \\
+  % \And
+  % Coauthor \\
+  % Affiliation \\
+  % Address \\
+  % \texttt{email} \\
+  % \And
+  % Coauthor \\
+  % Affiliation \\
+  % Address \\
+  % \texttt{email} \\
+}

{{cookiecutter.paper_repo_name}}/_latex-templates/neurips-template.tex

@@ -0,0 +1,71 @@
+{% raw %}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% [paper-cutter clarifications]
+%
+% DO NOT EDIT THIS FILE (unless you know what you are doing).
+% THIS IS A FILE SUPPLIED BY THE TEMPLATE.
+% PLEASE EDIT main.tex INSTEAD.
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% based on https://media.neurips.cc/Conferences/NeurIPS2021/Styles/neurips_2021.tex
+
+\documentclass{article}
+
+% if you need to pass options to natbib, use, e.g.:
+%     \PassOptionsToPackage{numbers, compress}{natbib}
+% before loading neurips_2021
+
+% ready for submission
+\usepackage{neurips_2021}
+
+% to compile a preprint version, e.g., for submission to arXiv, add add the
+% [preprint] option:
+%     \usepackage[preprint]{neurips_2021}
+
+% to compile a camera-ready version, add the [final] option, e.g.:
+%     \usepackage[final]{neurips_2021}
+
+% to avoid loading the natbib package, add option nonatbib:
+%    \usepackage[nonatbib]{neurips_2021}
+
+\usepackage[utf8]{inputenc} % allow utf-8 input
+\usepackage[T1]{fontenc}    % use 8-bit T1 fonts
+\usepackage{hyperref}       % hyperlinks
+\usepackage{url}            % simple URL typesetting
+\usepackage{booktabs}       % professional-quality tables
+\usepackage{amsfonts}       % blackboard math symbols
+\usepackage{nicefrac}       % compact symbols for 1/2, etc.
+\usepackage{microtype}      % microtypography
+\usepackage{xcolor}         % colors
+
+\newcommand\bycite[1]{by~\cite{#1}}
+
+\input{config}
+\input{extras}
+\input{preamble}
+\input{metadata}
+
+\begin{document}
+
+\maketitle
+
+\begin{abstract}
+\input{abstract}
+\end{abstract}
+
+\input{main}
+
+\bibliography{bibliography}
+\bibliographystyle{abbrv}
+
+\input{checklist.tex}
+
+\ifwithappendix
+\appendix
+\section{Appendix}
+\input{appendix}
+\fi
+
+\end{document}
+{% endraw %}

{{cookiecutter.paper_repo_name}}/autozoil-extras.tex

@@ -2,4 +2,5 @@
 \newcommand{\code}[1]{\texttt{#1}}
 \newcommand{\noqa}[1]{}
 \newcommand{\noqall}[1]{}
+\newcommand{\eng}[1]{\textit{#1}}
 {% endraw %}

{{cookiecutter.paper_repo_name}}/autozoil-via-docker.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-docker run -v $(pwd):/link  -it loxygen/autozoil /opt/autozoil/autozoil --locale en_US /link/main.tex --alt-log-file /link/{{cookiecutter.paper_id}}.log
+docker run -v $(pwd):/link  -it loxygen/autozoil /opt/autozoil/autozoil --locale {{cookiecutter.locale}} /link/main.tex --alt-log-file /link/{{cookiecutter.paper_id}}.log

{{cookiecutter.paper_repo_name}}/helpers/prepare-arxiv-package.sh

@@ -109,6 +109,9 @@ then
 elif [[ "$latex_template" == "eacl" ]]
 then
      copy_to_project eacl2021.sty acl.bst acl_natbib.bst
+elif [[ "$latex_template" == "neurips" ]]
+then
+     copy_to_project neurips_2021.sty
 elif [[ "$latex_template" == "poleval" ]]
 then
      copy_to_project poleval.bst poleval.cls

{{cookiecutter.paper_repo_name}}/other-extras.tex

@@ -37,4 +37,7 @@
 \newcommand{\gonitoscore}[1]{\gonitobarescore{#1} \gonitoref{#1}}
 % A reference and a score as two cells in a table
 \newcommand{\gonitoentry}[1]{\gonitoref{#1} & \minput{scores/#1.txt}}
+% A reference and a score as two cells in a table, the score will be
+% marked as the best (typeset in bold)
+\newcommand{\gonitobestentry}[1]{\gonitoref{#1} & \textbf{\minput{scores/#1.txt}}}
 {% endraw %}