Add docstrings for _models/image_generation by Mandzhi · Pull Request #115 · yandex-cloud/yandex-ai-studio-sdk

Mandzhi · 2025-06-26T18:54:30Z

First version is ready for review

vhaldemar

Я правильно понял, что ты в этом ПР со всеми файлами директории придешь?
И пока он не финальный?

vhaldemar · 2025-06-30T15:33:13Z

src/yandex_cloud_ml_sdk/_models/image_generation/function.py


 class BaseImageGeneration(BaseModelFunction[ModelTypeT]):
+    """
+    Base class for image generation models.


Это не бейз класс.
Точнее это бейз класс, но ты-то копируешь эту строчку через doc_from

vhaldemar · 2025-06-30T15:34:39Z

src/yandex_cloud_ml_sdk/_models/image_generation/function.py

+
+    Returns a model's object through which requests to the backend are made.
+
+        >>> model = sdk.models.image_generation('yandex-art') #this is how the model is created


Кажется, оступ лишний в 4 пробела

#this is how the model is created -> # this is how the model is created

(два пробела перед # и один после, так принято)

vhaldemar · 2025-06-30T15:35:43Z

src/yandex_cloud_ml_sdk/_models/image_generation/message.py

 @dataclass(frozen=True)
 class ImageMessage:
+    """
+    This class represents an image message with optional weight.


optional weight field, мне кажется

vhaldemar · 2025-06-30T15:36:16Z

src/yandex_cloud_ml_sdk/_models/image_generation/message.py



 def messages_to_proto(messages: ImageMessageInputType) -> list[ProtoMessage]:
+    """


Это не надо, это внутреннее.
:meta private:

vhaldemar · 2025-06-30T15:36:49Z

src/yandex_cloud_ml_sdk/_models/image_generation/message.py

+    """
    text: str




зато надо ImageMessageType и ImageMessageInputType

… _models/image_generation/model.py - v2

vhaldemar · 2025-07-01T13:42:37Z

src/yandex_cloud_ml_sdk/_models/image_generation/message.py

 @dataclass(frozen=True)
 class ImageMessage:
