Skip to content
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.

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

Add documentation for auto-annnotation in SDK/CLI #6611

Merged
merged 3 commits into from
Aug 8, 2023

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Aug 3, 2023

Motivation and context

Documentation for #6483.

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • [ ] I have added a description of my changes into the CHANGELOG file
  • I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • [ ] I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@SpecLad SpecLad requested a review from zhiltsov-max August 3, 2023 13:03
@SpecLad SpecLad requested a review from mdacoca as a code owner August 3, 2023 13:03
@SpecLad SpecLad force-pushed the csl-documentation branch from b6f6b67 to 3ef5be4 Compare August 3, 2023 13:09
Comment on lines +241 to +250
For example:

```python
import cvat_sdk.auto_annotation as cvataa

spec = cvataa.DetectionFunctionSpec(...)

def detect(context, image):
...
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably, it will be better to add a direct link to the full example from the SDK page and a specific command to use YOLO v8 example.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably, it will be better to add a direct link to the full example from the SDK page

That example can't be used with the CLI, because it implements the function as a class rather than as a module.

and a specific command to use YOLO v8 example.

I did list such a command. It's directly below this code block...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did list such a command. It's directly below this code block...

Sorry, I missed that.

@SpecLad SpecLad merged commit c68cb07 into cvat-ai:develop Aug 8, 2023
@SpecLad SpecLad deleted the csl-documentation branch August 8, 2023 09:29
mikhail-treskin pushed a commit to retailnext/cvat that referenced this pull request Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants