diff --git a/src/yandex_cloud_ml_sdk/_auth.py b/src/yandex_cloud_ml_sdk/_auth.py index 78f2a4c8..f1359540 100644 --- a/src/yandex_cloud_ml_sdk/_auth.py +++ b/src/yandex_cloud_ml_sdk/_auth.py @@ -77,7 +77,7 @@ async def applicable_from_env(cls, **_: Any) -> None: class APIKeyAuth(BaseAuth): """Authentication method using an API key. - Read more about the API key in `the documentation _`. + Read more about the API key in `the documentation `_. """ env_var = 'YC_API_KEY' @@ -122,7 +122,7 @@ async def get_auth_metadata(self, client: AsyncCloudClient, timeout: float, lock class IAMTokenAuth(BaseIAMTokenAuth): """Authentication method using an IAM token. - Read more about the IAM token in `the documentation _`. + Read more about the IAM token in `the documentation `_. """ env_var = 'YC_IAM_TOKEN' @@ -221,7 +221,7 @@ class OAuthTokenAuth(RefresheableIAMTokenAuth): This class extends the RefresheableIAMTokenAuth to provide functionality for managing and using an OAuth token for authentication purposes. - Read more about the OAuth token in `the documentation _`. + Read more about the OAuth token in `the documentation `_. """ env_var = 'YC_OAUTH_TOKEN' @@ -265,7 +265,7 @@ class YandexCloudCLIAuth(RefresheableIAMTokenAuth): via the Yandex Cloud CLI that should be installed and configured. Yandex Cloud CLI is a downloadable software for managing cloud resources via the command line. - Read more in `the CLI documentation _`. + Read more in `the CLI documentation `_. """ env_var = 'YC_PROFILE' @@ -348,7 +348,7 @@ class MetadataAuth(RefresheableIAMTokenAuth): Authentication class for retrieving IAM tokens from metadata service. This class retrieves IAM tokens from the Google Cloud metadata service. - Read more in `the VM metadata documentation _`. + Read more in `the VM metadata documentation `_. """ env_var = 'YC_METADATA_ADDR' _headers = {'Metadata-Flavor': 'Google'} diff --git a/src/yandex_cloud_ml_sdk/_models/__init__.py b/src/yandex_cloud_ml_sdk/_models/__init__.py index 5c07da1d..177575dc 100644 --- a/src/yandex_cloud_ml_sdk/_models/__init__.py +++ b/src/yandex_cloud_ml_sdk/_models/__init__.py @@ -11,7 +11,7 @@ class BaseModels(DomainWithFunctions): - """Domain for working with `Yandex Foundation Models `.""" + """Domain for working with `Yandex Foundation Models `_.""" completions: BaseCompletions text_classifiers: BaseTextClassifiers image_generation: BaseImageGeneration diff --git a/src/yandex_cloud_ml_sdk/_sdk.py b/src/yandex_cloud_ml_sdk/_sdk.py index 78052449..ce00c588 100644 --- a/src/yandex_cloud_ml_sdk/_sdk.py +++ b/src/yandex_cloud_ml_sdk/_sdk.py @@ -33,16 +33,25 @@ class BaseSDK: """The main class that needs to be instantiated to work with SDK.""" + #: Domain for creating various tools for assistants and function calling tools: BaseTools + #: Domain for working with models (inference and tuning) models: BaseModels + #: Domain for working with threads (a part of the Assistants API) threads: BaseThreads + #: Domain for working with files (a part of the Asssistants API) files: BaseFiles + #: Domain for working with assistants (a part of the Assistants API) assistants: BaseAssistants + #: Domain for working with assistants' runs (a part of the Assistants API) runs: BaseRuns - #: API for `Yandex Search API ` + #: Domain for working with `Search API `_ search_api: BaseSearchAPIDomain + #: Domain for working with search indexes (a part of the Assistants API) search_indexes: BaseSearchIndexes + #: Domain for working with datasets datasets: BaseDatasets + #: Domain for working with tuning tuning: BaseTuning _messages: BaseMessages @@ -110,7 +119,7 @@ def setup_default_logging( ) -> Self: """Sets up the default logging configuration. - Read more about log_levels, log_format, and date_format in `Python documentation (logging) `. + Read more about log_levels, log_format, and date_format in `Python documentation (logging) `_. :param log_level: The logging level to set. :param log_format: The format of the log messages.