roboflow / roboflow-python

The official Roboflow Python package. Manage your datasets, models, and deployments. Roboflow has everything you need to build a computer vision application.
https://docs.roboflow.com/python
Apache License 2.0
280 stars 72 forks source link

Clarified `annotations_path`, `split params` in `project.upload`. #234

Closed LinasKo closed 6 months ago

LinasKo commented 6 months ago

Description

This seems like a miniscule change, but it it would have saved me 2 hours today.

It took time to create a COCO annotations file, only to find that:

List any dependencies that are required for this change.

None

Please delete options that are not relevant.

This only changes the docstring.

How has this change been tested, please provide a testcase or example of how you tested the change?

N/A

Any specific deployment considerations

~~I got mkdocs serve running, but could not locate any Project docstring renderings. If that is displayed somewhere, it should be checked that parameters of Project are displayed correctly.~~

I think it's fine.

image

Docs

Clarified a special case of annotations_path, explained it more thoroughly, and clarified the explanation for split.