diff --git a/docs/source/api.rst b/docs/source/api.rst index b9251f3e0a..553d6f9f9a 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -51,3 +51,12 @@ Tools .. automodule:: openreview.tools :members: + + +Venue +----- + +.. automodule:: openreview.venue.venue + :members: + :undoc-members: + diff --git a/openreview/conference/builder.py b/openreview/conference/builder.py index ee9c4524c6..374b3f53cd 100644 --- a/openreview/conference/builder.py +++ b/openreview/conference/builder.py @@ -1840,7 +1840,6 @@ def expire_recruitment_invitations(self): self.expire_invitation(recruitment_invitation.id) class ConferenceBuilder(object): - def __init__(self, client, support_user=None): self.client = client self.client_v2 = openreview.api.OpenReviewClient(baseurl=openreview.tools.get_base_urls(client)[1], token=client.token) diff --git a/openreview/venue/venue.py b/openreview/venue/venue.py index f04e34efaa..830848a7fa 100644 --- a/openreview/venue/venue.py +++ b/openreview/venue/venue.py @@ -21,7 +21,23 @@ from . import matching class Venue(object): - + """ + Represents an OpenReview venue (e.g., a conference or workshop). + + The Venue class is the primary interface for interacting with + conference workflows in OpenReview. It replaces the deprecated + ConferenceBuilder and should be used for managing submissions, + assignments, and reviewer workflows. + + Typical use cases include: + - Accessing submissions for a conference + - Managing reviewer and area chair assignments + - Interacting with venue-specific invitations and groups + + Example: + venue = client.get_venue('ICLR.cc/2025/Conference') + submissions = venue.get_submissions() + """ def __init__(self, client, venue_id, support_user): self.client = client