TensorFlow प्रलेखन में योगदान करें

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

  • API संदर्भ — एपीआई संदर्भ दस्तावेज़ TensorFlow स्रोत कोड में docstrings से उत्पन्न होते हैं।
  • वर्णनात्मक दस्तावेज़ीकरण —ये ट्यूटोरियल , गाइड और अन्य लेखन हैं जो TensorFlow कोड का हिस्सा नहीं हैं। यह दस्तावेज़ tensorflow/docs GitHub रिपॉजिटरी में है।
  • सामुदायिक अनुवाद —ये समुदाय द्वारा अनुवादित मार्गदर्शक और ट्यूटोरियल हैं। सभी सामुदायिक अनुवाद tensorflow/docs रेपो में रहते हैं।

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

TensorFlow डॉक्स समुदाय में भाग लेने के लिए:

एपीआई संदर्भ

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

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

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

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

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

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

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

एक स्थानीय गिट रेपो सेट करें

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

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

टेंसरफ़्लो/दस्तावेज़ रेपो को फोर्क करें

Tensorflow/docs GitHub पेज पर, फोर्क बटन पर क्लिक करें अपने GitHub खाते के तहत अपनी खुद की रेपो कॉपी बनाने के लिए। एक बार फोर्क करने के बाद, आप अपस्ट्रीम TensorFlow रेपो के साथ अपनी रेपो कॉपी को अप-टू-डेट रखने के लिए जिम्मेदार हैं।

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

अपने दूरस्थ 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)

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

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.com/ username / डॉक्स ):

git push

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

4. समीक्षा

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

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

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

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

Google Colaboratory एक होस्टेड नोटबुक वातावरण है जो नोटबुक दस्तावेज़ों को संपादित करना और चलाना आसान बनाता है। 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

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

नोटबुक स्वरूपण

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

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

Colab-GitHub वर्कफ़्लो

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

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

अनुवाद

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

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

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

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