TensorFlow ডকুমেন্টেশনে অবদান রাখুন

টেনসরফ্লো ডকুমেন্টেশন অবদানকে স্বাগত জানায়—যদি আপনি ডকুমেন্টেশন উন্নত করেন, তাহলে আপনি টেনসরফ্লো লাইব্রেরি নিজেই উন্নত করবেন। tensorflow.org-এ ডকুমেন্টেশন নিম্নলিখিত বিভাগে পড়ে:

কিছু TensorFlow প্রজেক্ট ডকুমেন্টেশন সোর্স ফাইলগুলিকে কোডের কাছে একটি পৃথক সংগ্রহস্থলে রাখে, সাধারণত একটি docs/ ডিরেক্টরিতে। প্রকল্পের CONTRIBUTING.md ফাইলটি দেখুন বা অবদান রাখতে রক্ষণাবেক্ষণকারীর সাথে যোগাযোগ করুন৷

TensorFlow ডক্স সম্প্রদায়ে অংশগ্রহণ করতে:

API রেফারেন্স

বিস্তারিত জানার জন্য, TensorFlow API ডক্স কন্ট্রিবিউটর গাইড ব্যবহার করুন। এটি আপনাকে দেখায় কিভাবে উৎস ফাইল খুঁজে বের করতে হয় এবং প্রতীকের ডকস্ট্রিং সম্পাদনা করতে হয়। tensorflow.org-এর অনেক API রেফারেন্স পৃষ্ঠায় উৎস ফাইলের একটি লিঙ্ক রয়েছে যেখানে প্রতীকটি সংজ্ঞায়িত করা হয়েছে। Docstrings মার্কডাউন সমর্থন করে এবং যেকোন মার্কডাউন প্রিভিউয়ার ব্যবহার করে (প্রায়) পূর্বরূপ দেখা যেতে পারে।

সংস্করণ এবং শাখা

সাইটের API রেফারেন্স সংস্করণটি সর্বশেষ স্থিতিশীল বাইনারিতে ডিফল্ট হয়—এটি pip install tensorflow এর সাথে ইনস্টল করা প্যাকেজের সাথে মেলে।

ডিফল্ট টেনসরফ্লো প্যাকেজটি মূল টেনসরফ্লো/টেনসরফ্লো রেপোতে স্থিতিশীল শাখা rX.x থেকে তৈরি করা হয়েছে। রেফারেন্স ডকুমেন্টেশনটি পাইথন , C++ এবং Java এর জন্য সোর্স কোডের কোড মন্তব্য এবং ডকস্ট্রিং থেকে তৈরি করা হয়।

TensorFlow ডকুমেন্টেশনের পূর্ববর্তী সংস্করণগুলি TensorFlow ডক্স রিপোজিটরিতে rX.x শাখা হিসাবে উপলব্ধ। একটি নতুন সংস্করণ প্রকাশিত হলে এই শাখাগুলি যোগ করা হয়।

API ডক্স তৈরি করুন

পাইথন রেফারেন্স

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

বর্ণনামূলক ডকুমেন্টেশন

টেনসরফ্লো গাইড এবং টিউটোরিয়ালগুলি মার্কডাউন ফাইল এবং ইন্টারেক্টিভ জুপিটার নোটবুক হিসাবে লেখা হয়। Google Colaboratory ব্যবহার করে আপনার ব্রাউজারে নোটবুক চালানো যেতে পারে। tensorflow.org- এর ন্যারেটিভ ডক্স tensorflow/docs master শাখা থেকে তৈরি করা হয়েছে। পুরানো সংস্করণগুলি rX.x রিলিজ শাখাগুলিতে GitHub-এ উপলব্ধ।

সহজ পরিবর্তন

মার্কডাউন ফাইলগুলিতে সহজবোধ্য ডকুমেন্টেশন আপডেট করার সবচেয়ে সহজ উপায় হল GitHub-এর ওয়েব-ভিত্তিক ফাইল সম্পাদক ব্যবহার করা। Markdown খুঁজে পেতে tensorflow/docs সংগ্রহস্থল ব্রাউজ করুন যা মোটামুটি tensorflow.org URL কাঠামোর সাথে মিলে যায়। ফাইল ভিউয়ের উপরের ডানদিকের কোণায়, পেন্সিল আইকনে ক্লিক করুন ফাইল এডিটর খুলতে। ফাইলটি সম্পাদনা করুন এবং তারপরে একটি নতুন পুল অনুরোধ জমা দিন।

একটি স্থানীয় গিট রেপো সেট আপ করুন

মাল্টি-ফাইল সম্পাদনা বা আরও জটিল আপডেটের জন্য, একটি পুল অনুরোধ তৈরি করতে একটি স্থানীয় গিট ওয়ার্কফ্লো ব্যবহার করা ভাল।

নিম্নলিখিত গিট পদক্ষেপগুলি শুধুমাত্র প্রথমবার আপনি একটি স্থানীয় প্রকল্প সেট আপ করতে হবে।

টেনসরফ্লো/ডক্স রেপো ফোর্ক করুন

টেনসরফ্লো/ডক্স গিটহাব পৃষ্ঠায়, ফর্ক বোতামে ক্লিক করুন আপনার 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. পরিবর্তন করুন

আপনার প্রিয় সম্পাদকে ফাইলগুলি সম্পাদনা করুন এবং অনুগ্রহ করে টেনসরফ্লো ডকুমেন্টেশন শৈলী নির্দেশিকা অনুসরণ করুন৷

আপনার ফাইল পরিবর্তন করুন:

# 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

