Project motivation/ Must see before writing/ Final draft must be checked/ The words of a hundred/ list of organizers/ Contributor list
Many beginner students often make some common small mistakes when submitting manuscripts. In order to save everyone's time and help everyone to locate some small problems as soon as possible. This project summarizes our own experience in the submission process and the submission experience of some teachers and students around us. I hope it can be helpful to everyone. Due to our limited level, if there are any omissions, please forgive me. thank you all.
Features of this project：
- MUST READ BEFORE WRITING: Contains some common mistakes, each with examples for a quick overview before you start writing your paper. 2.The final manuscript must be checked: contains some examples, which is convenient to quickly locate whether there are errors in your paper.
- Words of a Hundred Schools: Some writing resources published on the Internet (not complete, welcome to add) have been compiled to facilitate systematic study.
All tips listed in this project are for reference only and are not guaranteed to be correct. This paper mainly focuses on the papers of the top conference, and the writing of the papers is subject to the actual needs. Familiarity with writing techniques may lead to writing without obvious blunders, and a good essay requires constant polishing. All content only comes from the author's personal experience, Internet data, the relevant accumulation of the author's team's daily scientific research work, and the words and deeds of the big men around the author's team. If you have any questions, please submit Issue or PR. In addition, the badges used in this project are from the Internet. If you infringe the copyright of your pictures, please contact us to delete them, thank you.
Paper Writing Tips is currently an ongoing project, if omissions are inevitable, any PR and issue discussions are welcome.
In the following, the content marked "Attention" is the suggested item that the organizer considers to be (more) obviously controversial.
- Important: To avoid confusing the letter l with the number 1, the letter l can be replaced with \ell.
- Key Point: Structured values such as sentence sequences, trees, graphs, etc.
- Important: Use \mathbf for Latin letters and \boldsymbol for Greek letters
- don't split up and write do nots
- Possessive 's are converted to of
- e.g., means for example,
- i.e., means that is,
- et al. means and others of the same kind,
- etc. means and others, not used to enumerate people
- et al. or etc. at the end of a sentence without adding an extra period
The key positions are as shown, using `` and '' to represent left and right quotation marks respectively, not other symbols or any Chinese quotation marks
Use ~ for non-breaking spaces, which do not cause unexpected newlines, eg: ' for left and right quotes respectively, not other symbols or any Chinese quotes.：
Figure~\ref{} shows the model performance.
Table~\ref{} shows dataset details.
We use BERT~\cite{bert} model.
Section~\ref{} concludes this paper.
To use the \url{} command, you need to import the package:
\usepackage{hyperref}
Quoted expressions consider italic \textit{} instead of quotation marks.
Variables or symbols with more than one letter such as softmax, proj, enc, etc. in the formula, use the text font, that is, use the \textrm or \textit command.
Many functions and symbols have ready-made commands, such as: \arg{}, \max{}, \sin{}, \tanh{}, \inf, \det{}, \exp{}.
-
Such as \left(\right), \left{\right}, \left<\right>, \left|\right|, etc.
-
The division in parentheses is achieved by \middle.
-
The latex code is as follows:
\begin{gather} \bold{s} = \left(\sum_{i=0}^{N-1}{\alpha_{i} \bold{h}_i}\right) + \bold{h}_N\\ \bold{s} = (\sum_{i=0}^{N-1}{\alpha_{i} \bold{h}_i}) + \bold{h}_N \\ \end{gather} \begin{gather} \left\{ x \middle| x\ne\frac{1}{2}\right\} \\ \{ x | x\ne\frac{1}{2}\} \end{gather}
-
Use align to represent a set of formulas, with equal signs aligned.
-
The latex code is as follows:
\begin{gather} E = m c^2 \\ C = B \log_2\left(1+\frac{S}{N}\right) \end{gather} \begin{align} E &= m c^2 \\ C &= B \log_2\left(1+\frac{S}{N}\right) \end{align}
-
Recommendation: Only add numbers to refer formulas, and \nonumber to number them.
-
The latex code is as follows:
\begin{equation} E = m c^2 \end{equation} \begin{equation} E = m c^2 \nonumber \end{equation}
-
When drawing tables, use \usepackage{booktabs} to draw nice dividers with the help of \toprule, \bottomrule, \midrule, \cmidrule commands.
-
The latex code is as follows:
% Example of a table with booktabs from https://nhigham.com/2019/11/19/better-latex-tables-with-booktabs/. % First version of table. \begin{table}[htbp] \centering \begin{tabular}{|l|c|c|c|c|c|l|} \hline & \multicolumn{3}{c|}{E} & \multicolumn{3}{c|}{F}\\ \hline & $mv$ & Rel.~err & Time & $mv$ & Rel.~err & Time \\\hline A & 11034 & 1.3e-7 & 3.9 & 15846 & 2.7e-11 & 5.6 \\ B & 21952 & 1.3e-7 & 6.2 & 31516 & 2.7e-11 & 8.8 \\ C & 15883 & 5.2e-8 & 7.1 & 32023 & 1.1e-11 & 1.4 \\ D & 11180 & 8.0e-9 & 4.3 & 17348 & 1.5e-11 & 6.6 \\ \hline \end{tabular} \caption{Without booktabs.} \label{tab:without-booktabs} \end{table} % Second version of table, with booktabs. \begin{table}[htbp] \centering \begin{tabular}{lcccccl}\toprule & \multicolumn{3}{c}{E} & \multicolumn{3}{c}{F} \\\cmidrule(lr){2-4}\cmidrule(lr){5-7} & $mv$ & Rel.~err & Time & $mv$ & Rel.~err & Time\\\midrule A & 11034 & 1.3e-7 & 3.9 & 15846 & 2.7e-11 & 5.6 \\ B & 21952 & 1.3e-7 & 6.2 & 31516 & 2.7e-11 & 8.8 \\ C & 15883 & 5.2e-8 & 7.1 & 32023 & 1.1e-11 & 1.4\\ D & 11180 & 8.0e-9 & 4.3 & 17348 & 1.5e-11 & 6.6 \\\bottomrule \end{tabular} \caption{With booktabs.} \label{tab:with-booktabs} \end{table}
- After chapters, tables, and pictures are defined with \label{...}, they are automatically referenced and jumped through \ref{...}.
- References to subfigures or subtables can be represented using Figure~\ref{fig:figure}(a).
- Caption is used to write "What is this table?".
- The body is used to write "what does this table say".
- use \centering Centered；use\small，\scriptsize，\footnotesize，\tiny Adjust font size
- use\setlength{\tabcolsep}{8pt} Adjust column spacing
- use p{2cm} Fixed column width
- use\multirow，\multicolumn Merge Cells
- Use Adobe illustrator, OmniGraffle and other software to draw and save as vector graphics
- useMatplotlib save after drawing: plt.savefig('draw.pdf')
- Drawing directly with pgfplots in LaTeX
- It is recommended to keep the font size in the picture consistent
25. The font size of the text description in the pictures in the paper should be the same as the text size of the main text
- The font size of the text in the picture should not be too large
- Friendly to black and white printing: Don't use color as the only feature to refer to the lines in the illustration, use solid/dotted lines, light/dark, different line shapes, etc.
- Don't use too many colors, avoid too bright colors
- Use concise diagrams and minimize textual descriptions (except examples)
- The same function module uses a unified format
- Arrows should go in the same direction
- 一In general hyphens, the last一A word is a noun, and together it is an adjective part of speech；
- at last一A word is a verb, and together it is a verb part of speech.
- First, Secondly，both adverbs
- training， test，validation，both nouns
- In line with the habit, try to be consistent with the proposer CNN, LSTM, FEVER, ConceptNet, SQuAD, BiDAF, FEVER score, Wikipedia.
- When it first appears, the full name comes first, followed by the abbreviation; or the abbreviation comes first, followed by the citation for annotation。graph attention network (GAT)，pre-trained language model (PLM)；BERT~\citep{BERT}。
- Domain names, task names, indicators, etc. generally do not need to be capitalized, such as natural language processing, question answering, accuracy, macro-F1 score.
- Especially irregular singular and plural nouns and uncountable nouns.
- Notice：一Countable nouns generally do not appear independently (without an article) in the singular, either by adding the specific or by adding the plural to refer generally.
- replace obvious with straightforward
- Replace always with generally, usually, often
- Use rare instead of never
- Use alleviate, relieve to replace avoid, eliminate
Taking better as an example, that is, when it means that a thing is better, it cannot just be said that it is better, but corresponding explanations and reasons need to be given.
37. Avoid excessive use of pronouns: it, they, etc. Model name abbreviations are not too long and clearer.
Where exactly did the proposed method improve and what led to this result?
39. Say one thing in a word. Use simple sentences as much as possible and avoid long compound sentences.
41. When the number of words in a line does not exceed 1/4, it is recommended to delete or increase the number of words. (Attention)
- Optional: try adding
\looseness=-1at the end of the paragraph, sometimes you can "squeeze" individual words in the last line without deleting the last line.
- Important: Citations use \citep{}, as an interjection; or \citet{}, as the main components of a sentence such as subject, object, etc.
- will appear more formal
- Such as the abbreviation of the conference name, whether to include the time and place of the conference, etc. Whether all the reference formats are consistent
1. You can refer to spell-checking software to check the text for language errors or irregular expressions.
2. Don't use abbreviations like didn't can't don't isn't aren't Don't use an apostrophe for abbreviations at any time. For the possessive, don't use it at all, if you have to express a similar meaning, use the phrase of. For quotation marks, try to avoid them.
3. Use abbreviations (such as model name, definition, etc.), which need to be defined in the most initial position used.
4. The case of the model name should be consistent, such as BERT, ELECTRA, and avoid mixed use of Bert, Electra, and electra.
7. Changing \begin\item to a normal paragraph can make the page more compact (and then manually add a black dot $\bullet$ before each paragraph), wasting too much space may be suspected of watering
9. The capitalization style of the title at all levels of the article is consistent, such as the capitalization of the first letter of a phrase or the first letter of a word
10. Use babel to achieve the effect of word breaking by phonetic syllables (hyphenation patterns), ie \usepackage[english]{babel}
14. The colors of the same type of modules should be kept in the same color system as much as possible, and each type of unit should be filled with the same color or used as a border。
15. In the same color system, if a module is darker and brighter, it means that this module is more important. If you don't want to express more important and more core, please maintain a balanced color distribution between each module, for example, the gray value should be as consistent as possible.
18. The original intention of figure is to provide a more intuitive, clearer and more concise expression than text. Reasonable drawing elements should be used as much as possible, rather than a large number of text marks. Figure elements, specifications are done with the smallest set, the most uniform, consistent settings, generally not ugly。
19. Details to line type and color matching: first, keep it uniform (low descriptive complexity), second, with a meaning, category of graphic elements should be similar, the same line shape, color matching (cognitive intuition)。
20. The directions of the arrows should be kept in the same direction as much as possible to avoid turning back and forth. Avoid isolated components (without any source or destination arrows) in flowcharts.
-
Quoted out of text（parent），use \cite。
-
quoted in text（within text）
- ACL/NAACL/EMNLP Template use \citet{...}；
- COLING templates use \newcite{...};
- AAAI/IJCAI templates use \citeauthor{...} \shortcite{...};
- IEEE template: \citeauthor{...}~(\citeyear{...})
Effect：(Zhang et al. 2020) vs. Zhang et al. (2020)
- tool for reference SimBiber
23. Bib management pays attention to keeping the full name and abbreviation of the conference/journal name consistent, checking the year, volume number, page number, etc., and do not rely solely on the information provided by scholar (there may be missing or confusing formats).
- tool for reference Rebiber
24. After chapters, tables, and pictures are defined with \label, they can be automatically referenced and jumped through \ref.
26. Do not repeatedly cite different versions of the same paper, such as arXiv and formal conference papers.
27. A formula is part of a sentence. So commas and periods can be added inside formulas (especially on multiple lines).
28. For the text after the formula, if it forms a complete sentence with the formula, the first letter does not need to be capitalized, and it is immediately after the formula; if a new sentence or paragraph is started, a new line should be added after the end character \end of the formula, and the first letter of the sentence should be added. Capitalize letters to start a new sentence.
30. Check for overpage (at the last moment, be careful not to arbitrarily change the size of the chart)
31. Check that the title and abstract correspond to the information in the input box of the submission system。
32. Check the submitted data and code. It cannot contain personal and institutional information. In particular, some hard coded models or data paths in the code need to be disposed of. In addition, you need to pay attention to hidden folders (such as .git）
33. Overleaf may be slow to access before some conference submissions, please pay attention to LaTex backup
34. The historical version of the paper can be numbered with time to avoid submitting a non-final version
35. It is best to submit a version of the paper and appendices one day before the deadline to prevent the server from crashing when the manuscript is due.
36. After submitting the manuscript, you still need to pay attention to the conference official website and registered mailbox, and receive the news of the possible extension of the conference deadline in time.
● 清华大学刘洋老师的CWMT-2014报告：机器翻译学术论⽂文写作⽅方法和技巧
● 复旦大学邱锡鹏老师的CCL-2018报告：如何端到端地写科研论文？
● 中国人民大学赵鑫老师：如何以初学者的身份写好一篇国际学术论文
● 香港中文大学（深圳）陈冠英老师整理的写作建议 || & Rebuttal Template
● 哥伦比亚大学 Henning Schulzrinne 老师：Tips and Resources for Writing Computer Science Papers
● 哈佛大学 Whitesides 老师：从写提纲的角度切入讲解如何撰写学术论文
● 卡耐基梅隆大学 Graham Neubig 老师：How to Read/Write an International Conference Paper & Paper style guide
● MSR研究员Simon Peyton Jones老师：How to Write a Great Research Paper
● 支付宝研究员王益老师：“学好语文，才能写好代码”（很多观点对写论文同样适用）
● 哈尔滨工业大学刘一佳博士的NLPCC-2018报告：论文写作的易读性原则
● 夕小瑶的卖萌屋：11 个好用的科研工具推荐！工作效率提升 max！
● 夕小瑶的卖萌屋：吐血整理：论文写作中注意这些细节，能显著提升成稿质量
● Deepmind Chris Dyer 等老师：关于NLP论文中公式的建议
● Google Brain的Bo Chang老师的LaTeX Tips
● acl-org/aclpubcheck: Tools for checking ACL paper submissions
● dspinellis/latex-advice: Advice for writing LaTeX documents
● Graham Neubig：How to Read/Write an International Conference Paper
● Karl Whelan：Writing Tips for PhD Theses
● Karl Whelan：Tips for Preparing and Publishing Research Papers
感谢以下同学对本项目进行组织与指导
感谢以下同学对本项目的支持与贡献
