TensorFlow dokümantasyon katkılarını memnuniyetle karşılar; eğer dokümantasyonu geliştirirseniz TensorFlow kütüphanesinin kendisini de geliştirmiş olursunuz. tensorflow.org'daki belgeler aşağıdaki kategorilere ayrılır:
- API referansı —API referans belgeleri , TensorFlow kaynak kodundaki belge dizelerinden oluşturulur.
- Anlatı belgeleri —Bunlar öğreticiler , kılavuzlar ve TensorFlow kodunun parçası olmayan diğer yazılardır. Bu belgeler tensorflow/docs GitHub deposundadır.
- Topluluk çevirileri —Bunlar topluluk tarafından çevrilen kılavuzlar ve eğitimlerdir. Tüm topluluk çevirileri tensorflow/docs deposunda bulunur.
Bazı TensorFlow projeleri, dokümantasyon kaynak dosyalarını kodun yakınında ayrı bir depoda, genellikle bir
docs/ dizininde tutar. Projenin
CONTRIBUTING.md dosyasına bakın veya katkıda bulunmak için bakımcıyla iletişime geçin.
TensorFlow dokümanlar topluluğuna katılmak için:
API referansı
Ayrıntılar için TensorFlow API belgelerine katkıda bulunan kılavuzunu kullanın. Bu size kaynak dosyayı nasıl bulacağınızı ve sembolün docstring'ini nasıl düzenleyeceğinizi gösterir. tensorflow.org'daki birçok API referans sayfası, sembolün tanımlandığı kaynak dosyaya bir bağlantı içerir. Docstrings, Markdown'ı destekler ve herhangi bir Markdown önizleyicisi kullanılarak (yaklaşık olarak) önizlenebilir.
Sürümler ve dallar
Sitenin API referans sürümü varsayılan olarak en son kararlı ikili dosyadır; bu,
pip install tensorflow ile yüklenen paketle eşleşir.
Varsayılan TensorFlow paketi, ana tensorflow/tensorflow deposundaki kararlı dal
rX.x oluşturulmuştur. Referans belgeleri Python , C++ ve Java'nın kaynak kodundaki kod yorumlarından ve belge dizelerinden oluşturulur.
TensorFlow belgelerinin önceki sürümleri, TensorFlow Docs deposunda rX.x dalları olarak mevcuttur. Bu dallar 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/tools/docs/generate2.py betiğini 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ı dokümantasyonu
TensorFlow kılavuzları ve eğitimleri Markdown dosyaları ve etkileşimli Jupyter not defterleri olarak yazılmıştır. Not defterleri Google Colaboratory kullanılarak tarayıcınızda çalıştırılabilir. tensorflow.org'daki anlatım dokümanları tensorflow/docs
master dalından oluşturulmuştur. Daha eski sürümler GitHub'da
rX.x sürüm dallarında mevcuttur.
Basit değişiklikler
Markdown dosyalarında doğrudan belge güncellemeleri yapmanın en kolay yolu GitHub'un web tabanlı dosya düzenleyicisini kullanmaktır. Tensorflow.org URL yapısına kabaca karşılık gelen Markdown'ı bulmak için tensorflow/docs deposuna göz atın. Dosya görünümünün sağ üst köşesinde kalem simgesine 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, çekme isteği oluşturmak amacıyla yerel Git iş akışını kullanmak daha iyidir.
Aşağıdaki Git adımları yalnızca yerel bir projeyi ilk kez kurduğunuzda gereklidir.
Tensorflow/docs deposunu çatallayın
Tensorflow/docs GitHub sayfasında Çatal düğmesine tıklayın GitHub hesabınız altında kendi repo kopyanızı oluşturmak için. Çatallandıktan sonra repo kopyanızı yukarı akış TensorFlow deposuyla güncel tutmaktan siz sorumlusunuz.
Deponuzu klonlayın
Uzak username / docs deponuzun bir kopyasını yerel makinenize indirin. Bu, değişiklik yapacağınız çalışma dizinidir:
git clone email@example.com:username/docs
cd ./docs
Güncelliği korumak için bir yukarı akış deposu ekleyin (isteğe bağlı)
Yerel deponuzu
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 firstname.lastname@example.org:tensorflow/docs.git# View remote repos
git remote -vorigin email@example.com:username/docs.git (fetch) origin firstname.lastname@example.org:username/docs.git (push) upstream email@example.com:tensorflow/docs.git (fetch) upstream firstname.lastname@example.org: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
Deponuzu
tensorflow/docs güncelledikten sonra yerel ana daldan yeni bir dal oluşturun:
git checkout -b feature-name
git branch# List local branches master * feature-name
2. Değişiklik yapın
Dosyaları favori düzenleyicinizde düzenleyin ve lütfen TensorFlow dokümantasyon stil kılavuzunu takip edin.
Dosya değişikliğinizi tamamlayın:
# 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."
Gerektiğinde daha fazla taahhüt 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 isteği göndermek için bir URL görüntüleyebilir. Değilse tensorflow/docs deposuna veya kendi deponuza gidin; GitHub sizden bir çekme isteği oluşturmanızı isteyecektir.
4. İnceleme
Bakımcılar ve diğer katkıda bulunanlar çekme isteğinizi inceleyeceklerdir. Lütfen tartışmaya katılın ve istenen değişiklikleri yapın. Çekme isteğiniz onaylandığında, yukarı yöndeki TensorFlow docs deposuyla birleştirilecektir.
Tensorflow.org'u GitHub deposundan güncellemek için ayrı bir yayınlama adımı vardır. Genellikle değişiklikler bir araya toplanır ve site düzenli aralıklarla güncellenir.
Etkileşimli not defterleri
Dizüstü bilgisayar JSON dosyasını GitHub'un web tabanlı dosya düzenleyicisiyle düzenlemek mümkün olsa da, hatalı biçimlendirilmiş JSON dosyayı bozabileceğinden bu önerilmez. Çekme isteği 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 yolunu ileterek Google Colab'a yüklenir; örneğin GitHub'da bulunan not defteri burada: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /sınıflandırma.ipynb
şu URL'den Google Colab'a 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 değişikliğini gerçekleştiren Colab'da Aç Chrome uzantısı vardır. Bu, repo ç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çimlendirmesi
Bir not defteri biçimlendirme aracı, Jupyter not defteri kaynak farklılıklarını tutarlı hale getirir ve gözden geçirilmesini kolaylaştırır. Not defteri yazma ortamları dosya çıktısı, girinti, meta veriler ve belirtilmemiş diğer alanlara göre farklılık gösterdiğinden;
nbfmt TensorFlow docs Colab iş akışını tercih ederek 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 docs projeleri için çıktı hücreleri olmayan not defterleri yürütülür ve test edilir; Kayıtlı çıktı hücrelerine sahip not defterleri olduğu gibi yayınlanır.
nbfmt not defterinin 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ıp düzenleyin.
Colab'da düzenleyin
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 belgeleri stil kılavuzunu takip etmelidir.
Not defteri dosyalarını Colab'dan Dosya > İndir .pynb ile indirin. Bu dosyayı yerel Git deponuza kaydedin ve bir çekme isteği gönderin.
Yeni bir not defteri oluşturmak için TensorFlow not defteri şablonunu kopyalayıp düzenleyin.
Colab-GitHub iş akışı
Bir not defteri dosyası indirmek ve yerel bir Git iş akışı kullanmak yerine çatallı GitHub deponuzu doğrudan Google Colab'dan düzenleyebilir ve güncelleyebilirsiniz:
- Çatallı username /docs deponuzda, yeni bir şube oluşturmak için GitHub web kullanıcı arayüzünü kullanın.
- Düzenlemek için not defteri dosyasına gidin.
- Not defterini Google Colab'da açın: URL değiştirmeyi veya Colab'da Aç Chrome uzantısını kullanın.
- Not defterini Colab'da düzenleyin.
- Dosya > Bir kopyasını GitHub'a kaydet... ile Colab'dan deponuza değişiklikleri kaydedin. Kaydetme iletişim kutusu uygun repo ve şubeye bağlanmalıdır. Anlamlı bir taahhüt mesajı ekleyin.
- Kaydettikten sonra deponuza veya tensorflow/docs deposuna göz atın; GitHub sizden bir çekme isteği oluşturmanızı isteyecektir.
- Çekme isteği bakımcılar tarafından incelenir.
Çeviriler
TensorFlow ekibi, tensorflow.org için çeviriler sağlamak üzere topluluk ve satıcılarla birlikte çalışır. Not defterlerinin ve diğer teknik içeriklerin çevirileri tensorflow/docs-l10n GitHub deposunda bulunur. Lütfen çekme isteklerini TensorFlow GitLocalize projesi aracılığıyla gönderin.
İngilizce dokümanlar gerçeğin kaynağıdır ve çeviriler mümkün olduğunca bu kılavuzları takip etmelidir. Bununla birlikte çeviriler hizmet ettikleri topluluklar için yazılır. İngilizce terminoloji, ifadeler, üslup veya üslup başka bir dile çevrilmiyorsa lütfen okuyucuya uygun bir çeviri kullanın.
Dil desteği, site ölçümleri ve talep, topluluk desteği, İngilizce yeterliliği , hedef kitle tercihi ve diğer göstergeler dahil ancak bunlarla sınırlı olmamak üzere bir dizi faktöre göre belirlenir. Desteklenen her dilin bir maliyeti olduğundan bakımı yapılmayan diller kaldırılır. Yeni dil desteği TensorFlow blogunda veya Twitter'da duyurulacaktır.
Tercih ettiğiniz dil desteklenmiyorsa açık kaynak katkıda bulunanlar için bir topluluk çatalı oluşturabilirsiniz. Bunlar tensorflow.org'da yayınlanmaz.