RSVP for your your local TensorFlow Everywhere event today!
Halaman ini diterjemahkan oleh Cloud Translation API.
Switch to English

Berkontribusi pada dokumentasi TensorFlow

TensorFlow menerima kontribusi dokumentasi — jika Anda menyempurnakan dokumentasinya, Anda akan menyempurnakan library TensorFlow itu sendiri. Dokumentasi di tensorflow.org termasuk dalam kategori berikut:

Beberapa proyek TensorFlow menyimpan file sumber dokumentasi di dekat kode dalam repositori terpisah, biasanya dalam direktori docs/ . Lihat file CONTRIBUTING.md proyek atau hubungi pengelola untuk berkontribusi.

Untuk berpartisipasi dalam komunitas dokumen TensorFlow:

Referensi API

Untuk memperbarui dokumentasi referensi, temukan file sumber dan edit docstring simbol. Banyak halaman referensi API di tensorflow.org menyertakan link ke file sumber tempat simbol ditentukan. Docstrings mendukung penurunan harga dan dapat (kurang-lebih) pratinjau menggunakan pratinjau penurunan harga apa pun.

Untuk kualitas dokumentasi referensi dan cara terlibat dengan sprint dokumen dan komunitas, lihat saran Dokumen API TensorFlow 2 .

Versi dan cabang

Versi referensi API situs secara default menggunakan biner stabil terbaru — ini cocok dengan paket yang dipasang dengan pip install tensorflow .

Paket TensorFlow default dibuat dari cabang rX.x stabil di repo tensorflow / tensorflow utama. Dokumentasi referensi dihasilkan dari komentar kode dan dokumen dalam kode sumber untuk Python , C ++ , dan Java .

Versi sebelumnya dari dokumentasi TensorFlow tersedia sebagai cabang rX.x di repositori Dokumen TensorFlow. Cabang-cabang ini ditambahkan ketika versi baru dirilis.

Buat dokumen API

Referensi Python

Paket tensorflow_docs menyertakan generator untuk dokumen referensi Python API . Untuk memasang:

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

Untuk membuat dokumen referensi TensorFlow 2, gunakan 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

Dokumentasi naratif

Panduan dan tutorial TensorFlow ditulis sebagai file Markdown dan notebook Jupyter interaktif. Notebook dapat dijalankan di browser Anda menggunakan Google Colaboratory . Dokumen naratif di tensorflow.org dibuat dari cabang master tensorflow / docs . Versi yang lebih lama tersedia di GitHub di cabang rilis rX.x

Perubahan sederhana

Cara termudah untuk membuat pembaruan dokumentasi langsung ke file penurunan harga adalah dengan menggunakan editor file berbasis web GitHub. Jelajahi repositori tensorflow / docs untuk menemukan Penurunan harga yang kira-kira sesuai dengan struktur URL tensorflow.org . Di sudut kanan atas tampilan file, klik ikon pensil untuk membuka editor file. Edit file dan kemudian kirimkan permintaan penarikan baru.

Siapkan repo Git lokal

Untuk pengeditan multi-file atau pembaruan yang lebih kompleks, lebih baik menggunakan alur kerja Git lokal untuk membuat permintaan tarik.

Langkah-langkah Git berikut ini hanya diperlukan saat pertama kali Anda menyiapkan proyek lokal.

Garpu repo tensorflow / docs

Pada halaman GitHub tensorflow / docs , klik tombol Fork untuk membuat salinan repo Anda sendiri di bawah akun GitHub Anda. Setelah bercabang, Anda bertanggung jawab untuk selalu memperbarui salinan repo Anda dengan repo TensorFlow upstream.

Gandakan repo Anda

Download salinan remote username / docs repo ke komputer lokal Anda. Ini adalah direktori kerja tempat Anda akan membuat perubahan:

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

Tambahkan repo upstream agar tetap up-to-date (opsional)

Untuk menjaga repositori lokal Anda tetap sinkron dengan tensorflow/docs , tambahkan remote upstream untuk mendownload perubahan terbaru.

Tambahkan 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)

Untuk memperbaharui:

git checkout master
git pull upstream master

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

Alur kerja GitHub

1. Buat cabang baru

Setelah Anda memperbarui repo Anda dari tensorflow/docs , buat cabang baru dari cabang master lokal:

git checkout -b feature-name

git branch  # List local branches
  master

* feature-name

2. Lakukan perubahan

Edit file di editor favorit Anda dan ikuti panduan gaya dokumentasi TensorFlow .

Lakukan perubahan file Anda:

# 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."

Tambahkan lebih banyak komit, jika perlu.

3. Buat permintaan tarik

Unggah cabang lokal Anda ke repo GitHub jarak jauh Anda (github.com/ username / docs):

git push

Setelah push selesai, sebuah pesan mungkin menampilkan URL untuk secara otomatis mengirimkan permintaan pull ke repo upstream. Jika tidak, buka repo tensorflow / docs — atau repo Anda sendiri — dan GitHub akan meminta Anda untuk membuat pull request.

4. Review

