Skip to content

Commit

Permalink
Mention the utility modules in the SDK description
Browse files Browse the repository at this point in the history
  • Loading branch information
SpecLad committed Feb 11, 2025
1 parent e644188 commit d4f7e2b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion cvat-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ The SDK API includes several layers:
- Server API wrappers (`ApiClient`). Located in at `cvat_sdk.api_client`.
- High-level tools (`Core`). Located at `cvat_sdk.core`.
- PyTorch adapter. Located at `cvat_sdk.pytorch`.
* Auto-annotation support. Located at `cvat_sdk.auto_annotation`.
- Auto-annotation support. Located at `cvat_sdk.auto_annotation`.
- Miscellaneous utilities, grouped by topic.
Located at `cvat_sdk.attributes` and `cvat_sdk.masks`.

Package documentation is available [here](https://docs.cvat.ai/docs/api_sdk/sdk).

Expand Down
4 changes: 3 additions & 1 deletion site/content/en/docs/api_sdk/sdk/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ SDK API includes several layers:
{{< ilink "/docs/api_sdk/sdk/highlevel-api" "Read more" >}}
- PyTorch adapter. Located at `cvat_sdk.pytorch`.
{{< ilink "/docs/api_sdk/sdk/pytorch-adapter" "Read more" >}}
- Auto-annotation API. Located at `cvat_sdk.auto_annotation.`
- Auto-annotation API. Located at `cvat_sdk.auto_annotation`.
{{< ilink "/docs/api_sdk/sdk/auto-annotation" "Read more" >}}
- Miscellaneous utilities, grouped by topic.
Located at `cvat_sdk.attributes` and `cvat_sdk.masks`.

In general, the low-level API provides single-request operations, while the high-level one
implements composite, multi-request operations, and provides local proxies for server objects.
Expand Down

0 comments on commit d4f7e2b

Please sign in to comment.