Google is committed to advancing racial equity for Black communities. See how.

TensorFlow belgelerine katkıda bulunun

TensorFlow, dokümantasyon katkılarını memnuniyetle karşılar - dokümantasyonu geliştirirseniz, TensorFlow kütüphanesinin kendisini geliştirmiş olursunuz. Tensorflow.org'daki belgeler aşağıdaki kategorilere ayrılır:

Bazı TensorFlow projeleri , belge kaynak dosyalarını kodun yakınında, genellikle bir docs/ dizinde olmak üzere ayrı bir depoda tutar. Katkıda bulunmak için projenin CONTRIBUTING.md dosyasına bakın veya geliştiriciyle iletişime geçin.

TensorFlow dokümanlar topluluğuna katılmak için:

API referansı

Referans belgelerini güncellemek için kaynak dosyayı bulun ve sembolün belge dizesini düzenleyin. Tensorflow.org'daki birçok API referans sayfası, sembolün tanımlandığı kaynak dosyaya bir bağlantı içerir. Docstrings, Markdown'u destekler ve (yaklaşık olarak) herhangi bir Markdown önizleyicisi kullanılarak önizlenebilir .

Referans dokümantasyon kalitesi ve doc sprintlerine ve topluluğa nasıl dahil olacağınız için TensorFlow 2 API Docs tavsiyesine bakın .

Sürümler ve dallar

Sitenin API referans sürümü varsayılan olarak en son kararlı ikili pip install tensorflow - bu, pip install tensorflow ile yüklenen paketle pip install tensorflow .

Varsayılan TensorFlow paketi, ana tensorflow / tensorflow deposundaki rX.x kararlı dalından rX.x . Referans dokümantasyon Python , C ++ ve Java için kaynak kodundaki kod yorumlarından ve doküman dizilerinden üretilir.

TensorFlow belgelerinin önceki sürümleri, TensorFlow Docs deposunda rX.x dalları olarak mevcuttur. Bu şubeler, yeni bir sürüm yayınlandığında eklenir.

API belgeleri oluşturun

Python referansı

tensorflow_docs paketi, Python API referans belgeleri için oluşturucuyu içerir . Yüklemek:

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

TensorFlow 2 referans belgelerini oluşturmak için tensorflow tensorflow/tools/docs/generate2.py komut dosyasını kullanın:

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

Anlatım belgeleri

TensorFlow kılavuzları ve eğitimleri Markdown dosyaları ve etkileşimli Jupyter not defterleri olarak yazılmıştır. Defterler, Google Colaboratory kullanılarak tarayıcınızda çalıştırılabilir. Tensorflow.org'daki anlatı belgeleri, tensorflow / docs master dalından oluşturulmuştur. Daha eski sürümler, rX.x sürüm dallarındaki GitHub'da mevcuttur.

Basit değişiklikler

Markdown dosyalarında basit belge güncellemeleri yapmanın en kolay yolu GitHub'ın web tabanlı dosya düzenleyicisini kullanmaktır . Kabaca tensorflow.org URL yapısına karşılık gelen Markdown'u bulmak için tensorflow / docs havuzuna göz atın. Dosya görünümünün sağ üst köşesindeki kalem simgesini tıklayın. dosya düzenleyiciyi açmak için. Dosyayı düzenleyin ve ardından yeni bir çekme isteği gönderin.

Yerel bir Git deposu kurun

Çoklu dosya düzenlemeleri veya daha karmaşık güncellemeler için, bir çekme isteği oluşturmak üzere yerel bir Git iş akışı kullanmak daha iyidir.

Aşağıdaki Git adımları yalnızca yerel bir projeyi ilk kurduğunuzda gereklidir.

Tensorflow / docs deposunu çatallayın

Tensorflow / docs GitHub sayfasında, Çatal düğmesini tıklayın GitHub hesabınız altında kendi repo kopyanızı oluşturmak için. Bir kez çatallandıktan sonra, repo kopyanızı yukarı akış TensorFlow deposu ile güncel tutmaktan sorumlusunuz.

Deponuzu klonlayın

Uzaktan bir kopyasını indirin username / docs yerel makineye Repo. Bu, değişiklik yapacağınız çalışma dizinidir:

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

Güncel tutmak için bir yukarı akış repo ekleyin (isteğe bağlı)

Yerel tensorflow/docs ile senkronize tutmak için, en son değişiklikleri indirmek üzere bir yukarı akış uzaktan kumandası ekleyin.

Uzaktan kumanda ekleyin:

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)

Güncellemek için:

git checkout master
git pull upstream master

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

GitHub iş akışı

1. Yeni bir şube oluşturun

tensorflow/docs güncelledikten sonra, yerel ana şubeden yeni bir şube oluşturun:

git checkout -b feature-name

git branch  # List local branches
  master

* feature-name

2. Değişiklikler yapın

Dosyaları en sevdiğiniz düzenleyicide düzenleyin ve lütfen TensorFlow dokümantasyon stil kılavuzunu izleyin.

Dosya değişikliğinizi işleyin:

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

Gerekirse daha fazla kaydetme ekleyin.

3. Bir çekme isteği oluşturun

Yerel şubenizi uzak GitHub deponuza yükleyin (github.com/ username / docs):

git push

Push tamamlandıktan sonra, bir mesaj yukarı akış deposuna otomatik olarak bir çekme talebi göndermek için bir URL görüntüleyebilir. Değilse, tensorflow / docs deposuna - veya kendi deponuza - gidin ve GitHub sizden bir çekme isteği oluşturmanızı isteyecektir.

4. Gözden geçirin