Pemelihara dan kontributor lainnya akan meninjau permintaan penarikan Anda. Silakan berpartisipasi dalam diskusi dan lakukan perubahan yang diminta. Jika pull request Anda disetujui, pull request akan digabungkan ke repo dokumen TensorFlow upstream.

Ada langkah penerbitan terpisah untuk memperbarui tensorflow.org dari repo GitHub. Biasanya, perubahan dikelompokkan bersama dan situs diperbarui dengan irama reguler.

Buku catatan interaktif

Meskipun dimungkinkan untuk mengedit file JSON notebook dengan editor file berbasis web GitHub, itu tidak disarankan karena format JSON yang salah dapat merusak file. Pastikan untuk menguji notebook sebelum mengirimkan permintaan tarik.

Google Colaboratory adalah lingkungan notebook yang dihosting yang memudahkan untuk mengedit — dan menjalankan — dokumentasi notebook. Notebook di GitHub dimuat di Google Colab dengan meneruskan jalur ke URL Colab, misalnya, notebook yang terletak di GitHub di sini: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
dapat dimuat ke Google Colab di URL ini: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

Ada ekstensi Chrome Buka di Colab yang melakukan substitusi URL ini saat menjelajahi notebook di GitHub. Ini berguna saat membuka notebook di garpu repo Anda, karena tombol atas selalu tertaut ke cabang master Dokumen TensorFlow.

Pemformatan buku catatan

Alat pemformatan notebook membuat perbedaan sumber notebook Jupyter konsisten dan lebih mudah ditinjau. Karena lingkungan penulisan buku catatan berbeda dalam hal keluaran file, indentasi, metadata, dan bidang lain yang tidak ditentukan; nbfmt menggunakan default nbfmt dengan preferensi untuk alur kerja Colab dokumen TensorFlow. Untuk memformat notebook, instal alat notebook dokumen TensorFlow dan jalankan fitur 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 [...]

Untuk project dokumen TensorFlow, notebook tanpa sel output dijalankan dan diuji; buku catatan dengan sel keluaran yang disimpan diterbitkan sebagaimana adanya. nbfmt menghormati status notebook dan menggunakan opsi --remove_outputs untuk menghapus sel output secara eksplisit.

Untuk membuat notebook baru, salin dan edit template notebook dokumen TensorFlow .

Edit di Colab

Dalam lingkungan Google Colab, klik dua kali sel untuk mengedit blok teks dan kode. Sel teks menggunakan Markdown dan harus mengikuti panduan gaya dokumen TensorFlow .

Unduh file notebook dari Colab dengan File> Unduh .pynb . Komit file ini ke repo Git lokal Anda dan kirim permintaan penarikan.

Untuk membuat notebook baru, salin dan edit template notebook TensorFlow .

Alur kerja Colab-GitHub

Alih-alih mengunduh file notebook dan menggunakan alur kerja Git lokal, Anda dapat mengedit dan memperbarui repo GitHub bercabang Anda langsung dari Google Colab:

  1. Di repo username / dokumen bercabang Anda, gunakan UI web GitHub untuk membuat cabang baru .
  2. Arahkan ke file buku catatan untuk mengedit.
  3. Buka notebook di Google Colab: gunakan pertukaran URL atau Open in Colab Chrome extension.
  4. Edit buku catatan di Colab.
  5. Lakukan perubahan ke repo Anda dari Colab dengan File> Simpan salinan di GitHub .... Dialog penyimpanan harus terhubung ke repo dan cabang yang sesuai. Tambahkan pesan komit yang berarti.
  6. Setelah menyimpan, telusuri repo Anda atau repo tensorflow / docs , GitHub akan meminta Anda untuk membuat permintaan tarik.
  7. Permintaan penarikan ditinjau oleh pengelola.

Terjemahan

Tim TensorFlow bekerja dengan komunitas dan vendor untuk menyediakan terjemahan untuk tensorflow.org. Terjemahan buku catatan dan konten teknis lainnya ada di repo GitHub tensorflow / docs-l10n . Harap kirimkan permintaan penarikan melalui proyek TensorFlow GitLocalize .

Dokumen berbahasa Inggris adalah sumber kebenaran dan terjemahan harus mengikuti panduan ini sedekat mungkin. Meskipun demikian, terjemahan ditulis untuk komunitas yang mereka layani. Jika terminologi, ungkapan, gaya, atau nada bahasa Inggris tidak diterjemahkan ke bahasa lain, harap gunakan terjemahan yang sesuai untuk pembaca.

Dukungan bahasa ditentukan oleh sejumlah faktor termasuk — tetapi tidak terbatas pada — metrik dan permintaan situs, dukungan komunitas, kemahiran bahasa Inggris , preferensi audiens, dan indikator lainnya. Karena setiap bahasa yang didukung menimbulkan biaya, bahasa yang tidak dikelola akan dihapus. Dukungan untuk bahasa baru akan diumumkan di blog TensorFlow atau Twitter .

Jika bahasa pilihan Anda tidak didukung, Anda dipersilakan untuk mempertahankan garpu komunitas untuk kontributor open source. Ini tidak dipublikasikan ke tensorflow.org.