Google is committed to advancing racial equity for Black communities. See how.
หน้านี้ได้รับการแปลโดย Cloud Translation API
Switch to English

มีส่วนร่วมในเอกสาร TensorFlow

TensorFlow ยินดีต้อนรับการสนับสนุนด้านเอกสารหากคุณปรับปรุงเอกสารคุณจะปรับปรุงไลบรารี TensorFlow เอง เอกสารใน tensorflow.org จัดอยู่ในประเภทต่อไปนี้:

โครงการ TensorFlow บาง โครงการ เก็บไฟล์ต้นฉบับเอกสารไว้ใกล้กับโค้ดในที่เก็บแยกต่างหากโดยปกติจะอยู่ใน docs/ directory ดูไฟล์ CONTRIBUTING.md ของโครงการหรือติดต่อผู้ดูแลเพื่อร่วมให้ข้อมูล

ในการเข้าร่วมในชุมชนเอกสาร TensorFlow:

การอ้างอิง API

หากต้องการอัปเดตเอกสารอ้างอิงให้ค้นหา ไฟล์ต้นฉบับ และแก้ไข docstring ของสัญลักษณ์ เพจอ้างอิง API จำนวนมากบน tensorflow.org มีลิงก์ไปยังไฟล์ต้นฉบับที่มีการกำหนดสัญลักษณ์ Docstrings รองรับ Markdown และสามารถดูตัวอย่าง (โดยประมาณ) โดยใช้ตัว แสดงตัวอย่าง Markdown

สำหรับคุณภาพเอกสารอ้างอิงและวิธีมีส่วนร่วมกับ doc sprints และชุมชนโปรดดู คำแนะนำ TensorFlow 2 API Docs

เวอร์ชันและสาขา

เวอร์ชัน อ้างอิง API ของไซต์มีค่าเริ่มต้นเป็นไบนารีที่เสถียรล่าสุดซึ่งตรงกับแพ็กเกจที่ติดตั้งด้วย pip install tensorflow

แพ็กเกจ TensorFlow ดีฟอลต์ถูกสร้างขึ้นจาก rX.x สาขาที่เสถียรใน repo tensorflow / tensorflow หลัก เอกสารอ้างอิงถูกสร้างขึ้นจากความคิดเห็นของโค้ดและ docstrings ในซอร์สโค้ดสำหรับ Python , C ++ และ Java

เวอร์ชันก่อนหน้าของเอกสาร TensorFlow พร้อมใช้งานในรูปแบบ rX.x branch ในที่เก็บ TensorFlow Docs สาขาเหล่านี้จะถูกเพิ่มเมื่อมีการเผยแพร่เวอร์ชันใหม่

สร้างเอกสาร API

การอ้างอิง Python

แพ็กเกจ tensorflow_docs มีตัวสร้างสำหรับ เอกสารอ้างอิง Python 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 เขียนเป็นไฟล์ Markdown และสมุดบันทึก Jupyter แบบโต้ตอบ สามารถเรียกใช้โน้ตบุ๊กในเบราว์เซอร์ของคุณโดยใช้ Google Colaboratory เอกสารการบรรยายบน tensorflow.org สร้างขึ้นจากสาขา master tensorflow / docs เวอร์ชันเก่ามีอยู่ใน GitHub บนสาขารีลีส rX.x

การเปลี่ยนแปลงง่ายๆ

วิธีที่ง่ายที่สุดในการอัปเดตเอกสารที่ตรงไปตรงมาสำหรับไฟล์ Markdown คือการใช้ โปรแกรมแก้ไขไฟล์บนเว็บ ของ GitHub เรียกดูที่ เก็บ tensorflow / docs เพื่อค้นหา Markdown ที่สอดคล้องกับโครงสร้าง URL ของ tensorflow.org อย่างคร่าวๆ ที่มุมขวาบนของมุมมองไฟล์ให้คลิกไอคอนดินสอ เพื่อเปิดโปรแกรมแก้ไขไฟล์ แก้ไขไฟล์จากนั้นส่งคำขอดึงใหม่

ตั้งค่า Git repo ในเครื่อง

สำหรับการแก้ไขหลายไฟล์หรือการอัปเดตที่ซับซ้อนมากขึ้นควรใช้เวิร์กโฟลว์ Git ภายในเพื่อสร้างคำขอดึง

ขั้นตอน Git ต่อไปนี้จำเป็นเฉพาะในครั้งแรกที่คุณตั้งค่าโปรเจ็กต์ภายในเครื่อง

