Invitations

Invitations

An OpenReview Invitation represents a template for a potential Note to be added to the system, and defines constraints that the Note must adhere to. Notes are the most complex of the OpenReview Object Types.

A good analogy for an Invitation is a "call for papers": for example, a Conference might create an Invitation that specifies that the Note representing a submission must contain a title, an abstract, a list of authors, a list of keywords, etc.

Invitations have a special field reply that defines the constraints on Notes that respond to the Invitation. The structure of this reply field directly affects the way that the Invitation is rendered in the OpenReview web interface. Rules for how this field affects the web interface are described below.

A simplified example for illustrative purposes:

{
  'id': 'ICLR.cc/2018/Conference/-/Submission',
  'readers': [ 'everyone' ],
  'writers': [ 'ICLR.cc/2018/Conference' ],
  'signatures': [ 'ICLR.cc/2018/Conference' ],
  'invitees': [ '~' ],
  'duedate': 1509139800000,
  'process': 'function() { ... }',
  'nonreaders': [],
  'noninvitees': [],
  'reply': {
    'forum': null,
    'replyto': null,
    'writers': {
      'values': [
        'ICLR.cc/2018/Conference'
      ]
    },
    'signatures': {
      'description': 'Your authorized identity to be associated with the above content.',
      'values': ['(anonymous)']
    },
    'readers': {
      'description': 'The users who will be allowed to read the above content.',
      'values': ['everyone']
    },
    'content': {
      'title': {
        'description': 'Title of paper.',
        'value-regex': '.{1,250}'
      },
      'abstract': {
        'description': 'Abstract of paper.',
        'value-regex': '[\\S\\s]{1,5000}'
      },
      'authors': {
        'description': 'Comma separated list of author names. Please provide real names; identities will be anonymized.',
        'values-regex': '[^;,\\n]+(,[^,\\n]+)*'
      }
    }
  }
}

Invitation Fields

invitees

A list of Group IDs that have permission to post Notes under this Invitation. Notes posted under this Invitation must have the Invitation's ID in the Note's invitation field. See Notes for more details.

duedate

The due date for this Invitation, represented in millisecond Unix time (number of milliseconds since 00:00:00 Coordinated Universal Time, Thursday, 1 January 1970). This due date is not enforced, and does not prevent a user from submitting a Note to this Invitation: it simply provides a reference point for administrators. duedate is also used by the web interface when the Invitation is rendered.

process

Details coming soon. Please contact us at info@openreview.net with questions.

reply

A dictionary representing constraints on the Notes that are submitted under this Invitation.

Reply Fields

The reply field of the Invitation has a special set of rules that are more complex than most other OpenReview Object fields. This field will directly control the way that the Invitation is rendered in the web interface. In the example above, the reply field has been simplified. Below is an example of a reply field with a more realistic configuration:

'reply': {
    'forum': null,
    'replyto': null,
    'writers': {
      'values': [
        'ICLR.cc/2018/Conference'
      ]
    },
    'signatures': {
      'values-regex': '~.*',
      'description': 'Your authorized identity to be associated with the above content.'
    },
    'readers': {
      'description': 'The users who will be allowed to read the above content.',
      'values-copied': [
        'ICLR.cc/2018/Conference',
        'ICLR.cc/2018/Conference/Program_Chairs',
        '{content.authorids}',
        '{signatures}'
      ]
    },
    'content': {
      'pdf': {
        'required': true,
        'order': 9,
        'value-regex': 'upload',
        'description': 'Upload a PDF file that ends with .pdf'
      },
      'title': {
        'required': true,
        'order': 1,
        'description': 'Title of paper.',
        'value-regex': '.{1,250}'
      },
      'abstract': {
        'required': true,
        'order': 8,
        'description': 'Abstract of paper.',
        'value-regex': '[\\S\\s]{1,5000}'
      },
      'authors': {
        'required': true,
        'order': 2,
        'values-regex': '[^;,\\n]+(,[^,\\n]+)*',
        'description': 'Comma separated list of author names. Please provide real names; identities will be anonymized.'
      },
      'keywords': {
        'order': 6,
        'values-regex': '(^$)|[^;,\\n]+(,[^,\\n]+)*',
        'description': 'Comma separated list of keywords.'
      },
      'TL;DR': {
        'required': false,
        'order': 7,
        'description': '\'Too Long; Didn't Read\': a short sentence describing your paper',
        'value-regex': '[^\n]{0,500}'
      },
      'authorids': {
        'required': true,
        'order': 3,
        'values-regex': '([a-z0-9_\\-\\.]{2,}@[a-z0-9_\\-\\.]{2,}\\.[a-z]{2,},){0,}([a-z0-9_\\-\\.]{2,}@[a-z0-9_\\-\\.]{2,}\\.[a-z]{2,})',
        'description': 'Comma separated list of author email addresses, lowercased, in the same order as above. For authors with existing OpenReview accounts, please make sure that the provided email address(es) match those listed in the author's profile. Please provide real emails; identities will be anonymized.'
      }
    }
  }