Attend the Women in ML Symposium on December 7 Register now

תרום לתיעוד TensorFlow

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

TensorFlow מברך תרומות-אם התיעוד לך לשפר את התיעוד, אתה לשפר את הספרייה TensorFlow עצמה. תיעוד על tensorflow.org נופל לקטגוריות הבאות:

כמה פרויקטי TensorFlow לשמור קבצי תיעוד מקור סמוך הקוד במאגר נפרד, בדרך כלל בתוך docs/ בספרייה. ראה בפרויקט של CONTRIBUTING.md קובץ או לפנות מתחזק לתרום.

כדי להשתתף בקהילה Docs TensorFlow:

פניית API

לפרטים, להשתמש המדריך התורם Docs API TensorFlow . זה מראה לך איך למצוא את קובץ המקור ולערוך את הסמל docstring . דפי פניית API רבים על tensorflow.org לכלול קישור לקובץ המקור שבו הסמל מוגדר. Docstrings לתמוך Markdown וניתן (כ) בתצוגה המקדימה באמצעות כל previewer Markdown .

גרסאות וענפים

האתר של פניית API מחדל בגרסת אל היציבה האחרונה בינארי-זו תואמת את החבילה מותקנת עם pip install tensorflow .

חבילת TensorFlow מחדל בנוי מענף היציב rX.x בעיקרו tensorflow / tensorflow ריפה. תיעוד העזר מופק הערות הקוד docstrings בקוד המקור עבור Python , C ++ , ו- Java .

גירסאות קודמות של תיעוד TensorFlow זמינים סניפים rX.x במאגר Docs TensorFlow. סניפים אלה מתווספים כאשר שוחררה גרסה חדשה.

Docs ממשק API של build

פניית Python

tensorflow_docs החבילה כוללת מחולל עבור Docs הפניה API Python . להתקין:

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 מדריכים ו הדרכות נכתבים כפי Markdown קבצים אינטראקטיביים Jupyter מחברות. מחברת ניתן להפעיל בדפדפן באמצעות Google Colaboratory . "הרופאים הנרטיב על tensorflow.org נבנים מן tensorflow / docs master הסניף. גרסאות ישנות יותר זמינים GitHub על rX.x סניפים שחרורו.

שינויים פשוטים

הדרך הקלה ביותר לבצע עדכוני תיעוד פשוט לקבצי Markdown היא להשתמש של GitHub עורך קובץ מבוסס אינטרנט . עיון tensorflow / docs למאגר הנתונים כדי למצוא את Markdown כי בערך המתאים tensorflow.org מבנה URL. בפינה הימנית העליונה של התצוגה קובץ, לחץ על סמל העיפרון כדי לפתוח את עורך הקובץ. ערוך את הקובץ ולאחר מכן להגיש בקשה למשוך חדשה.

הגדרת ריפו מקומי Git

עבור עריכות רב-קובץ או עדכונים מורכבים יותר, עדיף להשתמש Git המקומי עבודה כדי ליצור בקשת משיכה.

שלבי Git הבאים נדרשים רק בפעם הראשונה שאתה להקים פרויקט מקומי.

פורק tensorflow / docs ריפה

על tensorflow / docs דף GitHub, לחץ על כפתור המזלג כדי ליצור עותק ריפו משלך תחת חשבון GitHub שלך. לאחר מפוצל, אתה אחראי לשמירה ריפו שלך להעתיק עַדכָּנִי עם ריפו TensorFlow במעלה הזרם.

Clone ריפו שלך

הורד עותק של המרוחק username / docs ריפה במחשב המקומי. זהה את ספריית העבודה שבו תוכל לבצע שינויים:

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 המרוחק (github.com/ username / docs):

git push

לאחר משלים דחיפה, הודעה עשויה להציג כתובת להגיש בקשה למשוך אוטומטית ריפו במעלה הזרם. אם לא, ללכת tensorflow / docs ריפה-או ריפה-ו משלך GitHub ינחה אותך ליצור בקשת משיכה.

סקירת 4.

מתחזק ותורמים אחרים יבחנו את הבקשה למשוך שלך. אנא להשתתף בדיון ולבצע את השינויים המבוקשים. כאשר בקשת המשיכה שלך תאושר, זה ימוזג לתוך ריפיו Docs TensorFlow במעלה הזרם.

ישנו צעד פרסום נפרד עדכון tensorflow.org מן ריפו GitHub. בדרך כלל, שינויים מתבצעים באופן מאוחד יחד והאתר מתעדכן על מקצב קבוע.

מחברות אינטרקטיוויות

בעוד שזה אפשרי כדי לערוך את הקובץ בפנקס JSON עם של GitHub עורך קובץ מבוסס אינטרנט , זה לא מומלץ מאחר JSON הפגום יכול להשחית את הקובץ. הקפד לבדוק את המחברת לפני הגשת בקשה למשוך.

Google Colaboratory היא סביבה מחברת ארחה מקלה בתיעוד לערוך-וברח-במחברת. מחברת ב GitHub נטענת ב- Google Colab ידי העביר את הנתיב אל כתוב אתר Colab, למשל, את המחברת הממוקמת GitHub כאן: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
ניתן להטעין Google Colab בכתובת הזו: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

יש פתח Colab רחבת Chrome שמבצע זה החלפת URL בעת גלישת מחברת על GitHub. תכונה זו שימושית בעת פתיחת מחברת מזלג ריפו שלך, משום הכפתורים העליונים תמיד לקשר את Docs TensorFlow master הסניף.

עיצוב מחברת

מחברת עיצוב כלי שהופכת למקור מחברת Jupyter הפרשים עקבי יותר לביקורת. מאז סביבות עריכת מחברת שונות לגבי פלט קובץ, זחה, מטה ובתחומים שאינו מצוינים אחרים; nbfmt משתמשת דעתניים המחדל תוך העדפת העבודה Colab Docs TensorFlow. כדי לעצב מחברת, להתקין את הכלים מחברת Docs 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 [...]

עבור פרויקטי Docs TensorFlow, מחברות ללא תאי פלט מבוצעות ונבדקו; מחברות עם תאי פלט נשמרו מתפרסמות הכמות שהוא. nbfmt מכבדת את מדינת המחברת ומשתמשת --remove_outputs האפשרות להסיר תאי פלט במפורש.

כדי ליצור מחברת חדשה, להעתיק ולערוך את תבנית מחברת Docs TensorFlow .

עריכת Colab

בתוך הסביבה Colab Google, לחץ פעמיים התאים לטקסט לערוך גושי קוד. תאי טקסט להשתמש Markdown ועליה לפעול על פי מדריך הסגנון Docs TensorFlow .

קבצים מחברת הורדה מ Colab עם קובץ> הורד .pynb. להתחייב קובץ זה שלך ריפה Git המקומי ולשלוח בקשה למשוך.

כדי ליצור מחברת חדשה, להעתיק ולערוך את תבנית מחברת TensorFlow .

עבודת Colab-GitHub

במקום להוריד קובץ המחברת באמצעות זרימת עבודת Git מקומית, תוכל לערוך ולעדכן המפוצל שלך GitHub ריפה ישירות מגוגל Colab:

  1. בשנת המפוצל שלך username / docs ריפו, להשתמש בממשק המשתמש באינטרנט GitHub כדי ליצור ענף חדש .
  2. נווט אל הקובץ מחברת לערוך.
  3. פתח את המחברת ב Colab גוגל: להשתמש swap URL או פתח הרחבה Colab Chrome.
  4. ערוך את המחברת ב Colab.
  5. לבצע את השינויים כדי ריפו שלך Colab עם קובץ> שמור עותק ב GitHub .... שמור שיח לקשר את ריפיו סניף המתאימים. הוספת משמעות להתחייב הודעה.
  6. לאחר השמירה, עיון כדי ריפו שלך או tensorflow / docs ריפו, GitHub צריך להנחות אותך ליצור בקשת משיכה.
  7. הבקשה למשוך תיבדק על ידי מתחזקים.

תרגומים

צוות TensorFlow עובד עם קהילת ספקים לספק תרגומים עבור tensorflow.org. תרגומים של מחשבים ניידים ותוכן טכני אחר ממוקמים tensorflow / docs-l10n ריפה GitHub. הגש את בקשות משיכה באמצעות פרויקט TensorFlow GitLocalize .

"הרופאים אנגלית הם המקור-של-אמת ותרגומים צריכים לעקוב המדריכים האלה קרוב ככל האפשר. עם זאת, תרגומים כתובים עבור הקהילות הם משרתים. אם המינוח באנגלית, ניסוח, סגנון, או טון אינו מתרגם לשפה אחרת, השתמש מתאים תרגום עבור הקורא.

תמיכת שפה נקבעת לפי מספר גורמים, כולל, אבל לא רק באתר מדדים וביקוש, תמיכה בקהילה, שליטה באנגלית , העדפת קהל, ואינדיקטורים אחרים. מאז כל שפה נתמכת כרוך בעלות, בשפות שלא מנוהל יוסרו. תמיכה בשפות חדשות תוכרז על בלוג TensorFlow או טוויטר .

אם השפה המועדפת עליך אינו נתמכת, אתה מוזמן להחזיק מזלג קהילה עבור תורמי קוד פתוח. אלה אינן מתפרסמות tensorflow.org.