#docstrings — Public Fediverse posts

Трудности перевода: почему LLM не умеют писать нормальные докстринги на русском и как это исправить

Каждый, кто пробовал заставить кодинг-LLM написать вменяемый комментарий к коду на русском, знает, какая это боль. Часто модели либо срываются на английский, либо выдают «кальку», либо игнорируют структуру. А всё потому, что они изначально заточены на английский язык. Огрехи встречаются, в частности, в терминологии: модели путают технические заимствования, например «деплой», «коммит», с их буквальным переводом, что делает текст неестественным для разработчика. В структуре тоже не всегда всё гладко: при генерации на русском модели часто «ломают» установленный для Docstring формат (описание, параметры, return, exceptions), из-за чего IDE перестают подхватывать документацию. Существующие в природе датасеты для обучения кодинг-моделей вроде CodeSearchNet и The Vault либо не содержат русского языка, либо, как MCoNaLa, заточены на поиск, а не на генерацию документации. Именно эту проблему решают ученые из MWS AI: они самостоятельно собрали датасет StRuCom, как раз ориентированный на обучение ИИ генерировать комментарии к коду. Под катом — история о том, как он был собран.

https://habr.com/ru/companies/mts_ai/articles/1035434/

#датасет #комментарии_к_коду #docstrings #автоматизация_разработки #искусственный_интеллект #llm #обучение_моделей #научные_исследования #синтетические_данные #ai

With #Python now being "the most popular programming language" (don't get me started...), the #Unicode consortium has announced a new #codepoint specifically to aid Python #developers and increase efficiency -- both of time, and of storage.

The next Unicode release will include a codepoint representing triple double quotes, making #docstrings much easier.

#quotes #DoubleQuotes #TripleDoubleQuotes #docstring #syntax #popularity

[Перевод] Создаём безукоризненную автодокументацию кода на Python с помощью Sphinx

В этой статье я расскажу о генераторе документации Sphinx , с помощью которого можно автоматически создавать документацию для модулей Python. Кроме того, я буду использовать шаблон проекта Cookiecutter Data Science в Visual Studio Code (VS Code), поскольку он легко интегрируется в Sphinx и имеет стандартизированную структуру директорий. Официальное пособие по использованию Sphinx — отличный ресурс для пользователей, которые хотят углубиться в детали. А моя статья — это краткое руководство по началу работы с этим инструментом.

https://habr.com/ru/companies/netologyru/articles/815563/

#python #документация #sphinx #data_science #автодокументация #docstrings #demopy #строки_документации #confpy #модули_python

🌠 I created a #GitHub repository with my #Python solutions for the #AdventOfCode puzzles

🧩 All solutions use only the #PythonStandardLibrary with no need for external packages

🔬 #Tests are included in function #docstrings and can be run using the #doctest module

⚠️ I don't think I will be able to enter the #solutions every day and definitely not in the morning

🐍 I participate in #AoC to #improve my Python #knowledge rather than to compete in the #leaderboard

👇
https://github.com/pauloxnet/adventofcode