Help protect the Great Barrier Reef with TensorFlow on Kaggle Join Challenge

المساهمة في وثائق TensorFlow

ترحب TensorFlow بمساهمات التوثيق - إذا قمت بتحسين الوثائق ، فإنك تقوم بتحسين مكتبة TensorFlow نفسها. تندرج التوثيق على tensorflow.org في الفئات التالية:

بعض المشاريع TensorFlow إبقاء الملفات المصدر ثائق بالقرب من التعليمات البرمجية في مستودع منفصل، وعادة في docs/ الدليل. رؤية المشروع CONTRIBUTING.md ملف أو الاتصال معيل للمساهمة.

للمشاركة في مجتمع مستندات TensorFlow:

مرجع API

للحصول على تفاصيل، استخدم مستندات API دليل المساهم TensorFlow . هذا يظهر لك كيفية العثور على الملف المصدر وتحرير رمز ل docstring . تتضمن العديد من الصفحات المرجعية لواجهة برمجة التطبيقات على tensorflow.org ارتباطًا إلى الملف المصدر حيث يتم تعريف الرمز. جمل التوثيق تدعم تخفيض السعر ، ويمكن (تقريبا) معاينتها باستخدام أي المعاين تخفيض السعر .

الإصدارات والفروع

الموقع إشارة API التخلف الإصدار إلى أحدث استقرارا ثنائي هذا يطابق حزمة تثبيت مع pip install tensorflow .

هو مبني على حزمة TensorFlow الافتراضي من فرع مستقرة rX.x بشكل رئيسي tensorflow / tensorflow الريبو. يتم إنشاء وثائق مرجعية من تعليقات رمز وجمل التوثيق في الشفرة المصدرية ل بايثون ، C ++ ، و جافا .

كما تتوفر الإصدارات السابقة من وثائق TensorFlow فروع rX.x في مستودع TensorFlow مستندات. تتم إضافة هذه الفروع عند إصدار إصدار جديد.

بناء مستندات API

مرجع بايثون

و tensorflow_docs تتضمن حزمة مولد لل مستندات مرجعية API بيثون . لتثبيت:

pip install git+https://github.com/tensorflow/docs

لإنشاء مستندات مرجعية TensorFlow 2، استخدم tensorflow/tools/docs/generate2.py النصي:

git clone https://github.com/tensorflow/tensorflow tensorflow
cd tensorflow/tensorflow/tools/docs
pip install tensorflow
python generate2.py --output_dir=/tmp/out

التوثيق السردي

TensorFlow أدلة و دروس مكتوبة كما تخفيض السعر الملفات والتفاعلية Jupyter أجهزة الكمبيوتر المحمولة. يمكن تشغيل أجهزة الكمبيوتر المحمولة في المتصفح الخاص بك باستخدام جوجل Colaboratory . مستندات السرد على tensorflow.org مبنية من tensorflow / مستندات master فرع. هي الإصدارات القديمة المتاحة في جيثب على rX.x فروع الافراج عنهم.

تغييرات بسيطة

أسهل طريقة لجعل التحديثات الوثائق مباشرة إلى ملفات تخفيض السعر هو استخدام جيثب في محرر ملف على شبكة الإنترنت . تصفح tensorflow / مستندات مستودع للعثور على تخفيض السعر الذي يتوافق تقريبا مع tensorflow.org هيكل URL. في الزاوية العلوية اليسرى من عرض الملف ، انقر على رمز القلم الرصاص لفتح محرر الملف. قم بتحرير الملف ثم قم بإرسال طلب سحب جديد.

قم بإعداد Git repo محليًا

بالنسبة إلى عمليات تحرير الملفات المتعددة أو التحديثات الأكثر تعقيدًا ، من الأفضل استخدام سير عمل Git محلي لإنشاء طلب سحب.

خطوات Git التالية مطلوبة فقط في المرة الأولى التي تقوم فيها بإعداد مشروع محلي.

شوكة tensorflow / docs repo

على tensorflow / مستندات الصفحة جيثب، انقر فوق الزر شوكة لإنشاء نسخة الريبو الخاصة بك تحت حساب GitHub الخاص بك. بمجرد التفرع ، فأنت مسؤول عن الحفاظ على تحديث نسخة الريبو الخاصة بك من خلال ريبو TensorFlow المنبع.

