Skip to content

[LABIMP-6971] Annotation_guide is now conditionally required based on annotation_template_id presence. #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 11, 2025
Merged

[LABIMP-6971] Annotation_guide is now conditionally required based on annotation_template_id presence. #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e74d07
[LABIMP-6971] Annotation_guide is now conditionally required based on…
TheLunarLogic Jul 10, 2025
95e6099
[LABIMP-6971] Update error message for missing annotation_guide to cl…
TheLunarLogic Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions labellerr/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1037,21 +1037,22 @@ def initiate_create_project(self, payload):
try:
result = {}
# validate all the parameters
required_params = ['client_id', 'dataset_name', 'dataset_description', 'data_type', 'created_by', 'project_name','annotation_guide','autolabel']
required_params = ['client_id', 'dataset_name', 'dataset_description', 'data_type', 'created_by', 'project_name','autolabel']
for param in required_params:
if param not in payload:
raise LabellerrError(f"Required parameter {param} is missing")


if param == 'client_id' and not isinstance(payload[param], str):
raise LabellerrError("client_id must be a non-empty string")

if param == 'annotation_guide':
for guide in payload['annotation_guide']:
if 'option_type' not in guide:
raise LabellerrError("option_type is required in annotation_guide")
if guide['option_type'] not in OPTION_TYPE_LIST:
raise LabellerrError(f"option_type must be one of {OPTION_TYPE_LIST}")

# annotation_guide is only required if annotation_template_id is not provided
if not payload.get('annotation_template_id'):
if 'annotation_guide' not in payload:
raise LabellerrError("Please provide either annotation guide or annotation template id")
for guide in payload['annotation_guide']:
if 'option_type' not in guide:
raise LabellerrError("option_type is required in annotation_guide")
if guide['option_type'] not in OPTION_TYPE_LIST:
raise LabellerrError(f"option_type must be one of {OPTION_TYPE_LIST}")


if 'folder_to_upload' in payload and 'files_to_upload' in payload:
Expand Down Expand Up @@ -1115,15 +1116,17 @@ def dataset_ready():

print("Dataset created and ready for use")


annotation_template_id = self.create_annotation_guideline(
payload['client_id'],
payload['annotation_guide'],
payload['project_name'],
payload['data_type']
)
print("Annotation guidelines created")

# Use annotation_template_id from payload if provided, else create a new one
if 'annotation_template_id' in payload and payload['annotation_template_id']:
annotation_template_id = payload['annotation_template_id']
else:
annotation_template_id = self.create_annotation_guideline(
payload['client_id'],
payload['annotation_guide'],
payload['project_name'],
payload['data_type']
)
print("Annotation guidelines created")

project_response = self.create_project(
project_name=payload['project_name'],
Expand Down