कैपस्टोन प्रोजेक्ट्समध्यमपाठ 3357 मिनट का पाठ

इसे शेयर करें और फ़ीडबैक पाएं

एक छोटा डेमो, ईमानदार सीमाओं (limits) के साथ एक स्पष्ट README, और एक सही लाइसेंस आपके प्रोजेक्ट को ऐसा बना देते हैं जिससे दूसरे सीख सकें, और जिसे आप दूसरों को दिखा सकें।

✦ ट्यूटर से पूछें🧪 लैब · 25 min📝 पाठ का टेस्ट
पाठ वीडियो में

60 सेकंड में

इसे शेयर करें और फ़ीडबैक पाएं

एक छोटा डेमो, ईमानदार सीमाओं (limits) के साथ एक स्पष्ट README, और एक सही लाइसेंस आपके प्रोजेक्ट को ऐसा बना देते हैं जिससे दूसरे सीख सकें, और जिसे आप दूसरों को दिखा सकें।

1/4
आसान शब्दों में
जब आप साइंस फेयर का कोई मॉडल पूरा करते हैं, तो आप उसके पास एक कार्ड लगाते हैं: यह क्या करता है, कैसे काम करता है, और यह अभी क्या नहीं कर सकता। जो लोग वह कार्ड पढ़ते हैं, वे एक मिनट में आपके काम को समझ जाते हैं, और उनमें से कुछ आपको बेहतरीन सुझाव भी देते हैं। अपने प्रोजेक्ट को शेयर करना वही कार्ड बनाने जैसा है।
जो प्रोजेक्ट सिर्फ आपके लैपटॉप पर रहता है, उससे किसी और की मदद नहीं होती। इसे अच्छी तरह शेयर करने का मतलब तीन चीज़ें हैं: एक छोटा demo जो इसे काम करते हुए दिखाए, एक README जो इसे ईमानदारी से समझाए, और दूसरों द्वारा इसे इस्तेमाल करने की स्पष्ट permissions। इसके बाद आप फ़ीडबैक मांगते हैं और सुधार करते हैं।

दो मिनट का डेमो

  1. 1

    समस्या (The problem)

    एक वाक्य: यह समस्या किसे है और यह क्यों मायने रखती है। एक असली उदाहरण दिखाएं।
  2. 2

    टूल काम करते हुए (The tool in action)

    अपने पायलट टेस्ट से एक असली काम (task) शुरू से अंत तक दिखाएं।
  3. 3

    एक सच्ची विफलता (An honest failure)

    एक ऐसा सवाल दिखाएं जिसका यह गलत जवाब देता है या जिसके लिए "not found" कहता है, और समझाएं कि ऐसा क्यों हुआ।
  4. 4

    नतीजा (The result)

    आपकी सफलता का पैमाना और पायलट टेस्ट से आपने क्या सीखा, असली आंकड़ों (counts) के साथ।
  5. 5

    आगे क्या (What next)

    एक या दो चीज़ें जिन्हें आप बेहतर बनाना चाहेंगे।
जानबूझकर कोई कमी या विफलता दिखाना भरोसा पैदा करता है। इससे लोगों को पता चलता है कि आपने ईमानदारी से टेस्ट किया है और आप इसकी सीमाओं को जानते हैं।

README में क्या-क्या होना चाहिए

सेक्शनक्या लिखना है
यह क्या करता हैएक या दो वाक्य, आसान शब्दों में।
यह किसके लिए हैआपकी योजना के अनुसार यूज़र्स, और यह किस भाषा या किन भाषाओं को सपोर्ट करता है।
इसे कैसे चलाएंइसे इंस्टॉल करने और चलाने के स्टेप्स। बताएं कि मॉडल कॉल कहां जाती है और यह भी कि keys को प्राइवेट रखना ज़रूरी है।
सीमाएं (Limits)यह क्या नहीं कर सकता, ज्ञात गलतियां, और लोगों को कब टूल के बजाय किसी इंसान से पूछना चाहिए।
डेटा और प्राइवेसीकंटेंट कहां से आया, आपके पास परमिशन थी, और यह क्या स्टोर करता है या क्या स्टोर नहीं करता।
नतीजे (Results)आपके टेस्ट सेट और पायलट के आंकड़े, संख्या और आपके मापने के तरीके के साथ।
लाइसेंसकोड किस लाइसेंस का इस्तेमाल करता है, और कंटेंट का मालिक कौन है।

