From 34445570b21f9630ab271df75b44634b255c58d2 Mon Sep 17 00:00:00 2001 From: Roman Donchenko Date: Tue, 11 Feb 2025 14:31:50 +0200 Subject: [PATCH] Mention the utility modules in the SDK description --- cvat-sdk/README.md | 4 +++- site/content/en/docs/api_sdk/sdk/_index.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/cvat-sdk/README.md b/cvat-sdk/README.md index 89702c02abd4..92ec8d356b4a 100644 --- a/cvat-sdk/README.md +++ b/cvat-sdk/README.md @@ -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). diff --git a/site/content/en/docs/api_sdk/sdk/_index.md b/site/content/en/docs/api_sdk/sdk/_index.md index e855dadd979f..b3d8248a8974 100644 --- a/site/content/en/docs/api_sdk/sdk/_index.md +++ b/site/content/en/docs/api_sdk/sdk/_index.md @@ -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.