Merge pull request #938 from roboflow/sdk-reference-docs

docstrings for SDK reference docs

Author: hansent

.gitignore

@@ -167,6 +167,7 @@ scratch
 docs/workflows/blocks/*
 docs/workflows/kinds/*
 docs/workflows/gallery/*
+docs/reference/*
 docs/inference_helpers/cli_commands/reference.md
 docs/openapi.json
 !tests/workflows/integration_tests/execution/assets/*.jpg

inference_sdk/__init__.py

@@ -9,6 +9,9 @@
 )
 from inference_sdk.utils.environment import str2bool
 
+# Environment variable to control whether SDK warnings are disabled.
+# Set to "true" to disable all SDK-specific warnings, "false" to enable them.
+# Default is "false" (warnings enabled).
 INFERENCE_WARNINGS_DISABLED = str2bool(
     os.getenv("INFERENCE_WARNINGS_DISABLED", "False")
 )

inference_sdk/config.py

@@ -1,2 +1,4 @@
 class InferenceSDKDeprecationWarning(Warning):
+    """Class used for warning of deprecated features in the Inference SDK"""
+
     pass

inference_sdk/http/__init__.py

@@ -0,0 +1,13 @@
+"""Inference SDK HTTP module.
+
+This module provides HTTP-based functionality for the Inference SDK, including utilities
+for making HTTP requests, handling responses, and processing images. It contains tools
+for loading and preprocessing images, building requests, and managing API interactions.
+
+The module includes utilities for:
+- Loading images from files, URLs and base64 strings
+- Resizing and preprocessing images while maintaining aspect ratio
+- Building and formatting HTTP requests with proper headers and payloads
+- Handling API responses and errors safely
+- Profiling workflow execution
+"""