लाइसेंस के बारे में आम बातें

अगर आप बिना किसी लाइसेंस के सार्वजनिक रूप से कोड शेयर करते हैं, तो हो सकता है कि दूसरों के पास इसे इस्तेमाल करने की साफ़ परमिशन न हो। लाइसेंस लोगों को बताता है कि वे क्या कर सकते हैं। कुछ मुख्य प्रकार:
  • Permissive licences (उदाहरण के लिए MIT या Apache 2.0) दूसरों को आपके कोड का इस्तेमाल करने, उसे बदलने और शेयर करने की अनुमति देते हैं, यहाँ तक कि अपने खुद के प्रोडक्ट्स में भी, बशर्ते वे ओरिजिनल नोटिस को बनाए रखें।
  • Copyleft licences (उदाहरण के लिए GNU GPL) दूसरों को आपके कोड का इस्तेमाल करने और उसे बदलने की अनुमति देते हैं, लेकिन अगर वे अपने बदले हुए वर्शन को बांटते हैं, तो उन्हें उसे उसी लाइसेंस के तहत शेयर करना होगा।
  • Content licences जैसे कि Creative Commons, अक्सर कोड के बजाय टेक्स्ट, इमेज और डेटासेट के लिए इस्तेमाल किए जाते हैं।
नोट
आपके कोड का लाइसेंस उस कंटेंट पर लागू नहीं होता जिसके मालिक आप नहीं हैं। किसी स्कूल के नोटिस या किसी दुकान की रेट लिस्ट उनकी अपनी होती है: उन्हें पब्लिश करने से पहले पूछें, या सिर्फ काल्पनिक सैंपल कंटेंट ही पब्लिश करें। जिन मॉडल्स और डेटासेट का आप इस्तेमाल करते हैं, उनके अपने लाइसेंस और नियम होते हैं, जिनका आपको पालन करना होगा। यह सामान्य जानकारी है, कोई कानूनी सलाह नहीं; किसी भी ज़रूरी बात के लिए अपने संस्थान या किसी योग्य व्यक्ति से पूछें।

काम का फ़ीडबैक पाना

  • साफ़ और सटीक सवाल पूछें: "क्या फीस के बारे में जवाब साफ़ था?" पूछना "क्या आपको यह पसंद आया?" पूछने से बेहतर काम करता है।
  • पहले अपने पायलट यूज़र्स के साथ शेयर करें, फिर क्लासमेट्स के साथ, और फिर बड़े ग्रुप के साथ।
  • फ़ीडबैक की एक आसान लिस्ट बनाएं, और मार्क करें कि आपने क्या ठीक कर दिया, आप बाद में क्या ठीक करेंगे, और आपने क्या न करने का फैसला किया।
  • लोगों का शुक्रिया अदा करें। README में अपनी टीम के साथियों, टेस्टर्स (बिना निजी जानकारी के) और कंटेंट के मालिकों को क्रेडिट दें।

आपका पोर्टफोलियो और आपका सर्टिफिकेट

