Skip to content

Commit 33ae3b0

Browse files
authored
Merge pull request #234 from LinasKo/docs/project-upload-docstring
Clarified `annotations_path`, `split params` in `project.upload`.
2 parents 6eec988 + 8333b81 commit 33ae3b0

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

roboflow/core/project.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,10 +372,11 @@ def upload(
372372
373373
Args:
374374
image_path (str): path to image you'd like to upload
375-
annotation_path (str): if you're upload annotation, path to it
375+
annotation_path (str): path to the annotation file. If not provided, the image will be uploaded without annotation.
376+
Special case: in classification projects, this can instead be a class name. e.g. "dog".
376377
hosted_image (bool): whether the image is hosted
377378
image_id (str): id of the image
378-
split (str): to upload the image to
379+
split (str): which split to upload to - "train", "valid" or "test"
379380
num_retry_uploads (int): how many times to retry upload on failure
380381
batch_name (str): name of batch to upload to within project
381382
tag_names (list[str]): tags to be applied to an image

0 commit comments

Comments
 (0)