استنساخ الريبو الخاص بك

تحميل نسخة من البريد البعيد username / مستندات الريبو إلى الجهاز المحلي. هذا هو دليل العمل حيث ستقوم بإجراء التغييرات:

git clone git@github.com:username/docs
cd ./docs

إضافة الريبو المنبع للبقاء محدثًا (اختياري)

للحفاظ على مستودع المحلي متزامنا مع tensorflow/docs ، إضافة بعيد المنبع لتحميل أحدث التغييرات.

أضف جهاز تحكم عن بعد:

git remote add upstream git@github.com:tensorflow/docs.git

# View remote repos
git remote -v
origin    git@github.com:username/docs.git (fetch)
origin    git@github.com:username/docs.git (push)
upstream  git@github.com:tensorflow/docs.git (fetch)
upstream  git@github.com:tensorflow/docs.git (push)

للتحديث:

git checkout master
git pull upstream master

git push  # Push changes to your GitHub account (defaults to origin)

سير عمل GitHub

1. إنشاء فرع جديد

بعد تحديث الريبو بك من tensorflow/docs ، إنشاء فرع جديد من فروع الرئيسي المحلي:

git checkout -b feature-name

git branch  # List local branches
  master

* feature-name

2. إجراء التغييرات

تحرير ملفات في محرر المفضلة لديك ويرجى اتباع دليل على غرار وثائق TensorFlow .

التزم بتغيير ملفك:

# View changes
git status  # See which files have changed
git diff    # See changes within files

git add path/to/file.md
git commit -m "Your meaningful commit message for the change."

أضف المزيد من الالتزامات ، حسب الضرورة.

3. إنشاء طلب سحب

تحميل الفرع المحلي لعن بعد الريبو جيثب (github.com/ username / المستندات):

git push

بعد اكتمال الدفع ، قد تعرض رسالة عنوان URL لإرسال طلب سحب تلقائيًا إلى الريبو المنبع. إن لم يكن، انتقل إلى tensorflow / مستندات الريبو أو سوف الريبو والخاصة جيثب يطالبك لإنشاء طلب سحب.

4. المراجعة

سيقوم المشرفون على الصيانة والمساهمون الآخرون بمراجعة طلب السحب الخاص بك. يرجى المشاركة في المناقشة وإجراء التغييرات المطلوبة. عند الموافقة على طلب السحب الخاص بك ، سيتم دمجه في مستودع مستندات TensorFlow المنبع.

هناك خطوة النشر منفصلة لتحديث tensorflow.org من الريبو جيثب. عادةً ، يتم تجميع التغييرات معًا ويتم تحديث الموقع بإيقاع منتظم.

دفاتر تفاعلية

في حين أنه من الممكن أن تحرير الملف JSON كمبيوتر محمول مع جيثب في محرر ملف على شبكة الإنترنت ، فإنه لا ينصح منذ JSON تالف يمكن تلف الملف. تأكد من اختبار الكمبيوتر الدفتري قبل إرسال طلب سحب.

جوجل Colaboratory هي بيئة دفتر استضافت الذي يجعل من السهل على وثائق تحرير والتشغيل المحمولة. يتم تحميل أجهزة الكمبيوتر المحمولة في جيثب في جوجل Colab عن طريق تمرير المسار إلى URL Colab، على سبيل المثال، دفتر الملاحظات تقع في جيثب هنا: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
يمكن تحميلها في جوجل Colab في هذا URL: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

هناك المفتوحة في Colab تمديد كروم أن ينفذ هذا URL الاستبدال عند تصفح دفتر على جيثب. وهذا مفيد عند فتح دفتر في مفترق الريبو الخاص بك، وذلك لأن أعلى أزرار يرتبط دائما إلى TensorFlow مستندات master فرع.

تنسيق دفتر الملاحظات

أداة تنسيق دفتر الملاحظات تجعل مصدر دفتر ملاحظات Jupyter متناسقًا ويسهل مراجعته. نظرًا لاختلاف بيئات تأليف دفتر الملاحظات فيما يتعلق بإخراج الملف والمسافة البادئة والبيانات الوصفية وغيرها من الحقول غير المحددة ؛ nbfmt يستخدم برأيه التخلف مع تفضيل مستندات TensorFlow Colab سير العمل. لتهيئة دفتر، تثبيت TensorFlow أدوات مستندات دفتر وتشغيل nbfmt الأداة:

