Вклад в проект

Этот проект приветствует вклад и предложения. Большинство вкладов требуют от вас согласия с Лицензионным соглашением участника (CLA), которое подтверждает, что у вас есть право и вы действительно предоставляете нам права на использование вашего вклада. Подробнее см. по адресу https://cla.microsoft.com.

Когда вы отправляете запрос на включение изменений, бот CLA автоматически определит, нужно ли вам предоставить CLA, и соответствующим образом оформит PR (например, добавит метку или комментарий). Просто следуйте инструкциям, предоставленным ботом. Вам нужно будет сделать это только один раз для всех репозиториев, использующих наше CLA.

В этом проекте принят Кодекс поведения Microsoft с открытым исходным кодом (https://opensource.microsoft.com/codeofconduct/). Дополнительную информацию см. в разделе «Часто задаваемые вопросы» Кодекса поведения (https://opensource.microsoft.com/codeofconduct/faq/) или свяжитесь с opencode@microsoft.com с любыми дополнительными вопросами или комментариями.

Вклад кода

Мы приветствуем такие вклады, как исправления ошибок, ядра DirectML или общие улучшения производительности и стабильности. Для более существенных изменений мы просим вас сначала обратиться с проблемами GitHub или связаться с нами напрямую по адресу askdirectml@microsoft.com. В настоящее время этот проект сосредоточен на улучшении функциональной совместимости и производительности с официальным бэкэндом CUDA, поэтому изменения, не связанные с этим, менее вероятно будут одобрены.

Прежде чем создавать запрос на включение изменений, убедитесь, что вы оформили изменение в соответствии со стилем кодирования TensorFlow (см. ниже).

Стиль кодирования C++

Изменения в коде TensorFlow C++ должны соответствовать Руководству по стилю Google C++ (https://google.github.io/styleguide/cppguide.html).

Используйте clang-tidy, чтобы проверить свои изменения C/C++. Чтобы установить clang-tidy на ubuntu:16.04, выполните следующие действия:

apt-get install -y clang-tidy

Вы можете проверить файл C/C++, выполнив следующие действия:

clang-format <my_cc_file> --style=google > /tmp/my_cc_file.cc
diff <my_cc_file> /tmp/my_cc_file.cc

Стиль программирования Python

Изменения в коде Python TensorFlow должны соответствовать Руководству по стилю программирования Google Python (https://github.com/google/styleguide/blob/gh-pages/pyguide.md)

Используйте pylint, чтобы проверить ваши изменения Python. Чтобы установить pylint и получить определение пользовательского стиля TensorFlow:

pip install pylint
wget -O /tmp/pylintrc https://raw.githubusercontent.com/tensorflow/tensorflow/master/tensorflow/tools/ci_build/pylintrc

Чтобы проверить файл с помощью pylint:

pylint --rcfile=/tmp/pylintrc myfile.py