পুশ সম্পূর্ণ হওয়ার পরে, আপস্ট্রিম রেপোতে স্বয়ংক্রিয়ভাবে একটি পুল অনুরোধ জমা দেওয়ার জন্য একটি বার্তা একটি URL প্রদর্শন করতে পারে। যদি তা না হয়, টেনসরফ্লো/ডক্স রেপোতে যান—অথবা আপনার নিজের রেপো—এবং গিটহাব আপনাকে একটি পুল অনুরোধ তৈরি করতে অনুরোধ করবে।

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

একটি Open in Colab Chrome এক্সটেনশন রয়েছে যা GitHub-এ একটি নোটবুক ব্রাউজ করার সময় এই ইউআরএল প্রতিস্থাপন করে। আপনার রেপো ফর্কে একটি নোটবুক খোলার সময় এটি কার্যকর, কারণ উপরের বোতামগুলি সর্বদা টেনসরফ্লো ডক্স 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 ডক্স নোটবুক টেমপ্লেটটি অনুলিপি করুন এবং সম্পাদনা করুন৷

Colab-এ সম্পাদনা করুন

Google Colab এনভায়রনমেন্টের মধ্যে, টেক্সট এবং কোড ব্লক এডিট করতে সেলগুলিতে ডাবল-ক্লিক করুন। টেক্সট সেল মার্কডাউন ব্যবহার করে এবং TensorFlow ডক্স স্টাইল গাইড অনুসরণ করা উচিত।

ফাইল দিয়ে Colab থেকে নোটবুক ফাইল ডাউনলোড করুন > ডাউনলোড .pynb । এই ফাইলটি আপনার স্থানীয় গিট রেপোতে পাঠান এবং একটি পুল অনুরোধ পাঠান।

একটি নতুন নোটবুক তৈরি করতে, TensorFlow নোটবুক টেমপ্লেটটি অনুলিপি করুন এবং সম্পাদনা করুন।

Colab-GitHub ওয়ার্কফ্লো

একটি নোটবুক ফাইল ডাউনলোড করার পরিবর্তে এবং একটি স্থানীয় গিট ওয়ার্কফ্লো ব্যবহার করার পরিবর্তে, আপনি সরাসরি Google Colab থেকে আপনার কাঁটাযুক্ত গিটহাব রেপো সম্পাদনা এবং আপডেট করতে পারেন:

  1. আপনার কাঁটাযুক্ত username /ডক্স রেপোতে, একটি নতুন শাখা তৈরি করতে GitHub ওয়েব UI ব্যবহার করুন।
  2. সম্পাদনা করতে নোটবুক ফাইলে নেভিগেট করুন।
  3. Google Colab-এ নোটবুক খুলুন: ইউআরএল সোয়াপ বা ওপেন ইন কোলাব ক্রোম এক্সটেনশন ব্যবহার করুন।
  4. Colab-এ নোটবুক এডিট করুন।
  5. ফাইল দিয়ে Colab থেকে আপনার রেপোতে পরিবর্তনগুলি করুন > GitHub-এ একটি কপি সেভ করুন...। সংরক্ষণ ডায়ালগটি উপযুক্ত রেপো এবং শাখার সাথে লিঙ্ক করা উচিত। একটি অর্থপূর্ণ প্রতিশ্রুতি বার্তা যোগ করুন.
  6. সংরক্ষণ করার পরে, আপনার রেপো বা টেনসরফ্লো/ডক্স রেপোতে ব্রাউজ করুন, গিটহাব আপনাকে একটি পুল অনুরোধ তৈরি করতে অনুরোধ করবে।
  7. পুল অনুরোধ রক্ষণাবেক্ষণকারীদের দ্বারা পর্যালোচনা করা হয়.

অনুবাদ

tensorflow.org-এর জন্য অনুবাদ প্রদান করতে TensorFlow টিম সম্প্রদায় এবং বিক্রেতাদের সাথে কাজ করে। নোটবুক এবং অন্যান্য প্রযুক্তিগত বিষয়বস্তুর অনুবাদগুলি tensorflow/docs-l10n GitHub রেপোতে অবস্থিত। TensorFlow GitLocalize প্রকল্পের মাধ্যমে পুল অনুরোধ জমা দিন।

ইংরেজি ডক্স হল সত্যের উৎস এবং অনুবাদগুলি যতটা সম্ভব এই নির্দেশিকাগুলি অনুসরণ করা উচিত। এটি বলেছে, অনুবাদগুলি তারা যে সম্প্রদায়গুলিকে পরিবেশন করে তাদের জন্য লেখা হয়৷ যদি ইংরেজি পরিভাষা, বাক্যাংশ, শৈলী বা টোন অন্য ভাষায় অনুবাদ না করে, অনুগ্রহ করে পাঠকের জন্য উপযুক্ত একটি অনুবাদ ব্যবহার করুন।

ভাষা সমর্থন অনেকগুলি কারণের দ্বারা নির্ধারিত হয় যার মধ্যে রয়েছে—কিন্তু সীমাবদ্ধ নয়—সাইট মেট্রিক্স এবং চাহিদা, সম্প্রদায় সমর্থন, ইংরেজি দক্ষতা , দর্শকদের পছন্দ এবং অন্যান্য সূচক। যেহেতু প্রতিটি সমর্থিত ভাষা একটি খরচ বহন করে, অপরিবর্তিত ভাষাগুলি সরানো হয়। টেনসরফ্লো ব্লগ বা টুইটারে নতুন ভাষার জন্য সমর্থন ঘোষণা করা হবে।

আপনার পছন্দের ভাষা সমর্থিত না হলে, ওপেন সোর্স কন্ট্রিবিউটরদের জন্য কমিউনিটি ফোর্ক বজায় রাখার জন্য আপনাকে স্বাগতম। এগুলো tensorflow.org-এ প্রকাশিত হয় না।