টেনসরফ্লো ডকুমেন্টেশন অবদানগুলিকে স্বাগত জানায় - আপনি যদি ডকুমেন্টেশনগুলি উন্নত করেন তবে আপনি টেনসরফ্লো লাইব্রেরি নিজেই উন্নত করেন। টেনসরফ্লো.অর্গ.এর ডকুমেন্টেশন নিম্নলিখিত বিভাগগুলির মধ্যে পড়ে:
- এপিআই রেফারেন্স - টেনসরফ্লো উত্স কোডে ডায়িস্ট্রিংগুলি থেকে এপিআই রেফারেন্স ডক্স তৈরি করা হয়।
- বর্ণনামূলক ডকুমেন্টেশন - এটি টিউটোরিয়াল , গাইড এবং অন্যান্য লেখাগুলি যা টেনসরফ্লো কোডের অংশ নয়। এই ডকুমেন্টেশনটি টেনসরফ্লো / ডক্স গিটহাব সংগ্রহস্থলে রয়েছে।
- সম্প্রদায়ের অনুবাদ - এগুলি সম্প্রদায় দ্বারা অনুবাদকৃত গাইড এবং টিউটোরিয়াল। সমস্ত সম্প্রদায়ের অনুবাদ টেনসরফ্লো / ডক্স রেপোতে লাইভ।
কিছু টেনসরফ্লো প্রকল্পগুলি ডকুমেন্টেশন সোর্স ফাইলগুলিকে কোডের কাছে একটি পৃথক ভান্ডারে সাধারণত docs/
ডিরেক্টরিতে রাখে। প্রকল্পের CONTRIBUTING.md
ফাইলটি দেখুন বা অবদান রাখতে CONTRIBUTING.md
যোগাযোগ করুন।
টেনসরফ্লো ডক্স সম্প্রদায়ে অংশ নিতে:
- টেনসরফ্লো / ডক্স গিটহাবের সংগ্রহশালা দেখুন।
- Docs@tensorflow.org এ সাবস্ক্রাইব করুন।
এপিআই রেফারেন্স
রেফারেন্স ডকুমেন্টেশন আপডেট করার জন্য, উত্স ফাইলটি সন্ধান করুন এবং প্রতীকটির ডাস্ট্রিং সম্পাদনা করুন। টেনসরফ্লো.অর্গ-এ অনেকগুলি এআইপিআই রেফারেন্স পৃষ্ঠাগুলিতে উত্স ফাইলটির একটি লিঙ্ক অন্তর্ভুক্ত রয়েছে যেখানে প্রতীকটি সংজ্ঞায়িত করা হয়েছে। Docstrings সমর্থন Markdown এবং যেতে পারে (প্রায়) কোন ব্যবহার পূর্বরূপ দেখা Markdown পূর্বরূপদর্শন ।
রেফারেন্স ডকুমেন্টেশন মানের জন্য এবং কীভাবে ডক স্প্রিন্ট এবং সম্প্রদায়ের সাথে জড়িত থাকতে পারে, টেনসরফ্লো 2 এপিআই ডক্স পরামর্শ দেখুন ।
সংস্করণ এবং শাখা
সাইটের এপিআই রেফারেন্স সংস্করণটি সর্বশেষতম স্থিতিশীল বাইনারি-এর কাছে ডিফল্ট pip install tensorflow
সহ ইনস্টল হওয়া প্যাকেজের সাথে pip install tensorflow
।
ডিফল্ট টেনসরফ্লো প্যাকেজটি মূল টেনসরফ্লো / টেনসরফ্লো রেপোতে স্থিতিশীল শাখা rX.x
থেকে তৈরি করা হয়। রেফারেন্স ডকুমেন্টেশন পাইথন , সি ++ , এবং জাভা জন্য উত্স কোড কোড মন্তব্য এবং ডকাস্ট্রিং থেকে উত্পন্ন।
টেনসরফ্লো ডকুমেন্টেশনের পূর্ববর্তী সংস্করণগুলি টেনসরফ্লো ডক্স সংগ্রহশালায় rX.x শাখা হিসাবে উপলব্ধ। একটি নতুন সংস্করণ প্রকাশিত হলে এই শাখাগুলি যুক্ত করা হয়।
API ডক্স তৈরি করুন
পাইথন রেফারেন্স
tensorflow_docs
প্যাকেজে পাইথন এপিআই রেফারেন্স ডক্সের জেনারেটর অন্তর্ভুক্ত রয়েছে। স্থাপন করা:
pip install git+https://github.com/tensorflow/docs
tensorflow/tools/docs/generate2.py
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
বর্ণনামূলক ডকুমেন্টেশন
টেনসরফ্লো গাইড এবং টিউটোরিয়ালগুলি মার্কডাউন ফাইল এবং ইন্টারেক্টিভ জুপিটার নোটবুক হিসাবে রচিত। নোটবুকগুলি গুগল কোলাবোরেটরি ব্যবহার করে আপনার ব্রাউজারে চালানো যেতে পারে। টেনসরফ্লো.অর্গ- এর ন্যারেটিভ ডকগুলি টেনসরফ্লো / ডক্স master
শাখা থেকে নির্মিত। পুরানো সংস্করণগুলি গিটহাবে rX.x
রিলিজ শাখায় পাওয়া যায়।
সাধারণ পরিবর্তন
মার্কডাউন ফাইলগুলিতে সরাসরি ডকুমেন্টেশন আপডেট করার সহজ উপায় হ'ল গিটহাবের ওয়েব-ভিত্তিক ফাইল সম্পাদক ব্যবহার করা । টেনসরফ্লো / ডক্স রিপোজিটরিটি ব্রাউজ করুন যা প্রায় টেনসরফ্রো.আরএল ইউআরএল স্ট্রাকচারের সাথে মিলে যায় এমন মার্কাউন ডাউন সন্ধান করতে। ফাইল ভিউয়ের উপরের ডানদিকে কোণায় পেন্সিল আইকনটি ক্লিক করুন ফাইল সম্পাদক খুলতে। ফাইলটি সম্পাদনা করুন এবং তারপরে একটি নতুন টানার অনুরোধ জমা দিন।
স্থানীয় গিট রেপো সেট আপ করুন
একাধিক ফাইল সম্পাদনা বা আরও জটিল আপডেটের জন্য, একটি টান অনুরোধ তৈরি করতে স্থানীয় গিট ওয়ার্কফ্লো ব্যবহার করা ভাল।
নীচের গিট স্টেপগুলি প্রথমবার যখন আপনি কোনও স্থানীয় প্রকল্প স্থাপন করবেন তখনই প্রয়োজনীয়।
টেনসরফ্লো / ডক্স রেপো কাঁটাচামচ করুন
টেনসরফ্লো / ডক্স গিটহাব পৃষ্ঠায়, কাঁটাচামড়া বোতামটি ক্লিক করুন আপনার গিটহাব অ্যাকাউন্টের অধীনে আপনার নিজস্ব রেপো কপি তৈরি করতে। একবার কাঁটাচামচ করা হয়ে গেলে, আপনার রেপো কপিটি আপস্ট্রিম টেনসরফ্লো রেপোর সাথে আপ টু ডেট রাখার জন্য আপনি দায়বদ্ধ।
আপনার রেপো ক্লোন করুন
আপনার স্থানীয় মেশিনে আপনার দূরবর্তী username / ডক্স রেপোর একটি অনুলিপি ডাউনলোড করুন। এটি সেই ওয়ার্কিং ডিরেক্টরি যেখানে আপনি পরিবর্তন করবেন:
git clone git@github.com:username/docs
cd ./docs
আপ-টু-ডেট রাখার জন্য একটি প্রবাহ রেপো যুক্ত করুন (alচ্ছিক)
আপনার স্থানীয় সংগ্রহস্থলটিকে tensorflow/docs
সাথে সুসংগত রাখতে, সর্বশেষ পরিবর্তনগুলি ডাউনলোড করতে একটি প্রবাহের দূরবর্তী যুক্ত করুন।
একটি রিমোট যুক্ত করুন:
git remote add upstream git@github.com:tensorflow/docs.git
# View remote reposgit 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. পরিবর্তন করুন
আপনার প্রিয় সম্পাদনায় ফাইলগুলি সম্পাদনা করুন এবং অনুগ্রহ করে টেনসরফ্লো ডকুমেন্টেশন স্টাইল গাইডটি অনুসরণ করুন।
আপনার ফাইল পরিবর্তন প্রতিশ্রুতিবদ্ধ:
# View changesgit status
# See which files have changedgit diff
# See changes within filesgit add path/to/file.md
git commit -m "Your meaningful commit message for the change."
প্রয়োজনীয় হিসাবে আরও কমিট যোগ করুন।
3. একটি টান অনুরোধ তৈরি করুন
আপনার স্থানীয় শাখাটি আপনার দূরবর্তী গিটহাব রেপোতে (github.com/ username / ডক্স) আপলোড করুন:
git push
পুশ সম্পূর্ণ হওয়ার পরে, একটি বার্তা স্বয়ংক্রিয়ভাবে আপস্ট্রিম রেপোতে একটি পুল অনুরোধ জমা দেওয়ার জন্য একটি URL প্রদর্শন করতে পারে। যদি তা না হয় তবে টেনসরফ্লো / ডক্স রেপো বা আপনার নিজস্ব রেপোতে যান এবং গিটহাব আপনাকে একটি অনুরোধ তৈরি করতে অনুরোধ করবে।
4. পর্যালোচনা
রক্ষণাবেক্ষণকারী এবং অন্যান্য অবদানকারীরা আপনার টানার অনুরোধটি পর্যালোচনা করবে। দয়া করে আলোচনায় অংশ নিন এবং অনুরোধিত পরিবর্তনগুলি করুন। আপনার টানার অনুরোধ অনুমোদিত হয়ে গেলে, এটি আপস্ট্রিম টেনসরফ্লো ডক্স রেপোতে একীভূত হবে।
গিটহাব রেপো থেকে টেনসরফ্লো.অর্গ আপডেট করার জন্য একটি পৃথক প্রকাশের পদক্ষেপ রয়েছে। সাধারণত, পরিবর্তনগুলি একসাথে মিশ্রিত হয় এবং সাইটটি নিয়মিত ক্যাডেন্সে আপডেট হয়।
ইন্টারেক্টিভ নোটবুক
যদিও গিটহাবের ওয়েব-ভিত্তিক ফাইল সম্পাদকের সাথে নোটবুক জেএসএন ফাইল সম্পাদনা করা সম্ভব, ততক্ষণ এটির প্রস্তাব দেওয়া হয়নি যেহেতু ত্রুটিযুক্ত জেএসওএন ফাইলটিকে দূষিত করতে পারে। টানার অনুরোধ জমা দেওয়ার আগে নোটবুকটি পরীক্ষা করে নেওয়ার বিষয়টি নিশ্চিত করুন।
গুগল কোলাবোটারি একটি হোস্ট করা নোটবুক পরিবেশ যা এটি সম্পাদনা করা এবং চালানো — নোটবুক ডকুমেন্টেশনকে সহজ করে তোলে। গিটহাবের নোটবুকগুলি কুলাব ইউআরএল পাস করার মাধ্যমে গুগল কোলাবে লোড করা হয়, উদাহরণস্বরূপ, এখানে গিটহাবের নোটবুকটি রয়েছে: https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras / শ্রেণিবদ্ধকরণ.আইপিনব
এই ইউআরএলে গুগল কোলাবে লোড করা যায়: https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classization.ipynb
কোলাব ক্রোম এক্সটেনশনে একটি ওপেন রয়েছে যা গিটহাবে একটি নোটবুক ব্রাউজ করার সময় এই URL টি প্রতিস্থাপন সম্পাদন করে। আপনার রেপো ফর্কটিতে একটি নোটবুক খোলার সময় এটি দরকারী, কারণ শীর্ষ বোতামগুলি সর্বদা টেনসরফ্লো ডক্স master
শাখায় লিঙ্ক করে।
নোটবুক বিন্যাস
একটি নোটবুক বিন্যাসকরণ সরঞ্জামটি বৃহত্তর নোটবুকের উত্সকে পৃথক করে এবং পর্যালোচনা করা সহজ করে তোলে। যেহেতু নোটবুক রাইটিং পরিবেশগুলি ফাইল আউটপুট, ইনডেন্টেশন, মেটাডেটা এবং অন্যান্য নির্দিষ্ট না হওয়া ক্ষেত্রের সাথে পৃথক; nbfmt
ডক্স কোলাব ওয়ার্কফ্লোয়ের জন্য অগ্রাধিকার সহ nbfmt
ডিফল্ট ব্যবহার করে। একটি নোটবুক ফর্ম্যাট করতে, 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
স্পষ্টভাবে আউটপুট কোষ মুছে ফেলার জন্য বিকল্প।
একটি নতুন নোটবুক তৈরি করতে, টেনসরফ্লো ডক্স নোটবুক টেম্পলেটটি অনুলিপি করুন এবং সম্পাদনা করুন।
কলাবে সম্পাদনা করুন
গুগল কোলাব পরিবেশের মধ্যে, পাঠ্য এবং কোড ব্লক সম্পাদনা করতে সেলগুলিতে ডাবল ক্লিক করুন। পাঠ্য কক্ষগুলি মার্কডাউন ব্যবহার করে এবং টেনসরফ্লো ডক্স শৈলী গাইড অনুসরণ করা উচিত।
ফাইল> ডাউনলোড। পিনব দিয়ে কোলাব থেকে নোটবুক ফাইলগুলি ডাউনলোড করুন । আপনার স্থানীয় গিট রেপোতে এই ফাইলটি প্রতিশ্রুতিবদ্ধ করুন এবং একটি টানার অনুরোধ প্রেরণ করুন।
একটি নতুন নোটবুক তৈরি করতে, টেনসরফ্লো নোটবুক টেম্পলেটটি অনুলিপি করুন এবং সম্পাদনা করুন।
কোলাব-গিটহাব কর্মপ্রবাহ
একটি নোটবুক ফাইল ডাউনলোড করার এবং স্থানীয় গিট ওয়ার্কফ্লো ব্যবহার করার পরিবর্তে, আপনি সরাসরি Google কোলাব থেকে আপনার কাঁটাচামচ করা গিটহাব রেপো সম্পাদনা ও আপডেট করতে পারেন:
- আপনার কাঁটাযুক্ত username / ডক্স রেপোতে, একটি নতুন শাখা তৈরি করতে গিটহাব ওয়েব ইউআই ব্যবহার করুন।
- সম্পাদনা করার জন্য নোটবুকের ফাইলটিতে নেভিগেট করুন।
- গুগল কলাবতে নোটবুকটি খুলুন: ইউআরএল সোয়াপ ব্যবহার করুন বা কলাব ক্রোম এক্সটেনশনে খুলুন ।
- কলাবে নোটবুকটি সম্পাদনা করুন।
- কোলাব থেকে আপনার রেপোতে পরিবর্তনগুলি ফাইল দিয়ে> গিটহাবের একটি অনুলিপি সংরক্ষণ করুন ... সংরক্ষণ ডায়ালগটি উপযুক্ত রেপো এবং শাখার সাথে লিঙ্ক করা উচিত। একটি অর্থপূর্ণ প্রতিশ্রুতি বার্তা যুক্ত করুন।
- সংরক্ষণের পরে, আপনার রেপো বা টেনসরফ্লো / ডক্স রেপিতে ব্রাউজ করুন, গিটহাব আপনাকে একটি টান অনুরোধ তৈরি করতে অনুরোধ করবে।
- পুল অনুরোধ রক্ষণাবেক্ষণকারীদের দ্বারা পর্যালোচনা করা হয়।
অনুবাদ
টেনসরফ্লো টিম সম্প্রদায় এবং বিক্রেতাদের সাথে কাজ করে টেনসরফ্লো.অর্গ.এর অনুবাদ সরবরাহ করে। নোটবুক এবং অন্যান্য প্রযুক্তিগত সামগ্রীর অনুবাদগুলি টেনসরফ্লো / ডক্স-l10n গিটহাব রেপোতে অবস্থিত। টেনসরফ্লো গিটলোক্যালাইজ প্রকল্পের মাধ্যমে টান অনুরোধ জমা দিন।
ইংলিশ ডক্স সত্যের উত্স এবং অনুবাদগুলিতে এই গাইডগুলি যথাসম্ভব কাছাকাছি অনুসরণ করা উচিত। এটি বলেছিল যে অনুবাদগুলি সেগুলির সম্প্রদায়ের জন্য রচিত হয়। যদি ইংরেজী পরিভাষা, শব্দচয়ন, স্টাইল বা স্বর অন্য ভাষায় অনুবাদ না করে তবে দয়া করে পাঠকের জন্য উপযুক্ত একটি অনুবাদ ব্যবহার করুন।
ভাষা সমর্থন met তবে সাইট মেট্রিক্স এবং চাহিদা, সম্প্রদায় সমর্থন, ইংরেজি দক্ষতা , শ্রোতাদের পছন্দ এবং অন্যান্য সূচক সহ বেশ কয়েকটি কারণ দ্বারা নির্ধারিত হয়। যেহেতু প্রতিটি সমর্থিত ভাষার জন্য একটি অর্থ ব্যয় হয়, তাই অনিচ্ছাকৃত ভাষাগুলি সরানো হয়। টেনসরফ্লো ব্লগ বা টুইটারে নতুন ভাষার জন্য সমর্থন ঘোষণা করা হবে।
যদি আপনার পছন্দের ভাষাটি সমর্থন না করে তবে আপনি ওপেন সোর্স অবদানকারীদের জন্য একটি সম্প্রদায় কাঁটাচামড়া বজায় রাখতে স্বাগত। এগুলি টেনসরফ্রোল.অর্গ-এ প্রকাশিত হয় না।