TensorFlow दस्तावेज़ में योगदान करें

TensorFlow दस्तावेज़ीकरण योगदान का स्वागत करता है—यदि आप दस्तावेज़ीकरण में सुधार करते हैं, तो आप TensorFlow लाइब्रेरी में ही सुधार करते हैं। Tensorflow.org पर दस्तावेज़ीकरण निम्नलिखित श्रेणियों में आता है:

कुछ TensorFlow प्रोजेक्ट दस्तावेज़ स्रोत फ़ाइलों को कोड के पास एक अलग रिपॉजिटरी में रखते हैं, आमतौर पर docs/ निर्देशिका में। प्रोजेक्ट की CONTRIBUTING.md फ़ाइल देखें या योगदान देने के लिए अनुरक्षक से संपर्क करें।

TensorFlow दस्तावेज़ समुदाय में भाग लेने के लिए:

एपीआई संदर्भ

विवरण के लिए, TensorFlow API डॉक्स योगदानकर्ता मार्गदर्शिका का उपयोग करें। यह आपको दिखाता है कि स्रोत फ़ाइल कैसे ढूंढें और प्रतीक की डॉकस्ट्रिंग को कैसे संपादित करें। Tensorflow.org पर कई एपीआई संदर्भ पृष्ठों में स्रोत फ़ाइल का एक लिंक शामिल होता है जहां प्रतीक को परिभाषित किया गया है। डॉकस्ट्रिंग्स मार्कडाउन का समर्थन करते हैं और किसी भी मार्कडाउन पूर्वावलोकनकर्ता का उपयोग करके (लगभग) पूर्वावलोकन किया जा सकता है।

संस्करण और शाखाएँ

साइट का एपीआई संदर्भ संस्करण नवीनतम स्थिर बाइनरी पर डिफ़ॉल्ट होता है - यह pip install tensorflow के साथ स्थापित पैकेज से मेल खाता है।

डिफ़ॉल्ट TensorFlow पैकेज मुख्य Tensorflow/tensorflow रेपो में स्थिर शाखा rX.x से बनाया गया है। संदर्भ दस्तावेज़ पायथन , सी++ और जावा के स्रोत कोड में कोड टिप्पणियों और डॉकस्ट्रिंग्स से तैयार किया गया है।

TensorFlow दस्तावेज़ के पिछले संस्करण TensorFlow डॉक्स रिपॉजिटरी में rX.x शाखाओं के रूप में उपलब्ध हैं। नया संस्करण जारी होने पर ये शाखाएँ जोड़ी जाती हैं।

एपीआई दस्तावेज़ बनाएँ

पायथन संदर्भ

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 गाइड और ट्यूटोरियल मार्कडाउन फ़ाइलों और इंटरैक्टिव ज्यूपिटर नोटबुक के रूप में लिखे गए हैं। नोटबुक को Google Colaboratory का उपयोग करके आपके ब्राउज़र में चलाया जा सकता है। Tensorflow.org पर कथा दस्तावेज़ Tensorflow/docs master शाखा से बनाए गए हैं। पुराने संस्करण GitHub में rX.x रिलीज़ शाखाओं पर उपलब्ध हैं।

साधारण परिवर्तन

मार्कडाउन फ़ाइलों में सीधे दस्तावेज़ीकरण अपडेट करने का सबसे आसान तरीका GitHub के वेब-आधारित फ़ाइल संपादक का उपयोग करना है। मार्कडाउन को खोजने के लिए टेंसरफ्लो/डॉक्स रिपॉजिटरी को ब्राउज़ करें जो मोटे तौर पर टेंसरफ्लो.ओआरजी यूआरएल संरचना से मेल खाता है। फ़ाइल दृश्य के ऊपरी दाएं कोने में, पेंसिल आइकन पर क्लिक करें फ़ाइल संपादक खोलने के लिए. फ़ाइल संपादित करें और फिर एक नया पुल अनुरोध सबमिट करें।

एक स्थानीय Git रेपो स्थापित करें

मल्टी-फ़ाइल संपादन या अधिक जटिल अपडेट के लिए, पुल अनुरोध बनाने के लिए स्थानीय Git वर्कफ़्लो का उपयोग करना बेहतर है।

निम्नलिखित Git चरणों की आवश्यकता केवल तब होती है जब आप पहली बार कोई स्थानीय प्रोजेक्ट सेट करते हैं।

टेंसरफ्लो/डॉक्स रेपो को फोर्क करें

टेंसरफ़्लो/डॉक्स GitHub पृष्ठ पर, फ़ोर्क बटन पर क्लिक करें अपने GitHub खाते के अंतर्गत अपनी स्वयं की रेपो कॉपी बनाने के लिए। एक बार फोर्क हो जाने पर, आप अपनी रेपो कॉपी को अपस्ट्रीम टेन्सरफ्लो रेपो के साथ अद्यतन रखने के लिए जिम्मेदार हैं।

अपने रेपो को क्लोन करें

अपने दूरस्थ username /दस्तावेज़ रेपो की एक प्रति अपनी स्थानीय मशीन पर डाउनलोड करें। यह कार्यशील निर्देशिका है जहां आप परिवर्तन करेंगे:

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

अप-टू-डेट रखने के लिए एक अपस्ट्रीम रेपो जोड़ें (वैकल्पिक)

अपने स्थानीय रिपॉजिटरी को 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. एक नई शाखा बनाएँ

अपने रेपो को 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. एक पुल अनुरोध बनाएं

अपनी स्थानीय शाखा को अपने दूरस्थ GitHub रेपो (github.com/ username /docs) पर अपलोड करें:

git push

पुश पूरा होने के बाद, एक संदेश अपस्ट्रीम रेपो को स्वचालित रूप से पुल अनुरोध सबमिट करने के लिए एक यूआरएल प्रदर्शित कर सकता है। यदि नहीं, तो टेंसरफ्लो/डॉक्स रेपो-या अपने स्वयं के रेपो पर जाएं- और GitHub आपको एक पुल अनुरोध बनाने के लिए संकेत देगा।

4. समीक्षा

अनुरक्षक और अन्य योगदानकर्ता आपके पुल अनुरोध की समीक्षा करेंगे। कृपया चर्चा में भाग लें और अनुरोधित परिवर्तन करें। जब आपका पुल अनुरोध स्वीकृत हो जाएगा, तो इसे अपस्ट्रीम TensorFlow डॉक्स रेपो में विलय कर दिया जाएगा।

GitHub रेपो से Tensorflow.org को अपडेट करने के लिए एक अलग प्रकाशन चरण है। आमतौर पर, परिवर्तन एक साथ बैच किए जाते हैं और साइट को नियमित ताल पर अपडेट किया जाता है।

इंटरैक्टिव नोटबुक

हालाँकि GitHub के वेब-आधारित फ़ाइल संपादक के साथ नोटबुक JSON फ़ाइल को संपादित करना संभव है, लेकिन इसकी अनुशंसा नहीं की जाती है क्योंकि विकृत JSON फ़ाइल को दूषित कर सकता है। पुल अनुरोध सबमिट करने से पहले नोटबुक का परीक्षण करना सुनिश्चित करें।

Google Colaborator एक होस्ट किया गया नोटबुक वातावरण है जो नोटबुक दस्तावेज़ को संपादित करना और चलाना आसान बनाता है। GitHub में नोटबुक को Colab URL पर पथ पास करके Google Colab में लोड किया जाता है, उदाहरण के लिए, GitHub में स्थित नोटबुक यहां: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /classification.ipynb
इस URL पर Google Colab में लोड किया जा सकता है: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

कोलाब क्रोम एक्सटेंशन में एक ओपन है जो GitHub पर नोटबुक ब्राउज़ करते समय इस URL प्रतिस्थापन को निष्पादित करता है। यह आपके रेपो फोर्क में नोटबुक खोलते समय उपयोगी होता है, क्योंकि शीर्ष बटन हमेशा TensorFlow डॉक्स master शाखा से लिंक होते हैं।

नोटबुक फ़ॉर्मेटिंग

एक नोटबुक फ़ॉर्मेटिंग टूल ज्यूपिटर नोटबुक स्रोत को सुसंगत और समीक्षा करने में आसान बनाता है। चूँकि फ़ाइल आउटपुट, इंडेंटेशन, मेटाडेटा और अन्य गैर-निर्दिष्ट फ़ील्ड के संबंध में नोटबुक संलेखन वातावरण भिन्न होते हैं; 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 डॉक्स नोटबुक टेम्पलेट को कॉपी और संपादित करें।

कोलाब में संपादित करें

Google Colab परिवेश में, टेक्स्ट और कोड ब्लॉक को संपादित करने के लिए सेल पर डबल-क्लिक करें। टेक्स्ट सेल मार्कडाउन का उपयोग करते हैं और उन्हें TensorFlow डॉक्स स्टाइल गाइड का पालन करना चाहिए।

फ़ाइल > डाउनलोड .pynb के साथ कोलाब से नोटबुक फ़ाइलें डाउनलोड करें। इस फ़ाइल को अपने स्थानीय Git रेपो में जमा करें और एक पुल अनुरोध भेजें।

एक नई नोटबुक बनाने के लिए, TensorFlow नोटबुक टेम्पलेट को कॉपी और संपादित करें।

कोलाब-गिटहब वर्कफ़्लो

नोटबुक फ़ाइल डाउनलोड करने और स्थानीय Git वर्कफ़्लो का उपयोग करने के बजाय, आप सीधे Google Colab से अपने फोर्क किए गए GitHub रेपो को संपादित और अपडेट कर सकते हैं:

  1. अपने फोर्कड username /docs रेपो में, एक नई शाखा बनाने के लिए GitHub वेब UI का उपयोग करें।
  2. संपादित करने के लिए नोटबुक फ़ाइल पर नेविगेट करें।
  3. Google Colab में नोटबुक खोलें: URL स्वैप या Open in Colab Chrome एक्सटेंशन का उपयोग करें।
  4. कोलाब में नोटबुक संपादित करें.
  5. फ़ाइल > GitHub में एक प्रति सहेजें... के साथ Colab से अपने रेपो में परिवर्तन करें। सेव डायलॉग को उचित रेपो और शाखा से लिंक होना चाहिए। एक सार्थक प्रतिबद्ध संदेश जोड़ें.
  6. सहेजने के बाद, अपने रेपो या टेंसरफ्लो/डॉक्स रेपो पर ब्राउज़ करें, GitHub आपको एक पुल अनुरोध बनाने के लिए संकेत देगा।
  7. पुल अनुरोध की समीक्षा अनुरक्षकों द्वारा की जाती है।

अनुवाद

TensorFlow टीम, Tensorflow.org के लिए अनुवाद प्रदान करने के लिए समुदाय और विक्रेताओं के साथ काम करती है। नोटबुक और अन्य तकनीकी सामग्री के अनुवाद Tensorflow/docs-l10n GitHub रेपो में स्थित हैं। कृपया TensorFlow GitLocalize प्रोजेक्ट के माध्यम से पुल अनुरोध सबमिट करें।

अंग्रेजी दस्तावेज़ सत्य का स्रोत हैं और अनुवादों को यथासंभव इन दिशानिर्देशों का पालन करना चाहिए। जैसा कि कहा गया है, अनुवाद उन समुदायों के लिए लिखे जाते हैं जिनकी वे सेवा करते हैं। यदि अंग्रेजी शब्दावली, वाक्यांश, शैली या लहजा किसी अन्य भाषा में अनुवादित नहीं होता है, तो कृपया पाठक के लिए उपयुक्त अनुवाद का उपयोग करें।

भाषा समर्थन कई कारकों द्वारा निर्धारित किया जाता है, जिनमें साइट मेट्रिक्स और मांग, सामुदायिक समर्थन, अंग्रेजी दक्षता , दर्शकों की प्राथमिकता और अन्य संकेतक शामिल हैं, लेकिन इन्हीं तक सीमित नहीं हैं। चूँकि प्रत्येक समर्थित भाषा पर लागत लगती है, अप्रयुक्त भाषाओं को हटा दिया जाता है। नई भाषाओं के लिए समर्थन की घोषणा TensorFlow ब्लॉग या ट्विटर पर की जाएगी।

यदि आपकी पसंदीदा भाषा समर्थित नहीं है, तो ओपन सोर्स योगदानकर्ताओं के लिए सामुदायिक कांटा बनाए रखने के लिए आपका स्वागत है। इन्हें Tensorflow.org पर प्रकाशित नहीं किया गया है।