Exercise: Understanding Notes

Objectives

Learn to use the OpenReview API to:

1. Post new notes

2. Retrieve a specific note

3. Fetch all submissions for a given venue

4. Edit a submission (readers and content)

5. Delete a note

Use the OpenReview documentation and linked guides as your primary reference. Ensure that you have instantiated the API client in a variable client before beginning.

1. Post New Test Submissions

Task: Create and post at least two submissions to a venue of your choice.

Hints:

• See How to create, change, and delete notes — Posting a submission with Python.

Check your work: Open the PC Console for your venue. Your new submissions should appear under the Submission Status tab.

2. Get a Single Note

Task: Fetch and inspect one of the submissions you just posted by its note id.

Hints:

• Read Introduction to Notes.

• Look up get_note(id) in the API reference.

Check your work: Run the following code, the output should match the note ID you requested.

print(note.id)

3. Get All Submissions for a Venue

Task: Retrieve all submissions for your chosen venue.

Hints:

• See How to get all notes for submissions, reviews, rebuttals, etc..

Check your work: Run the following code, the output should match the number of submissions in your venue.

print(len(submissions))

4a. Edit a Submission - Title

Task: Choose one of your submissions and edit the title Hints:

• Same guide: How to create, change, and delete notes — Update the content of a note.

Check your work: Check the submission page on the OpenReview site. The submission should show the new title. When you click 'Show Revisions', you should see the old title in the original edit, and the current title in a more recent edit.

4b. Edit a Submission - Readers

Task: Choose one of your submissions and change the readers to ['everyone'], then change it back to its original settings Hints:

• Same guide: How to create, change, and delete notes — Update the readers of a note

Check your work: Check the submission page on the OpenReview site. There should be a property just under the title of the submission with the readers of the note listed.

4c. Edit a Submission - Field Readers

Task: Choose one of your submissions and edit the readers of the author_ids field Hints:

• Same guide: How to create, change, and delete notes — Update the field readers of a note

Check your work: Check the submission page on the OpenReview site. There should be an eye icon next to the edited field saying who the readers of the field are

5. Delete a Note

Task: Remove one of your test submissions from the system.

Hints:

• Same guide: How to create, change, and delete notes — Delete a note.

Check your work: Run the following code, the output should indicate the note does not exist

client.get_note("<NOTE_ID>")