ร่วมให้ข้อมูลกับเอกสาร TensorFlow

จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

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

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

จะมีส่วนร่วมในชุมชน TensorFlow เอกสาร:

อ้างอิง API

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

รุ่นและสาขา

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

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

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

เปลี่ยนแปลงง่าย

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

ตั้งค่า repo Git ท้องถิ่น

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

ขั้นตอนต่อไปนี้ Git เท่านั้นต้องมีครั้งแรกที่คุณตั้งค่าโครงการท้องถิ่น

ส้อม tensorflow / เอกสาร repo

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

โคลน repo ของคุณ

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

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

เพิ่ม repo ต้นน้ำเพื่อให้ up-to-date (อุปกรณ์เสริม)

เพื่อให้พื้นที่เก็บข้อมูลในท้องถิ่นของคุณในซิงค์กับ 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. สร้างสาขาใหม่

หลังจากที่คุณปรับปรุง 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 / เอกสาร):

git push

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

4. ทบทวน

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

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

โน๊ตบุ๊คแบบโต้ตอบ

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

Google Colaboratory เป็นสภาพแวดล้อมที่เป็นเจ้าภาพโน๊ตบุ๊คที่ทำให้มันง่ายต่อการและแก้ไขเอกสาร-วิ่งโน๊ตบุ๊ค โน้ตบุ๊คใน GitHub มีการโหลดใน Google Colab โดยผ่านเส้นทางไปยัง Colab URL ตัวอย่างเช่นโน๊ตบุ๊คอยู่ใน 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

มีความเป็น เปิดใน Colab ขยายของ Chrome ที่ดำเนินการเปลี่ยนตัว URL นี้เมื่อเรียกดูโน๊ตบุ๊คบน GitHub นี้จะเป็นประโยชน์เมื่อเปิดโน๊ตบุ๊คในส้อม repo ของคุณเพราะปุ่มด้านบนมักจะเชื่อมโยงไปยัง TensorFlow เอกสาร master สาขา

การจัดรูปแบบโน๊ตบุ๊ค

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

ดาวน์โหลดไฟล์โน๊ตบุ๊คจาก Colab กับไฟล์> ดาวน์โหลด .pynb Commit ไฟล์นี้ที่คุณ repo Git ท้องถิ่น และส่งคำขอดึง

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

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

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

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

การแปล

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

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

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

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