แยกเทนเซอร์โฟลว์ / เอกสาร repo

ในหน้า tensorflow / docs GitHub ให้คลิกปุ่ม Fork เพื่อสร้างสำเนา repo ของคุณเองภายใต้บัญชี GitHub ของคุณ เมื่อแยกแล้วคุณมีหน้าที่รับผิดชอบในการทำให้สำเนา repo ของคุณเป็นปัจจุบันด้วยที่เก็บ TensorFlow ต้นน้ำ

โคลน repo ของคุณ

ดาวน์โหลดสำเนาของระยะไกลของคุณ username / เอกสาร repo กับเครื่องในประเทศของคุณ นี่คือไดเร็กทอรีการทำงานที่คุณจะทำการเปลี่ยนแปลง:

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

เพิ่ม repo ต้นน้ำเพื่อให้ทันสมัยอยู่เสมอ (ไม่บังคับ)

เพื่อให้ที่เก็บในเครื่องของคุณซิงค์กับ tensorflow/docs ให้เพิ่ม upstream remote เพื่อดาวน์โหลดการเปลี่ยนแปลงล่าสุด

เพิ่มรีโมท:

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. สร้างสาขาใหม่

หลังจากคุณอัปเดต repo ของคุณจาก 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. สร้างคำขอดึง

อัปโหลดสาขาในพื้นที่ของคุณไปยัง repo GitHub ระยะไกลของคุณ (github.com/ username / docs):

git push

หลังจากพุชเสร็จสิ้นข้อความอาจแสดง URL เพื่อส่งคำขอดึงไปยังที่เก็บอัปสตรีมโดยอัตโนมัติ ถ้าไม่มีให้ไปที่ repo tensorflow / docs หรือ repo ของคุณเองและ GitHub จะแจ้งให้คุณสร้างคำขอดึง

4. ทบทวน

ผู้ดูแลและผู้มีส่วนร่วมอื่น ๆ จะตรวจสอบคำขอดึงของคุณ โปรดเข้าร่วมในการอภิปรายและทำการเปลี่ยนแปลงตามที่ร้องขอ เมื่อคำขอดึงของคุณได้รับการอนุมัติคำขอจะรวมเข้ากับที่เก็บเอกสาร TensorFlow ต้นน้ำ

มีขั้นตอนการเผยแพร่แยกต่างหากในการอัปเดต tensorflow.org จาก repo GitHub โดยทั่วไปการเปลี่ยนแปลงจะรวมกันเป็นกลุ่มและมีการอัปเดตไซต์ตามจังหวะปกติ

สมุดบันทึกแบบโต้ตอบ

แม้ว่าจะสามารถแก้ไขไฟล์ JSON ของโน้ตบุ๊กด้วย โปรแกรมแก้ไขไฟล์บนเว็บ ของ GitHub ได้ แต่ก็ไม่แนะนำให้ใช้เนื่องจาก JSON ที่มีรูปแบบไม่ถูกต้องอาจทำให้ไฟล์เสียหายได้ ตรวจสอบให้แน่ใจว่าได้ทดสอบโน้ตบุ๊กก่อนส่งคำขอดึง

Google Colaboratory เป็นสภาพแวดล้อมของโน้ตบุ๊กที่โฮสต์ซึ่งช่วยให้แก้ไขและเรียกใช้เอกสารของโน้ตบุ๊กได้ง่าย สมุดบันทึกใน GitHub โหลดใน Google Colab โดยส่งเส้นทางไปยัง URL ของ Colab เช่นสมุดบันทึกที่อยู่ใน GitHub ที่นี่: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
สามารถโหลดลงใน Google Colab ได้ที่ URL นี้: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

มีส่วนขยาย Open in Colab Chrome ที่ทำการแทนที่ URL นี้เมื่อเรียกดูสมุดบันทึกบน GitHub สิ่งนี้มีประโยชน์เมื่อเปิดสมุดบันทึกใน repo fork ของคุณเนื่องจากปุ่มด้านบนจะเชื่อมโยงไปยังสาขา master ของ TensorFlow Docs เสมอ

การจัดรูปแบบสมุดบันทึก

เครื่องมือจัดรูปแบบสมุดบันทึกทำให้แหล่งที่มาของสมุดบันทึก Jupyter แตกต่างกันอย่างสม่ำเสมอและง่ายต่อการตรวจสอบ เนื่องจากสภาพแวดล้อมการเขียนสมุดบันทึกแตกต่างกันไปตามเอาต์พุตไฟล์การเยื้องข้อมูลเมตาและฟิลด์อื่น ๆ ที่ไม่ได้ระบุ nbfmt ใช้ค่าเริ่มต้นที่แสดงความคิดเห็นพร้อมการกำหนดค่าตามความชอบสำหรับเวิร์กโฟลว์ Colab ของเอกสาร TensorFlow ในการจัดรูปแบบสมุดบันทึกให้ติดตั้ง เครื่องมือสมุดบันทึก 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 docs

แก้ไขใน Colab

ภายในสภาพแวดล้อม Google Colab ให้ดับเบิลคลิกที่เซลล์เพื่อแก้ไขบล็อกข้อความและโค้ด เซลล์ข้อความใช้ Markdown และควรเป็นไปตาม คำแนะนำสไตล์เอกสาร TensorFlow

ดาวน์โหลดไฟล์สมุดบันทึกจาก Colab ด้วย ไฟล์> ดาวน์โหลด . pynb ส่งไฟล์นี้ไปยัง Git repo ในพื้นที่ ของคุณและส่งคำขอดึง

หากต้องการสร้างสมุดบันทึกใหม่ให้คัดลอกและแก้ไข เทมเพลตสมุดบันทึก TensorFlow

เวิร์กโฟลว์ Colab-GitHub

แทนที่จะดาวน์โหลดไฟล์โน้ตบุ๊กและใช้เวิร์กโฟลว์ Git ในเครื่องคุณสามารถแก้ไขและอัปเดต repo GitHub ที่แยกจาก Google Colab ได้โดยตรง:

  1. ใน username / username แยกส่วนของคุณให้ใช้ UI ของเว็บ GitHub เพื่อ สร้างสาขาใหม่
  2. ไปที่ไฟล์สมุดบันทึกเพื่อแก้ไข
  3. เปิดสมุดบันทึกใน Google Colab: ใช้การสลับ URL หรือส่วนขยาย Open in Colab Chrome
  4. แก้ไขสมุดบันทึกใน Colab
  5. ยอมรับการเปลี่ยนแปลง repo ของคุณจาก Colab ด้วย ไฟล์> บันทึกสำเนาใน GitHub ... กล่องโต้ตอบบันทึกควรเชื่อมโยงไปยัง repo และสาขาที่เหมาะสม เพิ่มข้อความยืนยันที่มีความหมาย
  6. หลังจากบันทึกแล้วให้เรียกดู repo ของคุณหรือ repo tensorflow / docs แล้ว GitHub ควรแจ้งให้คุณสร้างคำขอดึง
  7. คำขอดึงได้รับการตรวจสอบโดยผู้ดูแล

การแปล

ทีมงาน TensorFlow ทำงานร่วมกับชุมชนและผู้ขายเพื่อจัดเตรียมคำแปลสำหรับ tensorflow.org การแปลสมุดบันทึกและเนื้อหาทางเทคนิคอื่น ๆ จะอยู่ในที่ เก็บ GitHub ของ tensorflow / docs-l10n โปรดส่งคำขอดึงผ่าน โครงการ TensorFlow GitLocalize

เอกสารภาษาอังกฤษเป็น แหล่งที่มาของความจริง และการแปลควรปฏิบัติตามคำแนะนำเหล่านี้ให้ใกล้เคียงที่สุด ที่กล่าวว่าคำแปลเขียนขึ้นสำหรับชุมชนที่พวกเขาให้บริการ หากคำศัพท์ภาษาอังกฤษวลีรูปแบบหรือน้ำเสียงไม่ได้แปลเป็นภาษาอื่นโปรดใช้คำแปลที่เหมาะสมกับผู้อ่าน

การสนับสนุนภาษาจะพิจารณาจากปัจจัยหลายประการซึ่งรวมถึง - แต่ไม่ จำกัด เพียง - เมตริกและอุปสงค์ของไซต์การสนับสนุนจากชุมชน ความสามารถทางภาษาอังกฤษ ความชอบของผู้ชมและตัวบ่งชี้อื่น ๆ เนื่องจากภาษาที่รองรับแต่ละภาษามีค่าใช้จ่ายภาษาที่ไม่ได้รับการดูแลจะถูกลบออก การสนับสนุนภาษาใหม่จะประกาศใน บล็อก TensorFlow หรือ Twitter

หากไม่รองรับภาษาที่คุณต้องการคุณสามารถดูแลชุมชนสำหรับผู้ร่วมให้ข้อมูลโอเพนซอร์สได้ สิ่งเหล่านี้จะไม่เผยแพร่ไปยัง tensorflow.org