Bakımcılar ve diğer katkıda bulunanlar, çekme talebinizi inceleyecek. Lütfen tartışmaya katılın ve istenen değişiklikleri yapın. Çekme talebiniz onaylandığında, yukarı akış TensorFlow belge deposuyla birleştirilecektir.

GitHub deposundan tensorflow.org'u güncellemek için ayrı bir yayınlama adımı vardır. Tipik olarak, değişiklikler bir araya toplanır ve site düzenli bir tempo ile güncellenir.

Etkileşimli defterler

Not defteri JSON dosyasını GitHub'ın web tabanlı dosya düzenleyicisiyle düzenlemek mümkün olsa da, hatalı biçimlendirilmiş JSON dosyayı bozabileceğinden önerilmez. Bir çekme talebi göndermeden önce dizüstü bilgisayarı test ettiğinizden emin olun.

Google Colaboratory , not defteri belgelerini düzenlemeyi ve çalıştırmayı kolaylaştıran, barındırılan bir not defteri ortamıdır. GitHub'daki not defterleri, Colab URL'sinin yolu iletilerek Google Colab'a yüklenir, örneğin, GitHub'da bulunan not defteri: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
Google Colab'a şu URL'den yüklenebilir: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

GitHub'da bir not defterine göz atarken bu URL ikamesini gerçekleştiren bir Colab'da Aç Chrome uzantısı vardır. Bu, depo çatalınızda bir not defteri açarken kullanışlıdır, çünkü üst düğmeler her zaman TensorFlow Docs master dalına bağlanır.

Not defteri biçimlendirme

Bir not defteri biçimlendirme aracı, Jupyter not defteri kaynak farklılıklarının tutarlı olmasını ve incelenmesini kolaylaştırır. Not defteri geliştirme ortamları dosya çıktısı, girinti, meta veriler ve diğer belirtilmemiş alanlar açısından farklılık gösterdiğinden; nbfmt , TensorFlow belgeleri Colab iş akışı tercihiyle birlikte görüşlü varsayılanları kullanır. Bir not defterini biçimlendirmek için TensorFlow docs not defteri araçlarını yükleyin ve nbfmt aracını çalıştırın:

# 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 belge projeleri için, çıktı hücreleri olmayan dizüstü bilgisayarlar yürütülür ve test edilir; Kaydedilmiş çıkış hücrelerine sahip not defterleri olduğu gibi yayınlanır. nbfmt , not defteri durumuna saygı duyar ve çıktı hücrelerini açıkça kaldırmak için --remove_outputs seçeneğini kullanır.

Yeni bir not defteri oluşturmak için TensorFlow belgeleri not defteri şablonunu kopyalayın ve düzenleyin.

Colab'de düzenle

Google Colab ortamında, metin ve kod bloklarını düzenlemek için hücreleri çift tıklayın. Metin hücreleri Markdown kullanır ve TensorFlow dokümanları stil kılavuzunu izlemelidir .

Not defteri dosyalarını Colab'den Dosya> .pynb indir . Bu dosyayı yerel Git deponuza işleyin ve bir çekme isteği gönderin.

Yeni bir not defteri oluşturmak için TensorFlow not defteri şablonunu kopyalayın ve düzenleyin.

Colab-GitHub iş akışı

Bir not defteri dosyası indirmek ve yerel Git iş akışı kullanmak yerine çatallı GitHub kod deponuzu doğrudan Google Colab'den düzenleyebilir ve güncelleyebilirsiniz:

  1. Çatallı username / dokümanlar deponuzda, yeni bir dal oluşturmak için GitHub web kullanıcı arayüzünü kullanın.
  2. Düzenlemek için not defteri dosyasına gidin.
  3. Not defterini Google Colab'de açın: URL değişimini veya Colab'da Aç Chrome uzantısını kullanın.
  4. Not defterini Colab'da düzenleyin.
  5. Dosya> GitHub'a bir kopyasını kaydet ... ile Colab'den deponuzdaki değişiklikleri gerçekleştirin. Kaydet iletişim kutusu uygun depoya ve şubeye bağlanmalıdır. Anlamlı bir kaydetme mesajı ekleyin.
  6. Kaydettikten sonra, deponuza veya tensorflow / docs deposuna göz atın, GitHub sizden bir çekme isteği oluşturmanızı istemelidir.
  7. Çekme talebi bakımcılar tarafından incelenir.

Çeviriler

TensorFlow ekibi, tensorflow.org'a çeviriler sağlamak için topluluk ve satıcılarla birlikte çalışır. Defterlerin çevirileri ve diğer teknik içerik tensorflow / docs-l10n GitHub deposunda bulunmaktadır . Lütfen TensorFlow GitLocalize projesi aracılığıyla çekme istekleri gönderin.

İngilizce dokümanlar gerçeğin kaynağıdır ve çeviriler bu kılavuzları olabildiğince yakından takip etmelidir. Bununla birlikte, çeviriler hizmet verdikleri topluluklar için yazılır. İngilizce terminoloji, ifade biçimi, üslup veya üslup başka bir dile çevrilmiyorsa, lütfen okuyucuya uygun bir çeviri kullanın.

Dil desteği, site ölçümleri ve talebi, topluluk desteği, İngilizce yeterliliği , hedef kitle tercihi ve diğer göstergeler dahil ancak bunlarla sınırlı olmayan bir dizi faktör tarafından belirlenir. Desteklenen her dil bir ücrete tabi olduğundan, bakılmayan diller kaldırılır. Yeni diller için destek TensorFlow blogunda veya Twitter'da duyurulacak.

Tercih ettiğiniz dil desteklenmiyorsa, açık kaynak katılımcılar için bir topluluk çatalı tutabilirsiniz. Bunlar tensorflow.org'da yayınlanmamaktadır.