این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- زبان جولیا
- نویسنده فنی:
- mkg33
- نام پروژه:
- مستندات یکپارچه یادگیری ماشین علمی
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
من مایلم روی یکپارچه سازی سازمان SciML کار کنم زیرا در این زمینه فضای زیادی برای پیشرفت وجود دارد و بدون شک تکمیل این پروژه مزایای فوری هم برای برنامه نویسان جولیا و هم برای مشارکت کنندگان/نگهبانان فعال SciML خواهد داشت. بسته‌های پراکنده در سرتاسر SciML ابزارهای واقعاً مفیدی را ارائه می‌دهند، اما همیشه این خطر وجود دارد که ممکن است مورد توجه قرار نگیرند (مخصوصاً توسط تازه واردان) فقط به این دلیل که کاربر قادر به کشف بسته و اعمال آن در مشکل موجود نیست.
با توجه به اینکه هدف اولیه بسته ها دستیابی به مخاطبان گسترده ای از برنامه نویسان (مبتدیان و متخصصان) است، این امر نسبتاً ناامید کننده است. به منظور اجتناب از وضعیتی که در بالا توضیح داده شد، پیشنهاد می‌کنم «صفحه اول» مستندات SciML را به‌طور کامل بازبینی کنیم و نوعی مرکز ایجاد کنیم که کاربران بتوانند از آن برای مرور بسته‌های مرتبط و کشف اکوسیستم در حال رشد استفاده کنند. همچنین می تواند به عنوان یک نقطه مرجع ارزشمند برای کاربران با تجربه تر باشد و به آنها اجازه دهد کارآمدتر کار کنند.
اول از همه، اسناد موجود در تمام بسته‌های فردی با توجه به اساسی‌ترین مسائل سبک (مانند املا، نقطه‌گذاری، دستور زبان و غیره) نیاز به بازبینی دارد. برای اطمینان از سازگاری سبک، SciML نیاز به یک راهنمای سبک مشخص (برای ایجاد تغییرات گذشته‌نگر و برای مراجعات بعدی ضروری است). شروع از صفر وقت تلف کردن خواهد بود. در عوض، باید بر اساس کنوانسیون های جولیا موجود باشد و شامل کلیت های جدید برای مسائل خاص SciML باشد.
پس از تکمیل راهنمای سبک، قصد دارم در مرحله دوم پروژه، مستندات فعلی را اصلاح کنم. این باعث می شود مستندات حرفه ای تر و پایدارتر به نظر برسند. من قبلاً چندین درخواست کشش ایجاد کرده ام که رویکرد من به این کار را نشان می دهد. در این مرحله، من همچنین قصد دارم یک سیستم استنادی کارآمد را طراحی (و پیاده سازی) کنم. اولین کار به روز رسانی صفحه نقل قول های قدیمی خواهد بود.
مرحله سوم، مسلماً مهم ترین، شامل طراحی نقشه راه SciML است که بر تعامل بین بسته های پراکنده تأکید می کند. هر چه انسجام بین دو بسته (با توجه به مشکل یا خود کد) قوی‌تر باشد، باید در لیست «همچنین ببینید» ظاهر شوند. من پیشنهاد می کنم دو کلید توصیه ایجاد کنید: یکی برای شباهت کد و دیگری برای شباهت مشکل. به این ترتیب، کاربران می‌توانند بسته‌های بالقوه مفید دیگر را بسیار سریع‌تر از جستجوی پر زحمت در مخازن و اسناد مربوطه شناسایی کنند. به جای فهرست کردن تمام اتصالات ممکن در بین بسته ها، ترجیح می دهم روی موارد بزرگتر تمرکز کنم و سعی کنم پیوندهای آنها را با بسته های کوچکتر ارائه کنم (این روش به آموزش های به روز رسانی نیز تعمیم داده می شود که در آن ارتباط با بسته دیگری باید ذکر شود). این رویکرد تضمین می‌کند که لیست‌های «همچنین ببینید» بدون شمارش کامل ترکیب‌های بسته، آموزنده خواهند بود.