Submission Process

31 Dec 2017

Overview

Our goal for ML4MX is to increase the transparency and to improve the reproducibility and openness of any project of Machine Learning for Mexico. With this in mind, ML4MX has adopted the submission process for blog entries and projects of the peer-reviewed journal ReScience.

Submitted entries are first considered by any of the members of the editorial board, who may decide to reject the submission (mainly because it has already been replicated and is publicly available), or assign it to two reviewers for further review and tests. The reviewers evaluate the code and the accompanying material in continuous interaction with the authors through the Pull Request discussion section. If both reviewers managed to run the code and obtain the same results as the ones advertised in the accompanying material, the submission is accepted. If any of the two reviewers cannot replicate the results before the deadline, the submission is rejected and authors are encouraged to resubmit an improved version later.

Criteria for Publication

To be considered for publication in ML4MX, any given submission must satisfy the following criteria: * Replicability
* Rigorous methodology
* Original source code
* Substantial evidence for replication of the original results

Open Access

ML4MX applies the Creative Commons Attribution (CC BY) license to all works we publish. Under the CC BY license, authors retain ownership of the copyright for their article, but authors allow anyone to download, reuse, reprint, modify, distribute, and/or copy articles in ML4MX, so long as the original authors and source are cited. No permission is required from the authors or the publishers.

How to submit?

Create a github account
Fork the blogpost submission repository

Clone this new repository into your desktop environment

$ git clone https://github.com/YOUR-USERNAME/blogpost-submission

Create a branch (the branch name should be author names separated with dashes)
```
$ git checkout -b AUTHOR1-AUTHOR2-...-AUTHORN-YEAR
```
Add your code & article (see author guidelines) and commit your changes:
```
$ git commit -a -m "Some comment"
```

Push to github

$ git push origin AUTHOR1-AUTHOR2-...-AUTHORN-YEAR

Issue a pull request (PR) to blogpost-submission (click on compare and pull request) and then add the title containing author(s) name and follow the template that will appear once you opened the pull request:

  **AUTHOR**

  Dear Editors,

  I request a review for the following blog post:

  ### Original article

  **Title:**  
  **Author(s):**  
  **Keywords**:  
  **Repository**:  

  ### Potential reviewers
  <!-- If you know potential reviewers, you can tell us here -->
  <!-- You can look at http://rescience.github.io/board for the -->
  <!-- list of registered reviewers (but you can propose others) -->

  ---

  **EDITOR**

  * [ ] Editor acknowledgement ( [@githubusername](https://github.com/username) )
  * [ ] Reviewer 1 ([@githubusername](https://github.com/username) )
  * [ ] Reviewer 2 ([@githubusername](https://github.com/username) )
  * [ ] Review 1 decision [accept/reject]
  * [ ] Review 2 decision [accept/reject]
  * [ ] Editor decision [accept/reject]

You can suggest reviewers from editorial board.
Answer questions and requests made in the Pull Request conversation page.

You can have a look at previous submissions at ReScience-submission

Preparation of the material

The structure of a submission is:

+ README.md
+ article
|  | author(s)-YEAR.md
|  | author(s)-YEAR.bib
|  | LICENSE.md (CC-BY 4.0)
|  | ...
|  + ...
+ code
|  | README.md
   | LICENSE.md (to be chosen)
|  | ...
|  + ...
+ data
|  | README.md
|  | LICENSE.md (CC 0)
|  | ...
|  + ...
+ notebook
   | README.md
   | LICENSE.md (to be chosen)
   |
   + ...

A top README.md file that will be displayed when a reader enters your submission directory (once published)
An author(s)-YEAR.md file that introduces the original paper, explains the technical details of the replication and gives the evidence for the replication of the original results.
A code directory that contains the commented code for the replication.
A data directory that contains any data necessary to run the code.
A notebook directory that may contain notebooks if relevant.
Don’t forget to choose a license for the code repository. You’re free to choose whatever open license you prefer (see the Debian Free Software Guidelines) but you need to choose one.
In the code/README.md and notebook/README.md files, include information on the platform that was used to generate the results according to our platform instructions.

Rerences

[1] ReScience: Overview of the submission process