README, एक छोटे डेमो और ईमानदार नतीजों के साथ पूरा किया गया एक कैपस्टोन प्रोजेक्ट इस बात का पक्का सबूत है कि आप क्या कर सकते हैं। यह अक्सर कोर्सेस की लिस्ट से कहीं ज़्यादा असरदार होता है। एक छोटा विवरण लिखकर रखें: समस्या क्या थी, आपने क्या बनाया, आपने क्या मापा, और आपने क्या सीखा।
OmniLingo पर, जब आप किसी ट्रैक का हर पाठ पूरा कर लेते हैं, तो आपको अपने-आप उस ट्रैक का सर्टिफिकेट मिल जाता है। हर सर्टिफिकेट में एक लिंक होता है जिससे कोई भी जांच सकता है कि वह असली है। अपने प्रोजेक्ट लिंक के साथ सर्टिफिकेट का लिंक भी शेयर करें, ताकि लोग यह देख सकें कि आपने क्या सीखा और क्या बनाया।
सावधान रहें
पब्लिश करने से पहले चेक करें: कोड में कोई API keys या पासवर्ड न हों, उदाहरणों या लॉग्स में कोई निजी डेटा न हो, ऐसा कोई कंटेंट न हो जिसे शेयर करने की आपको अनुमति नहीं है, और ऐसे कोई दावे न हों जिन्हें आप साबित न कर सकें। कोड पुश करने से पहले अपनी फाइलों में "key", "token" और "password" जैसे शब्द खोजें।
यह करके देखें। किसी ऐसे व्यक्ति से, जिसने आपका प्रोजेक्ट कभी नहीं देखा, सिर्फ दो मिनट के लिए आपकी README पढ़ने को कहें। फिर उनसे पूछें कि यह क्या करता है और क्या नहीं कर सकता। अगर वे नहीं बता पाते हैं, तो अपनी README को बेहतर बनाएं।

और देखें और पढ़ें

Choose an open source licensechoosealicense.com · readingLicenses approved by the Open Source Initiativeopensource.org · reading

लैब

आपके प्रोजेक्ट के लिए एक README जिसमें सभी मुख्य सेक्शन शामिल हों, जिनमें ईमानदार सीमाएं (limits) और एक लाइसेंस भी हो।

~25 min

समस्या

  1. शुरुआती कोड (starter) चलाएं। यह README को अलग-अलग सेक्शन में बांटता है और दिखाता है कि कौन से सेक्शन अभी TODO हैं।
  2. अपने कैपस्टोन के लिए (या इस ट्रैक के लाइब्रेरी बॉट के लिए) अपनी खुद की README लिखें। ये छह हेडिंग रखें: What it does, Who it is for, How to run, Limits, Data and privacy, Licence.
  3. हर हेडिंग के नीचे कम से कम दस शब्द लिखें। Limits के तहत, कम से कम दो बुलेट पॉइंट दें जो - से शुरू होते हों।
  4. Licence के तहत, अपने चुने हुए लाइसेंस का नाम लिखें, या लिखें कि आपने अभी तक कोई लाइसेंस क्यों नहीं चुना है।
  5. पक्का करें कि कहीं भी कोई keys, पासवर्ड या निजी जानकारी न दिखे।

प्रैक्टिस लैब

कोड में बदलाव करें और इसे रन करें। Python आपके ब्राउज़र में चलता है — हमारे सर्वर पर कुछ नहीं भेजा जाता।

आउटपुट

कोई आउटपुट नहीं। वैल्यूज़ देखने के लिए print(...) जोड़ें।

आपका काम तब पूरा होगा जब

कठिन सवाल

उत्तर देखने से पहले ख़ुद जवाब देने की कोशिश करें। अगर आप इनके जवाब दे सकते हैं, तो आप पाठ समझ गए हैं।

Q1आपकी README कहती है "हमारा बॉट लाइब्रेरी के सभी सवालों के सही जवाब देता है।" एक टेस्टर को इसमें दो गलतियां मिलीं। आपको इसे कैसे दोबारा लिखना चाहिए?दिखाएं

