Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/yandex_cloud_ml_sdk/_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://yandex.cloud/docs/iam/concepts/authorization/api-key>_`.
Read more about the API key in `the documentation <https://yandex.cloud/docs/iam/concepts/authorization/api-key>`_.
"""
env_var = 'YC_API_KEY'

Expand Down Expand Up @@ -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 <https://yandex.cloud/docs/iam/concepts/authorization/iam-token>_`.
Read more about the IAM token in `the documentation <https://yandex.cloud/docs/iam/concepts/authorization/iam-token>`_.
"""
env_var = 'YC_IAM_TOKEN'

Expand Down Expand Up @@ -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 <https://yandex.cloud/docs/iam/concepts/authorization/oauth-token>_`.
Read more about the OAuth token in `the documentation <https://yandex.cloud/docs/iam/concepts/authorization/oauth-token>`_.
"""
env_var = 'YC_OAUTH_TOKEN'

Expand Down Expand Up @@ -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 <https://yandex.cloud/docs/cli/>_`.
Read more in `the CLI documentation <https://yandex.cloud/docs/cli/>`_.
"""
env_var = 'YC_PROFILE'

Expand Down Expand Up @@ -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 <https://yandex.cloud/docs/compute/concepts/vm-metadata>_`.
Read more in `the VM metadata documentation <https://yandex.cloud/docs/compute/concepts/vm-metadata>`_.
"""
env_var = 'YC_METADATA_ADDR'
_headers = {'Metadata-Flavor': 'Google'}
Expand Down
2 changes: 1 addition & 1 deletion src/yandex_cloud_ml_sdk/_models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@


class BaseModels(DomainWithFunctions):
"""Domain for working with `Yandex Foundation Models <https://yandex.cloud/ru/services/foundation-models>`."""
"""Domain for working with `Yandex Foundation Models <https://yandex.cloud/ru/services/foundation-models>`_."""
completions: BaseCompletions
text_classifiers: BaseTextClassifiers
image_generation: BaseImageGeneration
Expand Down
13 changes: 11 additions & 2 deletions src/yandex_cloud_ml_sdk/_sdk.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://yandex.cloud/docs/search-api>`
#: Domain for working with `Search API <https://yandex.cloud/docs/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
Expand Down Expand Up @@ -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) <https://docs.python.org/3/library/logging.html>`.
Read more about log_levels, log_format, and date_format in `Python documentation (logging) <https://docs.python.org/3/library/logging.html>`_.

:param log_level: The logging level to set.
:param log_format: The format of the log messages.
Expand Down