דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- השפה של ג'וליה
- כתב טכני:
- mkg33
- שם הפרויקט:
- התיעוד המאוחד של למידת מכונה מדעית
- אורך הפרויקט:
- תקופה ארוכה (5 חודשים)
תיאור הפרויקט
אני רוצה לפעול לאיחוד של ארגון SciML כי יש הרבה מקום לשיפור בתחום הזה, וללא ספק שהשלמת הפרויקט תספק למתכנתים ג'וליה יתרונות מיידיים, הן למתכנתים של ג'וליה והן לתורמים/תחזוקה פעילים של SciML. החבילות שמפוזרות בכל SciML מציעות כלים שימושיים מאוד, אבל תמיד קיימת סכנה שלא ישימו לב אליהן (במיוחד למשתמשים חדשים) רק כי המשתמש לא הצליח לגלות את החבילה ולהחיל אותה על הבעיה הנוכחית.
זה די מתסכל, כי המטרה העיקרית של החבילות היא להגיע לקהל רחב של מתכנתים (גם מתחילים וגם מומחים). כדי להימנע מהמצב שמתואר למעלה, אני מציע לערוך באופן יסודי את 'הדף הראשי' של התיעוד של SciML וליצור מעין מרכז למשתמשים כדי לעיין בחבילות קשורות ולחקור את הסביבה העסקית הצומחת. הוא יכול גם לשמש כנקודת התייחסות חשובה למשתמשים מנוסים ולאפשר להם לעבוד בצורה יעילה יותר.
קודם כול, צריך לתקן את המסמכים הקיימים של כל החבילות הנפרדות בנוגע לבעיות הסגנוניות הבסיסיות ביותר (למשל: איות, פיסוק, דקדוק וכו'). כדי להבטיח עקביות סגנונית, ל-SciML נדרש מדריך סגנון קונקרטי (חיוני לעריכת שינויים רטרוספקטיביים ולשימוש עתידי). אם מתחילים מהתחלה, זה בזבוז זמן. במקום זאת, הוא צריך להתבסס על המוסכמות הקיימות של יוליה ולכלול שלמים חדשים עבור בעיות ספציפיות ל-SciML.
לאחר שאסיים את מדריך הסגנון, בכוונתי לתקן את התיעוד הנוכחי בשלב השני של הפרויקט. כך המסמכים ייראו מקצועיים ויציבים יותר. כבר יצרתי כמה בקשות משיכה שממחישות את הגישה שלי למשימה הזו. בשלב הזה גם אני מתכוון לפתח (ולהטמיע) מערכת יעילה של ציטוטים. המשימה הראשונה ביותר תהיה לעדכן את דף הציטוטים המיושן.
השלב השלישי, שיהיה אולי החשוב ביותר, יכלול תכנון של מפת הדרכים של SciML, שתדגיש את כוח האינטראקציה בין החבילות המפוזרות. ככל שהלכידות בין שתי החבילות חזקה יותר (ביחס לבעיה או לקוד עצמו), כך הן יופיעו קרוב יותר ברשימה 'ראה גם'. אני מציע שני מפתחות של המלצות: אחד לדמיון בין קודים ואחד לדמיון בעיות. כך המשתמשים יוכלו לזהות חבילות אחרות שעשויות להיות שימושיות במהירות רבה יותר מאשר על ידי דפדוף ממושך במאגרים ובתיעוד שלהם. במקום לפרט את כל החיבורים האפשריים בין החבילות, אני רוצה להתמקד בחבילות הגדולות יותר ולנסות להציג את הקישורים שלהן עם חבילות קטנות יותר (השיטה הזו תיושם גם לעדכון מדריכים שבהם יש להדגיש את הקשר לחבילה אחרת). הגישה הזו מבטיחה שהרשימות של 'ראה גם' יהיו אינפורמטיביות בלי לכלול ספירות מקיפות של שילובי החבילות.