# Install the tensorflow-docs package:
$ python3 -m pip install -U [--user] git+https://github.com/tensorflow/docs

$ python3 -m tensorflow_docs.tools.nbfmt [options] notebook.ipynb [...]

بالنسبة للمشروعات TensorFlow مستندات وأجهزة الكمبيوتر المحمولة دون الخلايا الناتج يتم تنفيذها واختبارها. وتنشر أجهزة الكمبيوتر المحمولة مع خلايا الناتج حفظها كما هو. nbfmt تحترم الدولة المحمولة ويستخدم --remove_outputs خيار إزالة صراحة خلايا الانتاج.

لإنشاء دفتر جديد ونسخ وتحرير و TensorFlow قالب مستندات دفتر .

تحرير في Colab

داخل بيئة Google Colab ، انقر نقرًا مزدوجًا فوق الخلايا لتحرير النص وكتل التعليمات البرمجية. خلايا النص تستخدم تخفيض السعر، وينبغي أن تتبع دليل TensorFlow مستندات النمط .

تحميل الملفات من دفتر Colab مع ملف> تحميل .pynb. ارتكاب هذا الملف لديك الريبو بوابة المحلي وإرسال طلب سحب.

لإنشاء دفتر جديد ونسخ وتحرير و قالب دفتر TensorFlow .

سير عمل Colab-GitHub

بدلاً من تنزيل ملف دفتر ملاحظات واستخدام سير عمل Git محلي ، يمكنك تحرير وتحديث GitHub repo الخاص بك مباشرةً من Google Colab:

  1. في متشعب الخاص username / مستندات الريبو، استخدم واجهة المستخدم على شبكة الإنترنت جيثب ل إنشاء فرع جديد .
  2. انتقل إلى ملف دفتر الملاحظات للتحرير.
  3. فتح دفتر الملاحظات في جوجل Colab: استخدام مقايضة URL أو فتح في تمديد Colab كروم.
  4. قم بتحرير دفتر الملاحظات في Colab.
  5. تطبيق التغييرات على الريبو بك من Colab مع ملف> حفظ نسخة في جيثب .... يجب أن يرتبط مربع حوار الحفظ بـ الريبو والفرع المناسبين. أضف رسالة التزام ذات مغزى.
  6. بعد الحفظ، استعراض لإعادة الشراء الخاص بك أو tensorflow / مستندات الريبو، جيثب يجب ان يدفع لك لإنشاء طلب سحب.
  7. تتم مراجعة طلب السحب من قبل المشرفين.

الترجمات

يعمل فريق TensorFlow مع المجتمع والموردين لتقديم ترجمات لموقع tensorflow.org. وتقع ترجمة من أجهزة الكمبيوتر المحمولة والمحتوى التقني آخرين في tensorflow / مستندات-L10N جيثب الريبو. يرجى تقديم طلبات سحب من خلال مشروع TensorFlow GitLocalize .

مستندات الإنجليزية هي مصدر من بين الحقيقة ويجب ترجمة متابعة هذه الأدلة في أقرب وقت ممكن. ومع ذلك ، تتم كتابة الترجمات للمجتمعات التي تخدمها. إذا كانت المصطلحات الإنجليزية ، أو الصياغة ، أو الأسلوب ، أو النبرة لا تُترجم إلى لغة أخرى ، فيرجى استخدام ترجمة مناسبة للقارئ.

ويتحدد دعم اللغة من خلال عدد من العوامل بما في ذلك سبيل المثال لا الحصر لموقع المقاييس والطلب والدعم المجتمعي و إتقان اللغة الإنجليزية ، وتفضيل الجمهور، وغيرها من المؤشرات. نظرًا لأن كل لغة مدعومة تتكبد تكلفة ، تتم إزالة اللغات التي لم يتم الحفاظ عليها. وسيتم الإعلان عن دعم لغات جديدة على بلوق TensorFlow أو تويتر .

إذا كانت لغتك المفضلة غير مدعومة ، فنحن نرحب بك للحفاظ على تفرع مجتمع لمساهمي المصدر المفتوح. لم يتم نشرها على موقع tensorflow.org.