+    """
+    This class represents an image message with optional weight field.


Что такое image message?)
На самом деле, это просто структура сообщения, которую модель ожидает от пользователя.
То есть "message for using in image generation models", ниже тоже самое

vhaldemar · 2025-07-01T13:43:20Z

src/yandex_cloud_ml_sdk/_models/image_generation/message.py



 ImageMessageType = Union[ImageMessage, ImageMessageDict, AnyMessage, str]
+"""Type alias for different types of image messages that can be processed."""


Вообще, так, наверное, сработает, но я ожидал #: над переменной

vhaldemar · 2025-07-01T13:44:03Z

src/yandex_cloud_ml_sdk/_models/image_generation/model.py

 class BaseImageGenerationModel(
    ModelAsyncMixin[ImageGenerationModelConfig, ImageGenerationModelResult, OperationTypeT],
 ):
+    """A class for image generation models."""


Нет, это уже класс одной, конкретной модели.
Можно дописать, что она в себе инкапсулирует УРИ модели и конфигурацию

vhaldemar · 2025-07-01T13:44:35Z

src/yandex_cloud_ml_sdk/_models/image_generation/model.py

+        :param seed: a random seed for generation.
+        :param width_ratio: the width ratio for the generated image.
+        :param height_ratio: the height ratio for the generated image.
+        :param mime_type: the MIME type of the generated image.


Здесь бы не помешала бы ссылка на доку про то, а какие MIME-типы мы умеем принимать

vhaldemar · 2025-07-01T13:45:40Z

src/yandex_cloud_ml_sdk/_models/image_generation/model.py

+        and returns an operation representing the ongoing image generation process.
+
+        :param messages: the input messages for image generation.
+        :param timeout: the timeout for the operation in seconds.


Вот только тут слово "операция" конфликтует со словом "операция" выше.
Это разные операции))
В таймауте имеется ввиду - операция http-запрос по созданию объекта Операции.

vhaldemar · 2025-07-01T13:46:07Z

src/yandex_cloud_ml_sdk/_models/image_generation/result.py


 @dataclass(frozen=True, repr=False)
 class ImageGenerationModelResult(BaseResult):
+    """This class represents the result of an image generation model."""


This class represents the result of an image generation model inference

Как мне кажется

vhaldemar · 2025-07-01T13:46:48Z

src/yandex_cloud_ml_sdk/_models/image_generation/result.py


    @classmethod
    def _from_proto(cls, *, proto: ProtoMessage, sdk: BaseSDK) -> Self:  # pylint: disable=unused-argument
+        """:meta private:"""


Вот такие методы, начинающиеся с _, их не надо помечать

vhaldemar · 2025-07-01T13:48:17Z

src/yandex_cloud_ml_sdk/_models/image_generation/result.py

        )

    def _repr_jpeg_(self) -> bytes | None:
+        """:meta private:"""


А вот это, как ни странно, наоборот, именно _repr_smth_ - это как бы публичные методы.
Напиши им пока meta public, я не уверен, скушает ли это сфинкс.
А связанная ссылка про эти методы - https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display

Сделай :meta public:, пожалуйста

vhaldemar · 2025-07-01T13:48:42Z

src/yandex_cloud_ml_sdk/_models/image_generation/result.py

        return None

    def __repr__(self) -> str:
+        """:meta private:"""


__repr__ просто не трогай)

vhaldemar · 2025-07-02T12:40:32Z

src/yandex_cloud_ml_sdk/_models/image_generation/message.py

    text: str

-
+#: type alias for different types of image messages that can be processed


of messages that can be processed by image generation models

vhaldemar · 2025-07-02T12:42:10Z

src/yandex_cloud_ml_sdk/_models/image_generation/result.py

        )

    def _repr_jpeg_(self) -> bytes | None:
+        """:meta private:"""


Сделай :meta public:, пожалуйста

Mandzhi and others added 4 commits June 26, 2025 21:54

Add docstrings for _models/image_generation/function.py

38f672f

First version is ready for review

[pre-commit.ci lite] apply automatic fixes

1e3c4dd

Add docstrings for _models/image_generation/function.py - v2

4dc64eb

Add docstrings for _models/image_generation/message.py

3e0790b

Mandzhi changed the title ~~Add docstrings for _models/image_generation/function.py~~ Add docstrings for _models/image_generation/function.py and _models/image_generation/message.py Jun 29, 2025

vhaldemar reviewed Jun 30, 2025

View reviewed changes

vhaldemar changed the title ~~Add docstrings for _models/image_generation/function.py and _models/image_generation/message.py~~ Add docstrings for _models/image_generation Jun 30, 2025

Mandzhi and others added 10 commits July 1, 2025 12:50

Add docstrings for _models/image_generation/function.py - v3

ec11730

Add docstrings for _models/image_generation/message.py - v2

cf6ce94

Add docstrings for _models/image_generation/result.py - v1

ad281bb

Add docstrings for _models/image_generation/model.py - v1

e08d487

[pre-commit.ci lite] apply automatic fixes

5a34ef2

Add dfrom yandex_cloud_ml_sdk._utils.doc import doc_fromocstrings for…

3f38094

… _models/image_generation/model.py - v2

[pre-commit.ci lite] apply automatic fixes

f3d841e

Add docstrings _model/image_generation/model.py - v2

cd7c1c1

[pre-commit.ci lite] apply automatic fixes

f4b7892

Add docstrings for _models/image_generation/model.py - v3

ae40a0e

vhaldemar reviewed Jul 1, 2025

View reviewed changes

Mandzhi added 3 commits July 1, 2025 21:14

Add docstrings for _models/image_generation/message.py - v3

c37a528

Add docstrings for _models/image_generation/result.py - v2

f903ef5

Add docstrings for _models/image_generation/model.py - v4

5baf79f

vhaldemar reviewed Jul 2, 2025

View reviewed changes

Mandzhi added 2 commits July 2, 2025 16:05

Add docstrings for _models/image_generation/message.py - v4

ccf3dd7

Add docstrings for _models/image_generation/result.py - v3

b8a2f24

vhaldemar merged commit 37a1118 into yandex-cloud:master Jul 2, 2025
11 checks passed

GBocharov pushed a commit that referenced this pull request Nov 28, 2025

Add docstrings for _models/image_generation (#115)

9ce0ad4


		Returns a model's object through which requests to the backend are made.

		>>> model = sdk.models.image_generation('yandex-art') #this is how the model is created



		def messages_to_proto(messages: ImageMessageInputType) -> list[ProtoMessage]:
		"""



		ImageMessageType = Union[ImageMessage, ImageMessageDict, AnyMessage, str]
		"""Type alias for different types of image messages that can be processed."""

		text: str


		#: type alias for different types of image messages that can be processed

Conversation

Mandzhi commented Jun 26, 2025

Uh oh!

vhaldemar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants