Google is committed to advancing racial equity for Black communities. See how.
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

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

TensorFlow प्रलेखन योगदान का स्वागत करता है - यदि आप प्रलेखन में सुधार करते हैं, तो आप TensorFlow पुस्तकालय में सुधार करते हैं। Tenorflow.org पर प्रलेखन निम्नलिखित श्रेणियों में आता है:

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

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

एपीआई संदर्भ

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

संदर्भ प्रलेखन गुणवत्ता और डॉक स्प्रिंट और समुदाय के साथ कैसे जुड़ना है , इसके लिए TensorFlow 2 API डॉक्स सलाह देखें

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

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

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

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

एपीआई डॉक्स का निर्माण

अजगर का संदर्भ

tensorflow_docs पैकेज में पायथन एपीआई संदर्भ डॉक्स के लिए जनरेटर शामिल है। स्थापित करने के लिए:

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

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

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

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

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

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

दसवें प्रवाह / डॉक्स रेपो को कांटा

टेनसफ़्लो / डॉक्स गिटहब पृष्ठ पर, फोर्क बटन पर क्लिक करें अपने 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)

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 / डॉक्स) के लिए अपनी स्थानीय शाखा अपलोड करें:

git push

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

4. समीक्षा करें

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

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

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

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

Google कोलैबोरेटरी एक होस्टेड नोटबुक वातावरण है जो नोटबुक प्रलेखन को संपादित करना और चलाना आसान बनाता है। 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 प्रतिस्थापन को करने वाले Colab Chrome एक्सटेंशन में एक ओपन होता है। आपके रेपो फोर्क में नोटबुक खोलने के दौरान यह उपयोगी है, क्योंकि शीर्ष बटन हमेशा TensorFlow डॉक्स master शाखा से लिंक होते हैं।

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

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

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

सामुदायिक अनुवाद

TensorFlow को पूरे विश्व में सुलभ बनाने के लिए सामुदायिक अनुवाद एक शानदार तरीका है। अनुवाद को अपडेट करने के लिए, भाषा निर्देशिका में एक फ़ाइल ढूंढें या जोड़ें जो en/ निर्देशिका की समान निर्देशिका संरचना से मेल खाती है। अंग्रेजी डॉक्स स्रोत-ऑफ-ट्रुथ हैं और अनुवाद को इन गाइडों का यथासंभव अनुसरण करना चाहिए। उन्होंने कहा, अनुवाद उन समुदायों के लिए लिखे जाते हैं जिनकी वे सेवा करते हैं। यदि अंग्रेजी शब्दावली, वाक्यांश, शैली, या स्वर दूसरी भाषा में अनुवाद नहीं करते हैं, तो कृपया पाठक के लिए उपयुक्त अनुवाद का उपयोग करें।

भाषा-विशिष्ट डॉक्स समूह हैं जो अनुवाद योगदानकर्ताओं के लिए व्यवस्थित करना आसान बनाते हैं। कृपया शामिल हों यदि आप एक लेखक, समीक्षक हैं, या समुदाय के लिए TensorFlow.org सामग्री बनाने में रुचि रखते हैं:

सूचनाओं की समीक्षा करें

सभी दस्तावेज़ीकरण अपडेट के लिए समीक्षा की आवश्यकता होती है। TensorFlow अनुवाद समुदायों के साथ और अधिक कुशलता से सहयोग करने के लिए, यहां भाषा-विशिष्ट गतिविधि के शीर्ष पर रखने के कुछ तरीके दिए गए हैं:

  • किसी भी बनाए गए पुल अनुरोध के लिए एक ईमेल प्राप्त करने के लिए ऊपर सूचीबद्ध भाषा समूह में शामिल हों जो उस भाषा के लिए site/ lang डायरेक्टरी को छूता है।
  • अपने GitHub उपयोगकर्ता नाम को site/<lang>/REVIEWERS जोड़ें site/<lang>/REVIEWERS फ़ाइल एक पुल अनुरोध में स्वचालित रूप से टिप्पणी-टैग करने के लिए। जब टिप्पणी-टैग किया जाता है, तो GitHub आपको उस पुल अनुरोध में सभी परिवर्तनों और चर्चा के लिए सूचनाएं भेजेगा।

अनुवाद में कोड अप-टू-डेट रखें

TensorFlow जैसी ओपन सोर्स परियोजना के लिए, प्रलेखन को अद्यतित रखना चुनौतीपूर्ण है। समुदाय के साथ बात करने के बाद, अनुवादित सामग्री के पाठक उस पाठ को सहन करेंगे जो थोड़ा पुराना है, लेकिन आउट-ऑफ-डेट कोड निराशाजनक है। कोड को सिंक में रखना आसान बनाने के लिए, अनुवादित नोटबुक के लिए nb-code-सिंक टूल का उपयोग करें:

./tools/nb_code_sync.py [--lang=en] site/lang/notebook.ipynb

यह स्क्रिप्ट एक भाषा नोटबुक की कोड कोशिकाओं को पढ़ती है और इसे अंग्रेजी संस्करण के खिलाफ जांचती है। टिप्पणियों को अलग करने के बाद, यह कोड ब्लॉक की तुलना करता है और यदि वे अलग हैं तो भाषा नोटबुक को अपडेट करता है। यह उपकरण विशेष रूप से एक इंटरैक्टिव git वर्कफ़्लो के साथ उपयोगी है जो फ़ाइल का उपयोग कर git add --patch site/lang/notebook.ipynb लिए प्रतिबद्ध है: git add --patch site/lang/notebook.ipynb