- Write you review.
-
Go into
_summaries/and find your assigned summary in the format of${paper_tag}_{1/2}.md. -
Replace
paperandauthorwith your assigned one and your github id. -
Write up the contents.
-
Use math:
You can use $$\mathrm{math}$$ using $$\LaTeX$$ (inline). $$ 1+2 \textrm{ in Display mode} $$Make sure to place a blank line above and below.
-
Insert figure:
You can add figure by using the following code snippet: Make sure to name your figure properly,
${paper_tage}_{1/2}{a/b/c/...}.{jpg/png}might be a good idea. -
You can also check out the two examplar summaries (
_summaries/he2015deep_1.mdand_summaries/lecun1998gradient_1.md) for proper formatting and naming.
-
- (Optional) Preview your review locally.
-
Install Jekyll
-
Run
jekyll buildandjekyll serve. You can see how your review (${paper_tag}_{1/2}.html) looks like locally.Only minimal template is provided in this repo so it'll look a bit different from the class page.
- Commit your review.
- Create your own branch and create a PR to the main branch. Name your branch
paper_tag+your github id.
- Assign your reviewer.
- Navigate to your PR page, and there is a "reviewer" section where you can search and type the reviewer's name.
Check the following things:
-
{{paper_tag}}is replaced to the real one (e.g.he2015deep). -
The writer writes down the score.
Leave constructive comments under the PR, possibly @ the author to remind them. The writing-review processing can be iterated for multiple cycles.
The criteria includes the following:
- Completeness: Is everything summarized in the summary?
- Length: How compact/verbose is the summary?
- Orginaity: Is the summary in the writer's own words?
- Structure: Is the summary easy to follow?
- adequate context or motivation
- clear and well-defined formula
- illustrative figure if necessary