docstring
Пишите docstring PyTorch в стиле проекта
Участникам PyTorch нужны docstring, соответствующие форматированию проекта и соглашениям Sphinx. Этот навык помогает оформлять сигнатуры, аргументы, примеры, математическую нотацию и ссылки для единообразной документации PyTorch API.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "docstring" from https://skillstore.io/skills/pytorch-docstring.md and its manifest at https://skillstore.io/api/skills/pytorch-docstring/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Ресурсы для AI-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «docstring». Запрос на документирование нового вспомогательного средства для свертки.
Ожидаемый результат:
План docstring в стиле PyTorch с сигнатурой, кратким описанием, описаниями аргументов, сведениями о возвращаемом значении и планом примера.
Использование «docstring». Docstring с отсутствующими перекрестными ссылками и неясными необязательными аргументами.
Ожидаемый результат:
Сводка проверки с указанием отсутствующих ссылок Sphinx, проблем со значениями по умолчанию и более понятной формулировки для необязательных параметров.
Использование «docstring». Несколько связанных функций создания тензоров с повторяющимся текстом параметров.
Ожидаемый результат:
План документации, который объединяет общие описания dtype и device, сохраняя примеры, специфичные для каждой функции.
Аудит безопасности
БезопасноAll 102 static findings are false positives. Backticks are Markdown fences, inline code, or Sphinx roles and do not invoke a shell. The URLs are documentation citations, and the reconnaissance detections are ordinary prose with no discovery behavior.
Факторы риска
⚙️ Внешние команды (50)
🌐 Доступ к сети (2)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/pytorch-docstring/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](https://skillstore.io/skills/pytorch-docstring?utm_source=security_passport_badge)Значок HTML
<a href="https://skillstore.io/skills/pytorch-docstring?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/pytorch-docstring/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Встраиваемая карточка
<iframe src="https://skillstore.io/embed/skills/pytorch-docstring.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Академические ссылки (APA · BibTeX · CFF)
Цитата APA
pytorch. (2026). docstring security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/pytorch-docstring/audits/9Цитата BibTeX
@techreport{pytorch-pytorch-docstring-2026,
author = {pytorch},
title = {docstring security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/pytorch-docstring/audits/9},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "docstring security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "pytorch"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/pytorch-docstring/audits/9"
identifiers:
- type: other
value: "skillstore:pytorch-docstring:audit:9"
description: "Skillstore immutable audit report identifier"
Оценка Skillstore
Почему такая оценка Достоверность доказательств: ВысокийЧто вы можете построить
Задокументировать новый оператор
Участник PyTorch составляет docstring с правильной сигнатурой, списком аргументов, примерами и связанными ссылками.
Проверить документацию API
Мейнтейнер проверяет, соответствует ли обновленный docstring соглашениям PyTorch по форматированию, математике и Sphinx.
Стандартизировать сгенерированную документацию
Инженер по документации приводит несколько записей API к единому виду с общими определениями аргументов, примерами, примечаниями и предупреждениями.
Попробуйте эти промпты
Напиши docstring в стиле PyTorch для этой функции. Включи строку сигнатуры, краткое описание, раздел Args и один пример.
Улучши этот docstring PyTorch, добавив ссылки Sphinx на классы, функции, методы и математику там, где они помогут читателям.
Проверь этот docstring PyTorch на соответствие соглашениям проекта. Перечисли отсутствующие разделы, проблемы форматирования, неясные параметры и улучшения для примеров.
Отрефактори эти связанные docstring PyTorch, чтобы переиспользовать общий текст аргументов, сохранить поведение и обеспечить согласованность примеров.
Лучшие практики
- Добавляйте полную строку сигнатуры перед описательным текстом.
- Используйте raw-строки, когда docstring содержит математику, escape-последовательности или роли Sphinx.
- Добавляйте сфокусированные примеры, показывающие обычное использование и важные опции.
Избегать
- Не опускайте значения по умолчанию для необязательных параметров.
- Не смешивайте стили NumPy, Google и PyTorch docstring в одной записи.
- Не добавляйте внешние ссылки, если они не улучшают понимание читателя.