---
layout: page
title: Submission Process
permalink: /submission-process
description:
nav: true
nav_order: 3
---


<img src="{{ 'assets/img/TMLR_Beyond_PDF_Logo.png' | relative_url }}" width="400px" style="display:block; margin: auto;">


## TMLR Beyond PDF Submission Guidelines

### Contents

- [Quickstart](#quickstart)
- [Creating a TMLR Beyond PDF Submission](#creating-a-tmlr-beyond-pdf-submission)
- [Testing Your Submission Locally](#local-serving)
- [Submitting to TMLR on OpenReview](#submitting-to-tmlr-beyond-pdf)
- [Camera-Ready Instructions](camera-ready-instructions)


### Quickstart

This section provides a summary of the workflow for creating a submission for TMLR Beyond PDF.

1. **Get the TMLR Beyond PDF Author Kit:** Download the [TMLR Beyond PDF Author Kit](https://drive.google.com/file/d/1KZyzuK_00IIULYabMd0ePfurgWnEVCmK/view?usp=drive_link). The Author Kit contains a `submission_folder` that you must modify when creating your submission (described in more detail below). It also contains a script called `compile_submission.py` that you can use to build your submission website locally for development. To run `compile_submission.py`, you must have Docker installed.

2. **Add Content to your Submission:** Create your submission as detailed in the [Creating a TMLR Beyond PDF Submission](#creating-a-tmlr-beyond-pdf-submission) section. The high-level steps are:
    - Update the submission file `submission.md` with your main submission content.
    - Add any static images for your submission to `assets/img/submission/`.
    - Add any interactive HTML figures to `assets/html/submission/`. 
    - Update the bibtex file with your citations in `assets/bibliography/submission.bib`. This bibliography is formatted just like a standard LaTeX bibliography.

3. **Rendering the Submission Locally:** To render your website locally, you must first have Docker installed. Then, you can run `python compile_submission.py`, which will build your website and start a server so that you can view the resulting page locally at http://0.0.0.0:8080/tmlr-beyond-pdf-static/.

4. **Submitting on OpenReview:** Once you are happy with your submission and have tested it locally, please zip the `submission_folder` using the command `zip -r submission_folder.zip submission_folder`. Then, create a submission as usual on [OpenReview](https://openreview.net/group?id=TMLR), adding `submission_folder.zip` as the supplementary material. Please check the box that asks "Is this a TMLR Beyond PDF submission?" to indicate the type of submission, which will allow you to omit the PDF (that is otherwise a required field). Once you submit to OpenReview, the system will automatically pull the supplementary material from your submission and add it to the [TMLR Beyond PDF website](https://www.paulvicol.com/tmlr-beyond-dev/under_review/). The reviewing process will take place on OpenReview as usual, with reviewers referencing your compiled page on the TMLR Beyond PDF website.


### Creating a TMLR Beyond PDF Submission

The directory structure of the `submission_folder` in the [TMLR Beyond PDF Author Kit](https://drive.google.com/file/d/1KZyzuK_00IIULYabMd0ePfurgWnEVCmK/view?usp=drive_link) is as follows:

```bash
submission_folder/
├── submission.md                  # <--- Update this markdown file with your submission content
└── assets
    ├── img
    │   └── submission             # <--- Add your static images here
    │       └── YOUR IMAGES
    ├── html
    │   └── submission             # <--- Add your interactive html figures here
    │       └── YOUR HTML FIGURES
    └── bibliography               # <--- Add references to this bibtex file
        └── submission.bib
```

To create your submission, you need to:

* Update the Markdown file `submission.md` with your main submission content.
* Add any static image assets will be added to `assets/img/submission/`.
* Add dynamic HTML content (that can include Javascript for animations, etc.) to `assets/html/submission/`.
* Add your bibliography to `assets/bibliography/submission.bib`.


The main content of your submission will be written in the Markdown file `submission_folder/submission.md`. The header of the file looks like this:

```markdown
---
layout: distill
title: [Your Submission Title]
description: [Your Abstract]
htmlwidgets: true

# Anonymize when submitting 
authors:
  - name: Anonymous

# Do not change this name, just use "submission.bib".
bibliography: submission.bib

# Optionally, add a table of contents to your submission.
#   - make sure that TOC names match the actual section names
#     for hyperlinks within the submission to work correctly.
toc:
  - name: [Section 1]
  - name: [Section 2]
  # You can additionally add subentries like so:
    subsections:
    - name: [Subsection 2.1]
  - name: [Section 3]
---

# ... The content of your TMLR Beyond PDF submission. ...
```

You need to update the `title`, `discription` and optionally `toc` fields.
**Do not fill in the `authors` field, your submission must be anonymous for the review process.**

Check out the [example submission]() to see how you can add images and interactive figures, and how to write math using $$\LaTeX$$.


### Testing Your TMLR Beyond PDF Submission Locally

You can render your Beyond PDF submission locally to ensure that it looks good before submitting:

1. Make sure you have [Docker](https://www.docker.com/) installed.
2. To test your submission locally, run `python compile_submission.py`. You should then be able to see your submission locally by going to http://0.0.0.0:8080/tmlr-beyond-pdf-static/under_review/index.html


### Submitting to TMLR Beyond PDF

1. Zip the updated `submission_folder` containing your content, using the command `zip -r submission_folder.zip submission_folder`.

2. Then, create a new TMLR submission on [OpenReview](https://openreview.net/group?id=TMLR), and upload `submission_folder.zip` as the supplementary material. Within a few minutes, your submission will be automatically added to the [Under Review page of the TMLR Beyond PDF website](https://www.paulvicol.com/tmlr-beyond-pdf-static/under_review/index.html).

It will be created with the following format: 
```
https://www.paulvicol.com/tmlr-beyond-pdf-static/submission-process
```


### Camera-Ready Instructions 

The main change that must be made for the camera-ready version is to de-anonymize the paper by filling in the authors and affiliations in the `submission.md` header:

```markdown
---
layout: distill
title: [Your Submission Title]
description: [Your Abstract]
htmlwidgets: true

# Fill in the authors and affiations only when creating the camera-ready version!
# authors:
#   - name: Albert Einstein
#     url: "https://en.wikipedia.org/wiki/Albert_Einstein"
#     affiliations:
#       name: IAS, Princeton
#   - name: Boris Podolsky
#     url: "https://en.wikipedia.org/wiki/Boris_Podolsky"
#     affiliations:
#       name: IAS, Princeton

# Do not change this name, just use "submission.bib".
bibliography: submission.bib

# Optionally, add a table of contents to your submission.
#   - make sure that TOC names match the actual section names
#     for hyperlinks within the submission to work correctly.
toc:
  - name: [Section 1]
  - name: [Section 2]
  # you can additionally add subentries like so
    subsections:
    - name: [Subsection 2.1]
  - name: [Section 3]
---

# ... The content of your TMLR Beyond PDF submission. ...
```

You can test the camera-ready version in the same way as before, using `python compile_submission.py` to start a local server and double-check the submission at http://0.0.0.0:8080/tmlr-beyond-pdf-static/.

To submit the camera-ready version, follow the same steps as before, zipping the submission folder using `zip -r submission_folder.zip submission_folder` and uploading `submission_folder.zip` as the supplementary material on OpenReview.

Your camera-ready submission should then appear in the [Accepted Papers section of the TMLR Beyond PDF website](https://www.paulvicol.com/tmlr-beyond-pdf-static/accepted/index.html).