इस दावे की जगह वह लिखें जो आपने असल में मापा था: "20 सवालों के हमारे टेस्ट सेट में, इसने सही सोर्स के साथ 17 के सही जवाब दिए और उन 3 सवालों में से 2 के लिए not found कहा जिनका इसके पास कोई कंटेंट नहीं था। यह अभी भी गलत हो सकता है; सोर्स लिंक चेक करें या डेस्क पर पूछें।" सटीक और मापे गए दावे भरोसा बनाते हैं; बिल्कुल पक्के दावे पहली ही बार में भरोसा तोड़ देते हैं जब टूल फेल होता है।

Q2आपने बॉट बनाने के लिए एक स्कूल के नोटिसों का इस्तेमाल किया, और अब आप इसे open-source करना चाहते हैं। आप असल में क्या पब्लिश करेंगे?दिखाएं

अपने कोड को अपने चुने हुए licence के तहत पब्लिश करें, और नोटिसों को केवल तभी पब्लिश करें जब स्कूल इसकी अनुमति दे। नहीं तो, उसी फ़ॉर्मेट में बनावटी सैंपल कंटेंट का एक छोटा सा सेट शामिल करें, और README में समझाएं कि कोई इसमें अपना कंटेंट कैसे जोड़ सकता है। साथ ही, आपके द्वारा इस्तेमाल किए गए किसी भी मॉडल या डेटासेट की शर्तें भी जांचें, और पर्सनल डेटा वाली किसी भी keys या logs को हटा दें।

जारी रखने के लिए कृपया साइन इन करें।

अक्सर पूछे जाने वाले सवाल

क्या मुझे अपने प्रोजेक्ट को ओपन-सोर्स करना ही होगा?

नहीं। आप इसे प्राइवेट रख सकते हैं या सिर्फ एक डेमो शेयर कर सकते हैं। ओपन-सोर्स करने से दूसरों को सीखने में मदद मिलती है और आपका काम दिखता है, लेकिन सिर्फ वही पब्लिश करें जिसे शेयर करने की आपको अनुमति है, और निजी कंटेंट को पहले हटा दें।

मुझे कौन सा लाइसेंस चुनना चाहिए?

छात्रों के कई प्रोजेक्ट एक आम permissive licence का इस्तेमाल करते हैं ताकि दूसरे लोग कोड से सीख सकें और उसका दोबारा इस्तेमाल कर सकें। अगर आप चाहते हैं कि बदले हुए वर्शन भी ओपन रहें, तो copyleft licence आपके लिए सही हो सकता है। कोई आसान भाषा वाली गाइड पढ़ें, अपने संस्थान के नियम देखें, और अपने मेंटर से पूछें। किसी भी ज़रूरी मामले में संदेह होने पर, किसी योग्य व्यक्ति से सलाह लें।

अगर मेरे नतीजे अच्छे न हों तो क्या होगा?

उन्हें फिर भी ईमानदारी से शेयर करें। "हमारे बॉट ने 10 में से 6 सवालों के सही जवाब दिए; बाकी क्यों छूटे, इसका कारण यहाँ है" भी एक काम का नतीजा है। जो लोग आपके काम को पढ़ते हैं, वे बिल्कुल परफेक्ट आंकड़ों से ज़्यादा ईमानदारी और सीखने की साफ़ समझ को महत्व देते हैं।

मैं अपने खुद के पोर्टफोलियो में ग्रुप प्रोजेक्ट कैसे दिखाऊं?

पूरी टीम का नाम लिखें, और साफ़ तौर पर बताएं कि कौन सा हिस्सा आपने किया था। शेयर की गई रिपॉजिटरी या डेमो का लिंक दें। अपनी भूमिका को लेकर सटीक होना ईमानदार तरीका है और यह ज़्यादा असरदार लगता है।

पाठ का टेस्ट

5 सवाल। पास होने और इस पाठ को पूरा करने के लिए 3 सही होने चाहिए (60%)।

टेस्ट देने और अपनी प्रोग्रेस सेव करने के लिए साइन इन करें